Beneficiary
Get list of beneficiaries
Guides
API References
- Payment Request
- Recurring Billing
- Charges
- Payout
- Account
- Orders
- Products
- Product Category
- Customers
- Staffs
- Invoice
- Webhook Events
- Static QR Codes
- Notifications
- Terminal
Beneficiary
Get list of beneficiaries
Get list of beneficiaries
GET
/
v1
/
beneficiaries
curl --request GET \
--url https://api.sandbox.hit-pay.com/v1/beneficiaries \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
"data": [
{
"id": "9eb3d3ff-3fb0-450e-bb61-7c0753974398",
"status": "approved",
"country": "sg",
"currency": "sgd",
"transfer_method": "bank_transfer",
"transfer_type": "local",
"nickname": "Test QA",
"remark": "Test QA",
"holder_name": "Test QA",
"holder_type": "individual",
"bank_branch_code": "001",
"account_number": "173737377",
"bank_name": "AMERICAN EXPRESS BANK LTD",
"bank_id": "AEIBSGSXXXX[7454]",
"email": "test@gmail.com",
"bank_swift_code": "AEIBSGSXXXX",
"is_favourite": true,
"created_by": {
"id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
"display_name": "TestingSG",
"first_name": "QA",
"last_name": "SG"
},
"created_at": "2025-04-18T12:52:10+08:00",
"updated_at": "2025-04-18T12:52:10+08:00",
"deleted_at": null
}
],
"links": {
"first": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=1",
"last": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=23",
"prev": null,
"next": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 23,
"links": [
{
"url": null,
"label": "← Previous",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=1",
"label": "1",
"active": true
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=2",
"label": "2",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=3",
"label": "3",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=4",
"label": "4",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=5",
"label": "5",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=6",
"label": "6",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=7",
"label": "7",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=8",
"label": "8",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=9",
"label": "9",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=10",
"label": "10",
"active": false
},
{
"url": null,
"label": "...",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=22",
"label": "22",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=23",
"label": "23",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=2",
"label": "Next →",
"active": false
}
],
"path": "https://api.sandbox.hit-pay.com/v1/beneficiaries",
"per_page": 10,
"to": 1,
"total": 23
}
}
Headers
Example:
"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"
Response
200 - application/json
200
Was this page helpful?
curl --request GET \
--url https://api.sandbox.hit-pay.com/v1/beneficiaries \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
"data": [
{
"id": "9eb3d3ff-3fb0-450e-bb61-7c0753974398",
"status": "approved",
"country": "sg",
"currency": "sgd",
"transfer_method": "bank_transfer",
"transfer_type": "local",
"nickname": "Test QA",
"remark": "Test QA",
"holder_name": "Test QA",
"holder_type": "individual",
"bank_branch_code": "001",
"account_number": "173737377",
"bank_name": "AMERICAN EXPRESS BANK LTD",
"bank_id": "AEIBSGSXXXX[7454]",
"email": "test@gmail.com",
"bank_swift_code": "AEIBSGSXXXX",
"is_favourite": true,
"created_by": {
"id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
"display_name": "TestingSG",
"first_name": "QA",
"last_name": "SG"
},
"created_at": "2025-04-18T12:52:10+08:00",
"updated_at": "2025-04-18T12:52:10+08:00",
"deleted_at": null
}
],
"links": {
"first": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=1",
"last": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=23",
"prev": null,
"next": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 23,
"links": [
{
"url": null,
"label": "← Previous",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=1",
"label": "1",
"active": true
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=2",
"label": "2",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=3",
"label": "3",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=4",
"label": "4",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=5",
"label": "5",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=6",
"label": "6",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=7",
"label": "7",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=8",
"label": "8",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=9",
"label": "9",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=10",
"label": "10",
"active": false
},
{
"url": null,
"label": "...",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=22",
"label": "22",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=23",
"label": "23",
"active": false
},
{
"url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=2",
"label": "Next →",
"active": false
}
],
"path": "https://api.sandbox.hit-pay.com/v1/beneficiaries",
"per_page": 10,
"to": 1,
"total": 23
}
}