Create a new transfer

Create a new transfer

Headers

X-BUSINESS-API-KEY

string

required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json

beneficiary

object

The beneficiary information. Only required if 'beneficiary_id' is not set. The payload depends on the country and payment method. Please refer Create Beneficiary for addtional fields

Show child attributes

beneficiary.country

enum<string>

The country code

Available options:

sg,

bd,

ph,

vn,

au

beneficiary.currency

enum<string>

The currency code

Available options:

sgd,

bdt,

php,

vnd,

aud

beneficiary.transfer_method

string

The transfer method

beneficiary.transfer_type

enum<string>

The transfer type

Available options:

local

Example:

"local"

beneficiary.holder_type

enum<string>

The Holder Type

Available options:

individual

Example:

"individual"

beneficiary.holder_name

string

The Holder Name

Maximum length: 255

Example:

"John Doe"

beneficiary_id

string

The Beneficiary id. Only required if 'beneficiary' is not set.

source_currency

string

It is beneficiary bank account currency.

Example:

"sgd"

source_amount

number

The amount to be transferred. Only required if 'payment_amount' is not set.

Required range: x >= 1

Example:

112.42

payment_amount

number

The amount to be transferred. Only required if 'source_amount' is not set.

Required range: x >= 1

Example:

10000.5

remitter_id

string

The remitter id. Only required if 'remitter' is not set.

Example:

"9b294222-3a53-427f-9393-95dc6d63ee6c"

remitter

object

The remitter information. Only required if 'remitter_id' is not set.

Show child attributes

remitter.entity_type

enum<string>

Available options:

individual,

company

Example:

"individual"

remitter.full_name

string

Maximum length: 255

Example:

"John Doe"

remitter.id_number

string

Maximum length: 255

Example:

"FB123456"

remitter.id_type

enum<string>

Available options:

passport,

national_id,

driving_license

Example:

"passport"

remitter.date_of_birth

string

Maximum length: 255

Example:

"1990-01-01"

remitter.place_of_birth

string

Example:

"Singapore"

remitter.nationality

string

2 letter code, lowercase

Required string length: 2

Example:

"sg"

remitter.contact_number

string

Maximum length: 100

Example:

"[phone]"

remitter.email

string

Maximum length: 255

Example:

"[e-mail]"

remitter.address

object

Show child attributes

remitter.address.city

string

required

Maximum length: 100

Example:

"Singapore"

remitter.address.state

string

required

Maximum length: 100

Example:

"SG"

remitter.address.street_address

string

Maximum length: 255

Example:

"1 Keong Saik Road"

remitter.address.postal_code

string

Maximum length: 30

Example:

"089109"

remitter.address.country

string

2 letter code, lowercase

Required string length: 2

Example:

"sg"

remitter.company_name

string

Only required if entity_type is company

Maximum length: 255

Example:

"HitPay Pte Ltd"

remark

string

Transfer note for internal use only

Maximum length: 120

reference

string

The reference for the transfer

Maximum length: 120

Response

201 - application/json

201

id

string

required

beneficiary

object

required

Show child attributes

beneficiary.id

string

required

beneficiary.status

string

required

beneficiary.country

string

required

beneficiary.currency

string

required

beneficiary.transfer_method

string

required

beneficiary.holder_name

string

required

beneficiary.holder_type

string

required

beneficiary.account_number

string

required

beneficiary.bank_name

string

required

beneficiary.bank_id

string

required

beneficiary.email

string | null

required

beneficiary.bank_routing_number

string

required

beneficiary.created_at

string

required

beneficiary.updated_at

string

required

payment_currency

string

required

payment_amount

number

required

source_currency

string

required

source_amount

number

required

exchange_rate

string

required

fee_payer

enum<string>

required

Available options:

payer,

beneficiary

total_fee

number

required

fee_currency

string

required

status

enum<string>

required

Available options:

pending,

scheduled,

processing,

completed,

failed

created_at

string

required