Transfer
Get list of transfers
Guides
API References
- Payment Request
- Recurring Billing
- Charges
- Payout
- Balances
- Beneficiary
- Transfer
- Account
- Orders
- Products
- Product Category
- Customers
- Staffs
- Invoice
- Webhook Events
- Static QR Codes
- Notifications
- Terminal
Transfer
Get list of transfers
Get list of transfers
GET
/
v1
/
transfers
curl --request GET \
--url https://api.sandbox.hit-pay.com/v1/transfers \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
"data": [
{
"id": "9ec02ec7-a121-457f-9efc-1c4610fbe4e6",
"beneficiary": {
"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_at": "2025-04-24T15:13:22+08:00",
"updated_at": "2025-04-24T15:13:22+08:00",
"deleted_at": null
},
"payment_currency": "sgd",
"payment_amount": 20,
"source_currency": "usd",
"source_amount": 15.45,
"exchange_rate": "1.293876",
"fee": {
"amount": 0,
"currency": "usd",
"paid_by": "payer"
},
"remark": "Remark In deserunt voluptates aspernatur aut nisi occaecati.",
"reference": null,
"status": "scheduled",
"attachment": null,
"created_at": "2025-04-24T16:15:57+08:00"
},
{
"id": "9ec01866-a609-4ce4-a3d1-e3e230872509",
"beneficiary": {
"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_at": "2025-04-24T15:13:22+08:00",
"updated_at": "2025-04-24T15:13:22+08:00",
"deleted_at": null
},
"payment_currency": "sgd",
"payment_amount": 20,
"source_currency": "usd",
"source_amount": 15.45,
"exchange_rate": "1.293876",
"fee": {
"amount": 0,
"currency": "usd",
"paid_by": "payer"
},
"remark": "Remark Quia provident cumque molestiae corrupti molestiae.",
"reference": null,
"status": "scheduled",
"attachment": null,
"created_at": "2025-04-24T15:13:22+08:00"
}
],
"links": {
"first": null,
"last": null,
"prev": null,
"next": null
},
"meta": {
"path": "https://api.sandbox.hit-pay.com/v1/transfers",
"per_page": 25,
"next_cursor": null,
"prev_cursor": null
}
}
Headers
Example:
"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"
Query Parameters
The Beneficiary id
The keywords to search by ID, beneficiary name and remark
The status of the transfer
Available options:
scheduled
, processing
, paid
, failed
, canceled
Response
200 - application/json
200
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.sandbox.hit-pay.com/v1/transfers \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
"data": [
{
"id": "9ec02ec7-a121-457f-9efc-1c4610fbe4e6",
"beneficiary": {
"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_at": "2025-04-24T15:13:22+08:00",
"updated_at": "2025-04-24T15:13:22+08:00",
"deleted_at": null
},
"payment_currency": "sgd",
"payment_amount": 20,
"source_currency": "usd",
"source_amount": 15.45,
"exchange_rate": "1.293876",
"fee": {
"amount": 0,
"currency": "usd",
"paid_by": "payer"
},
"remark": "Remark In deserunt voluptates aspernatur aut nisi occaecati.",
"reference": null,
"status": "scheduled",
"attachment": null,
"created_at": "2025-04-24T16:15:57+08:00"
},
{
"id": "9ec01866-a609-4ce4-a3d1-e3e230872509",
"beneficiary": {
"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_at": "2025-04-24T15:13:22+08:00",
"updated_at": "2025-04-24T15:13:22+08:00",
"deleted_at": null
},
"payment_currency": "sgd",
"payment_amount": 20,
"source_currency": "usd",
"source_amount": 15.45,
"exchange_rate": "1.293876",
"fee": {
"amount": 0,
"currency": "usd",
"paid_by": "payer"
},
"remark": "Remark Quia provident cumque molestiae corrupti molestiae.",
"reference": null,
"status": "scheduled",
"attachment": null,
"created_at": "2025-04-24T15:13:22+08:00"
}
],
"links": {
"first": null,
"last": null,
"prev": null,
"next": null
},
"meta": {
"path": "https://api.sandbox.hit-pay.com/v1/transfers",
"per_page": 25,
"next_cursor": null,
"prev_cursor": null
}
}