Skip to main content
GET
/
v1
/
transfers
Get list of 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>",
        "country": "<string>",
        "currency": "<string>",
        "transfer_method": "<string>",
        "nickname": "<string>",
        "remark": "<string>",
        "holder_name": "<string>",
        "holder_type": "<string>",
        "bank_routing_number": "<string>",
        "account_number": "<string>",
        "email": "<string>",
        "is_favourite": true,
        "created_at": "<string>",
        "updated_at": "<string>",
        "deleted_at": "<unknown>",
        "status": "<string>",
        "transfer_type": "<string>",
        "bank_branch_code": "<string>",
        "bank_name": "<string>",
        "bank_id": "<string>"
      },
      "payment_currency": "<string>",
      "payment_amount": 123,
      "source_currency": "<string>",
      "source_amount": 123,
      "exchange_rate": "<string>",
      "fee": {
        "paid_by": "payer",
        "amount": 123,
        "currency": "<string>"
      },
      "discount_fee_rate": 123,
      "fixed_fee": 123,
      "discount_fee": 123,
      "remark": "<string>",
      "status": "scheduled",
      "attachment": "<string>",
      "created_at": "<string>"
    }
  ],
  "links": {
    "first": "<unknown>",
    "last": "<unknown>",
    "prev": "<unknown>",
    "next": "<string>"
  },
  "meta": {
    "path": "<string>",
    "per_page": 123,
    "next_cursor": "<string>",
    "prev_cursor": "<unknown>"
  }
}

Headers

X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Query Parameters

beneficiary_id
string<uuid>

The Beneficiary id

keywords
string<uuid>

The keywords to search by ID, beneficiary name and remark

status
enum<string>

The status of the transfer

Available options:
scheduled,
processing,
paid,
failed,
canceled
per_page
integer<int32>
default:10

Response

200 - application/json

200

data
object[]
meta
object