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 all beneficiaries
GET
/
beneficiaries
curl --request GET \
--url https://api.notchpay.co/beneficiaries \
--header 'Authorization: <api-key>'
{
"code": 200,
"status": "OK",
"message": "Beneficiaries retrieved",
"totals": 15,
"last_page": 1,
"current_page": 1,
"selected": 15,
"items": [
{
"id": "ben_123456789",
"name": "John Doe",
"email": "john@example.com",
"phone": 237600000000,
"country": "CM",
"payment_method": "pm.ndzAfIh555VCPML1",
"created_at": "2023-01-01T12:00:00.000Z"
}
]
}
Authorizations
Query Parameters
Number of items per page
Page number
Search by name or email
Response
200
application/json
Successful response
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.notchpay.co/beneficiaries \
--header 'Authorization: <api-key>'
{
"code": 200,
"status": "OK",
"message": "Beneficiaries retrieved",
"totals": 15,
"last_page": 1,
"current_page": 1,
"selected": 15,
"items": [
{
"id": "ben_123456789",
"name": "John Doe",
"email": "john@example.com",
"phone": 237600000000,
"country": "CM",
"payment_method": "pm.ndzAfIh555VCPML1",
"created_at": "2023-01-01T12:00:00.000Z"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.