Beneficiary
Create a new beneficiary
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
Create a new beneficiary
A beneficiary is a person or business receiving the funds. HitPay currently supports local beneficiaries, enabling payouts within the same country and region.
POST
/
v1
/
beneficiaries
curl --request POST \
--url https://api.sandbox.hit-pay.com/v1/beneficiaries \
--header 'Content-Type: application/json' \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
--data '{
"country": "sg",
"transfer_method": "bank_transfer",
"transfer_type": "local",
"currency": "sgd",
"holder_type": "individual",
"holder_name": "John Tan",
"bank_id": "BOFASG2XXXX[7065]",
"account_number": "1409827"
}'
{
"id": "9ec01865-7af1-4937-813d-7801912d2cd1",
"status": "approved",
"country": "sg",
"currency": "sgd",
"transfer_method": "bank_transfer",
"transfer_type": "local",
"nickname": null,
"remark": null,
"holder_name": "John Test",
"holder_type": "individual",
"account_number": "1409828",
"bank_name": "BANK OF AMERICA",
"bank_id": "BOFASG2XXXX[7065]",
"email": null,
"bank_swift_code": "BOFASG2XXXX",
"is_favourite": false,
"created_by": {
"id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
"display_name": "TestingSG",
"first_name": "QA",
"last_name": "SG"
},
"created_at": "2025-04-24T15:13:22+08:00",
"updated_at": "2025-04-24T15:13:22+08:00",
"deleted_at": null
}
Headers
Example:
"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"
Body
application/json
Response
201
application/json
201
The response is of type any
.
Was this page helpful?
curl --request POST \
--url https://api.sandbox.hit-pay.com/v1/beneficiaries \
--header 'Content-Type: application/json' \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
--data '{
"country": "sg",
"transfer_method": "bank_transfer",
"transfer_type": "local",
"currency": "sgd",
"holder_type": "individual",
"holder_name": "John Tan",
"bank_id": "BOFASG2XXXX[7065]",
"account_number": "1409827"
}'
{
"id": "9ec01865-7af1-4937-813d-7801912d2cd1",
"status": "approved",
"country": "sg",
"currency": "sgd",
"transfer_method": "bank_transfer",
"transfer_type": "local",
"nickname": null,
"remark": null,
"holder_name": "John Test",
"holder_type": "individual",
"account_number": "1409828",
"bank_name": "BANK OF AMERICA",
"bank_id": "BOFASG2XXXX[7065]",
"email": null,
"bank_swift_code": "BOFASG2XXXX",
"is_favourite": false,
"created_by": {
"id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
"display_name": "TestingSG",
"first_name": "QA",
"last_name": "SG"
},
"created_at": "2025-04-24T15:13:22+08:00",
"updated_at": "2025-04-24T15:13:22+08:00",
"deleted_at": null
}