Create the transfer

Create the transfer

Headers

X-BUSINESS-API-KEY

string

required

Body

multipart/form-data

payment_amount

number

required

You can only specify one of source_amount or payment_amount

source_amount

number

required

You can only specify one of source_amount or payment_amount

source_currency

string

required

The supported currency. Example: sgd

attached_file

file | null

Only .jpg, .png, .gif and .pdf extensions are allowed. Maximum file size is 5MB.

beneficiary

object

It's required if the beneficiary beneficiary_id is not present.

The beneficiary attributes are dependant on the payout corridor and can be check via Get Schema.

Show child attributes

beneficiary.country

string

required

The country code. Example: "sg"

beneficiary.currency

string

required

The supported currency. Example: sgd

beneficiary.holder_name

string

required

beneficiary.holder_type

string

required

It's individual or company

beneficiary.transfer_method

string

required

It's local or swift

beneficiary.account_number

string

beneficiary.bank_swift_code

string

beneficiary_id

string

It's required if the beneficiary object is not present

remark

string | null

Max: 120 chars

Response

201 - application/json

attachment

string

required

beneficiary

object

required

Show child attributes

beneficiary.account_number

string

required

beneficiary.address

object

required

Show child attributes

beneficiary.address.city

string

required

beneficiary.address.postcode

string

required

beneficiary.address.state

string

required

beneficiary.address.street

string

required

beneficiary.bank_routing_number

string

required

beneficiary.country

string

required

beneficiary.created_at

string

required

beneficiary.currency

string

required

beneficiary.deleted_at

any

required

beneficiary.email

string

required

beneficiary.holder_name

string

required

beneficiary.holder_type

string

required

beneficiary.id

string

required

beneficiary.is_external

boolean

required

beneficiary.is_favourite

boolean

required

beneficiary.nickname

any

required

beneficiary.remark

string

required

beneficiary.transfer_method

string

required

beneficiary.updated_at

string

required

created_at

string

required

discount_fee

number

required

discount_fee_rate

number

required

exchange_rate

string

required

fixed_fee

number

required

fx_fee

number

required

fx_fee_rate

number

required

id

string

required

payment_amount

number

required

payment_currency

string

required

remark

string

required

source_amount

number

required

source_currency

string

required

source_type

any

required

status

string

required