POST
/
v1
/
beneficiaries
curl --request POST \
  --url https://api.sandbox.hit-pay.com/v1/beneficiaries \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '{
  "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"
}'
{
  "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_by": {
    "id": "98566f58-1c76-4b8b-8f75-d20bba2bc7f8",
    "display_name": "TestingSG",
    "first_name": "QA",
    "last_name": "SG"
  },
  "created_at": "2025-04-24T15:13:22+08:00",
  "updated_at": "2025-04-24T15:13:22+08:00",
  "deleted_at": null
}

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json
​
country
enum<string>
required

Beneficiary bank country/region

Available options:
sg
Example:

"sg"

​
transfer_method
enum<string>
required

The transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account

Available options:
bank_transfer
Example:

"bank_transfer"

​
transfer_type
enum<string>
required
Available options:
local
Example:

"local"

​
currency
enum<string>
required

It is beneficiary bank account currency.

Available options:
sgd
Example:

"sgd"

​
holder_type
enum<string>
required

The Holder Type

Available options:
individual
Example:

"individual"

​
holder_name
string
required

The Holder Name

Maximum length: 255
Example:

"John Doe"

​
account_number
string
required

The account number

Maximum length: 255
Example:

"1409827"

​
bank_swift_code
string

It's bank swift code. To obtain a list of supported SWIFT codes, call Get the API schema API with the following parameters: country: sg, currency: sgd,transfer_method: bank_transfer, transfer_type: local and holder_type: individual.

Maximum length: 255
Example:

"BOFASG2XXXX"

​
nickname
string

Nickname

Maximum length: 255
​
remark
string

Remark

Maximum length: 255
Example:

"This is a remark"

​
is_favourite
boolean
​
email
string<email>

Email address

Example:

"abc@gmail.com"

Response

201

The response is of type any.