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": "9b294222-3a53-427f-9393-95dc6d63ee6c",
      "is_external": true,
      "country": "us",
      "currency": "usd",
      "transfer_method": "local",
      "nickname": null,
      "remark": "Remark Update 1706015123",
      "holder_name": "US Customer123",
      "holder_type": "individual",
      "email": "abc@gmail.com",
      "bank_routing_number": "021000021",
      "account_number": "50001121",
      "address": {
        "city": "New York",
        "state": "US-NY",
        "street": "Test Street",
        "postcode": "10015"
      },
      "is_favourite": false,
      "created_at": "2024-01-23T21:04:15+08:00",
      "updated_at": "2024-01-23T21:05:23+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=49",
    "prev": null,
    "next": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 49,
    "links": [
      {
        "url": null,
        "label": "&larr; 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=48",
        "label": "48",
        "active": false
      },
      {
        "url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=49",
        "label": "49",
        "active": false
      },
      {
        "url": "https://api.sandbox.hit-pay.com/v1/beneficiaries?page=2",
        "label": "Next &rarr;",
        "active": false
      }
    ],
    "path": "https://api.sandbox.hit-pay.com/v1/beneficiaries",
    "per_page": 1,
    "to": 1,
    "total": 49
  }
}

Headers

X-BUSINESS-API-KEY
string
required

Query Parameters

query
string

Search by holder name / nickname

per_page
integer
default: 10

Response

200 - application/json
data
object[]
required
links
object
required
meta
object
required