Logo
Peach Payments Public API Documentation

Search Beneficiary by ID

GET {{beneficiaryUrl}}/api/beneficiaries/collections/:EntityKey

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




RESPONSES

status OK

{ "accountNumber": "123456789", "bankName": "", "branchCode": "632005", "debitDay": null, "debitMonth": null, "trackingDays": null, "accountType": 0, "amount": null, "clientCode": "PPPEA001", "clientName": "Peach Payments Test", "customerCode": "446", "endDate": null, "id": "254129158208240227110217072039065149150226103228", "installments": null, "isActive": true, "name": "Sadie Fay", "recurringPeriod": 0, "reference": "1664547533", "scheduleType": 0, "serviceCode": "DEBORD", "startDate": null, "tokenHash": "88323133D30585DD7DEDF2585E317A45C1DE5D65" }



Curl
curl -X GET 'beneficiaryUrl/api/beneficiaries/collections/:EntityKey'

ENDPOINTS