Create a new beneficiary

POST

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

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"

bank_id

string

required

It's bank id. To obtain a list of supported values for bank_id, 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[7065]"

account_number

string

required

The account number

Maximum length: 255

Example:

"1409827"

nickname

string

Nickname

Maximum length: 255

remark

string

Remark

Maximum length: 255

Example:

"This is a remark"

is_favourite

boolean

Remark

string

Email address

Example:

"abc@gmail.com"

country

enum<string>

required

Beneficiary bank country/region

Available options:

sg

Example:

"sg"

transfer_method

enum<string>

required

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"

bank_id

string

required

Maximum length: 255

Example:

"BOFASG2XXXX[7065]"

account_number

string

required

The account number

Maximum length: 255

Example:

"1409827"

nickname

string

Nickname

Maximum length: 255

remark

string

Remark

Maximum length: 255

Example:

"This is a remark"

is_favourite

boolean

Remark

string

Email address

Example:

"abc@gmail.com"

country

enum<string>

required

Beneficiary bank country/region

Available options:

bd

transfer_method

enum<string>

required

Available options:

bank_transfer

Example:

"bank_transfer"

transfer_type

enum<string>

required

Available options:

local

currency

enum<string>

required

It is beneficiary bank account currency.

Available options:

bdt

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"

bank_id

string

required

It's bank id. To obtain a list of supported values for bank_id, call Get the API schema API with the following parameters: country: bd, currency: bdt,transfer_method: bank_transfer, transfer_type: local and holder_type: individual to get the the correct supported bank id.

Maximum length: 255

Example:

"brc-20"

bank_routing_number

string

required

Bank Rounting Number

Maximum length: 255

Example:

"060261726"

account_number

string

required

The account number

Maximum length: 255

Example:

"1503201781283001"

nickname

string

Nickname

Maximum length: 255

remark

string

Remark

Maximum length: 255

Example:

"This is a remark"

is_favourite

boolean

Remark

string

Email address

Example:

"abc@gmail.com"

country

enum<string>

required

Beneficiary bank country/region

Available options:

bd

transfer_method

enum<string>

required

Available options:

upay

Example:

"upay"

currency

enum<string>

required

It is beneficiary bank account currency.

Available options:

bdt

Example:

"bdt"

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"

district

string

required

District

Maximum length: 255

Example:

"BD-03"

account_number

string

required

The account number

Maximum length: 255

Example:

"+8801914538413"

nickname

string

Nickname

Maximum length: 255

Example:

"John"

remark

string

Remark

Maximum length: 255

Example:

"This is a remark"

is_favourite

boolean

Remark

string

Email address

Example:

"abc@gmail.com"

country

enum<string>

required

Beneficiary bank country/region

Available options:

bd

transfer_method

enum<string>

required

Available options:

bkash

Example:

"bkash"

currency

string

required

It is beneficiary bank account currency.

Example:

"bdt"

holder_type

enum<string>

required

The Holder Type

Available options:

individual

Example:

"individual"

holder_name

string

required

The Holder Name

Maximum length: 255

Example:

"Rashid"

district

string

required

District

Maximum length: 255

Example:

"BD-03"

account_number

string

required

The account number

Maximum length: 255

Example:

"+8801721940130"

nickname

string

Nickname

Maximum length: 255

Example:

"John"

remark

string

Remark

Maximum length: 255

Example:

"This is a remark"

is_favourite

boolean

Remark

string

Email address

Example:

"abc@gmail.com"

country

enum<string>

required

Beneficiary bank country/region

Available options:

bd

transfer_method

enum<string>

required

Available options:

tap

Example:

"tap"

currency

string

required

It is beneficiary bank account currency.

Example:

"bdt"

holder_type

enum<string>

required

The Holder Type

Available options:

individual

Example:

"individual"

holder_name

string

required

The Holder Name

Maximum length: 255

Example:

"Rashid"

district

string

required

District

Maximum length: 255

Example:

"BD-03"

account_number

string

required

The account number

Maximum length: 255

Example:

"+8801721940130"

nickname

string

Nickname

Maximum length: 255

Example:

"John"

remark

string

Remark

Maximum length: 255

Example:

"This is a remark"

is_favourite

boolean

Remark

string

Email address

Example:

"abc@gmail.com"

country

enum<string>

required

Beneficiary bank country/region

Available options:

ph

transfer_method

enum<string>

required

Available options:

bank_transfer

Example:

"bank_transfer"

currency

enum<string>

required

It is beneficiary bank account currency.

Available options:

php

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"

bank_id

string

required

It's bank id. To obtain a list of supported values for bank_id, call Get the API schema API with the following parameters: country: ph, currency: php,transfer_method: bank_transfer, transfer_type: local and holder_type: individual to get the the correct supported bank id.

Maximum length: 255

Example:

"10419995"

account_number

string

required

The account number

Maximum length: 255

Example:

"14098377"

address

object

required

transfer_type

enum<string>

Available options:

local

Example:

"local"

nickname

string

Nickname

Maximum length: 255

Example:

"John"

remark

string

Remark

Maximum length: 255

Example:

"This is a remark"

is_favourite

boolean

string

Email address

Example:

"abc@gmail.com"

country

enum<string>

required

Beneficiary bank country/region

Available options:

vn

transfer_method

enum<string>

required

Available options:

bank_transfer

Example:

"bank_transfer"

currency

enum<string>

required

It is beneficiary bank account currency.

Available options:

vnd

Example:

"vnd"

holder_type

enum<string>

required

The Holder Type

Available options:

individual

Example:

"individual"

holder_name

string

required

The Holder Name

Maximum length: 255

Example:

"Quang Nguyen"

bank_swift_code

string

required

Bank Swift Code

Maximum length: 255

Example:

"BFTVVNVX"

bank_branch_code

string

required

Branch Bank Code

Maximum length: 255

Example:

"01203003"

account_number

string

required

The account number

Maximum length: 255

Example:

"9704000000000018"

transfer_type

enum<string>

Available options:

local

Example:

"local"

bank_id

string

The bank id

Maximum length: 255

Example:

"10419995"

nickname

string

Nickname

Maximum length: 255

Example:

"John"

remark

string

Remark

Maximum length: 255

Example:

"This is a remark"

is_favourite

boolean

string

Email address

Example:

"abc@gmail.com"

country

enum<string>

required

Beneficiary bank country/region

Available options:

au

transfer_method

enum<string>

required

Available options:

bank_transfer

Example:

"bank_transfer"

currency

enum<string>

required

It is beneficiary bank account currency.

Available options:

aud

holder_type

enum<string>

required

The Holder Type

Available options:

individual

Example:

"individual"

holder_name

string

required

The Holder Name

Maximum length: 255

Example:

"Charles Edward"

bank_routing_number

string

required

Bank Rounting Number

Maximum length: 255

Example:

"110000"

account_number

string

required

The account number

Maximum length: 255

Example:

"9704000000000018"

password

string

required

The Password

Maximum length: 255

Example:

"Qwerty12#"

is_external

boolean

required

is_favourite

boolean

required

transfer_type

enum<string>

Available options:

local

Example:

"local"

nickname

string

Nickname

Maximum length: 255

Example:

"John"

remark

string

Remark

Maximum length: 255

Example:

"This is a remark"

string

Email address

Example:

"abc@gmail.com"

Was this page helpful?

Get the API schema Update existing beneficiary

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

Guides

API References

Create a new beneficiary

Headers

Body