API Reference
List customer's payments
Introduction
Core Resources
Additional Resources
API Specification
- API Reference
- GETList all payments
- POSTInitialize a payment
- GETRetrieve a payment
- PUTProcess a payment
- POSTProcess a payment
- DELCancel a payment
- GETList all transfers
- POSTInitiate a transfer
- GETRetrieve a transfer
- GETList all beneficiaries
- POSTCreate a beneficiary
- GETRetrieve a beneficiary
- DELDelete a beneficiary
- GETList all customers
- POSTCreate a customer
- GETRetrieve a customer
- POSTUpdate a customer
- DELDelete a customer
- GETList customer's payment methods
- GETList customer's payments
- POSTBlock a customer
- POSTUnblock a customer
- GETList all webhooks
- POSTCreate a webhook
- GETRetrieve a webhook
- PUTUpdate a webhook
- DELDelete a webhook
- GETRetrieve account balance
- GETList all payment channels
- GETList all countries
- GETList all currencies
- GET
API Reference
List customer's payments
GET
/
customers
/
{id}
/
payments
curl --request GET \
--url https://api.notchpay.co/customers/{id}/payments \
--header 'Authorization: <api-key>'
{
"code": 200,
"status": "OK",
"message": "Customer payments retrieved",
"totals": 10,
"last_page": 1,
"current_page": 1,
"selected": 10,
"payments": [
{
"id": "pay_123456789",
"reference": "ref_123456789",
"amount": 5000,
"currency": "XAF",
"status": "complete",
"customer": "cus_123456789",
"created_at": "2023-01-01T12:00:00.000Z",
"completed_at": "2023-01-01T12:05:00.000Z",
"payment_method": "pm.ndzAfIh555VCPML1"
}
]
}
Authorizations
Path Parameters
Unique identifier of the customer
Response
200
application/json
Customer payments retrieved
The response is of type object
.
curl --request GET \
--url https://api.notchpay.co/customers/{id}/payments \
--header 'Authorization: <api-key>'
{
"code": 200,
"status": "OK",
"message": "Customer payments retrieved",
"totals": 10,
"last_page": 1,
"current_page": 1,
"selected": 10,
"payments": [
{
"id": "pay_123456789",
"reference": "ref_123456789",
"amount": 5000,
"currency": "XAF",
"status": "complete",
"customer": "cus_123456789",
"created_at": "2023-01-01T12:00:00.000Z",
"completed_at": "2023-01-01T12:05:00.000Z",
"payment_method": "pm.ndzAfIh555VCPML1"
}
]
}