Transfer
Get Transfers
Guides
API References
- Payment Request
- Recurring Billing
- Charges
- Payout
- Balances
- Beneficiary
- Transfer
- Account
- Orders
- Products
- Product Category
- Customers
- Staffs
- Invoice
- Webhook Events
- Notifications
- Terminal
Transfer
Get Transfers
Get all 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": "<string>",
"beneficiary": {
"id": "<string>",
"is_external": true,
"country": "<string>",
"currency": "<string>",
"transfer_method": "<string>",
"nickname": "<any>",
"remark": "<string>",
"holder_name": "<string>",
"holder_type": "<string>",
"email": "<string>",
"bank_routing_number": "<string>",
"account_number": "<string>",
"address": {
"city": "<string>",
"state": "<string>",
"street": "<string>",
"postcode": "<string>"
},
"is_favourite": true,
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<any>"
},
"payment_currency": "<string>",
"payment_amount": 123,
"source_currency": "<string>",
"source_amount": 123,
"exchange_rate": "<string>",
"fixed_fee": 123,
"discount_fee": 123,
"discount_fee_rate": 123,
"fx_fee": 123,
"fx_fee_rate": 123,
"remark": "<string>",
"status": "<string>",
"source_type": "<any>",
"attachment": "<string>",
"created_at": "<string>"
}
],
"links": {
"first": "<any>",
"last": "<any>",
"prev": "<any>",
"next": "<string>"
},
"meta": {
"path": "<string>",
"per_page": 123,
"next_cursor": "<string>",
"prev_cursor": "<any>"
}
}
Headers
Query Parameters
Response
200 - application/json
200
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": "<string>",
"beneficiary": {
"id": "<string>",
"is_external": true,
"country": "<string>",
"currency": "<string>",
"transfer_method": "<string>",
"nickname": "<any>",
"remark": "<string>",
"holder_name": "<string>",
"holder_type": "<string>",
"email": "<string>",
"bank_routing_number": "<string>",
"account_number": "<string>",
"address": {
"city": "<string>",
"state": "<string>",
"street": "<string>",
"postcode": "<string>"
},
"is_favourite": true,
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<any>"
},
"payment_currency": "<string>",
"payment_amount": 123,
"source_currency": "<string>",
"source_amount": 123,
"exchange_rate": "<string>",
"fixed_fee": 123,
"discount_fee": 123,
"discount_fee_rate": 123,
"fx_fee": 123,
"fx_fee_rate": 123,
"remark": "<string>",
"status": "<string>",
"source_type": "<any>",
"attachment": "<string>",
"created_at": "<string>"
}
],
"links": {
"first": "<any>",
"last": "<any>",
"prev": "<any>",
"next": "<string>"
},
"meta": {
"path": "<string>",
"per_page": 123,
"next_cursor": "<string>",
"prev_cursor": "<any>"
}
}