List beneficiaries
curl -X GET "https://test-api.kashier.io/v2/parties?type=beneficiary"{ "body": { "customers": [ { "_id": "67ba0311bf4f31001203c6c2", "type": "beneficiary", "name": "Jhon Doe", "phoneNumber": "01555539512", "countryCode": "+20", "emailAddress": "", "customerId": "B-1740243729820", "merchantId": "MID-XXXXX-XXX", "transferMethod": "bank", "credentials": { "bank": { "recipientFullName": "Jhon Doe", "bank": "CIB", "accountNumber": "010001000" } }, "labels": [ "vip" ], "createdByUserId": "612cdca034b3a9001f38879d", "createdAt": "2025-02-22T17:02:10.098Z", "updatedAt": "2025-02-25T12:31:40.474Z" } ], "totalCustomers": 42, "limit": 20, "totalPages": 3, "page": 1, "pagingCounter": 1, "hasPrevPage": false, "hasNextPage": true, "prevPage": null, "nextPage": 2 }, "message": "success"}Retrieves your saved beneficiaries, paginated. type=beneficiary is required — the same route serves customers, and the parameter is what separates them.
Authorization
secretKey Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).
In: header
Query Parameters
Must be beneficiary.
Value in
- "beneficiary"
Search beneficiaries by name, phone number, or email address.
Current page number. Default 1.
Number of records per page. Default 20.
Field to sort by. Default createdAt.
Value in
- "name"
- "createdAt"
Sorting direction: 1 = ascending, -1 = descending. Default -1.
Value in
- 1
- -1
Only return beneficiaries created after this date.
Only return beneficiaries created before this date.
Comma-separated label names to filter by.
Comma-separated branch ids to filter by, for branch-scoped merchants.
Response Body
application/json
application/json
application/json
application/json
application/json
Get transfer by merchant transfer id GET
Retrieves a payout transfer using the merchantTransferId your own systems assigned to it, so you can reconcile against your records without having to store Kashier's transferId. merchantTransferId…
Add a beneficiary POST
Saves a new beneficiary. Kashier assigns the customerId (a B- prefixed value) and returns the record with the payment method echoed back as transferMethod plus its credentials under credentials.