Sign in

v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

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

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Request body

OR
OR
OR
OR
OR

Example request

{
  "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"
}

Response

201