Create Fiat Payout API

API Information

Item	Description
Method	`POST`
Path	`/apis/v1/fiat-payout/create`
Content-Type	`application/json`
Authentication	Required. Refer to 'Authorization Introduction'

Description

This API is used to create a fiat payout request.

Request Parameters

Request body parameters:

Parameter	Required	Type	Description
`merchantReferenceId`	Yes	`string`	Merchant reference ID
`payoutAmount`	Yes	`number`	Payout amount
`deductionCurrency`	Yes	`string`	Deduction currency
`transactionType`	Yes	`string`	Transaction type
`payoutCurrency`	Yes	`string`	Payout currency
`sender`	No	`object`	Sender information object See: Personal Sender Object or Business Sender Object
`beneficiaryMethod`	Yes	`object`	Beneficiary method object; field structure depends on the specific payout channel
`isRecipientSelf`	No	`boolean`	Whether the recipient is the same person; default is `false`
message	No	`string`	String sent to the bank(only for inr now)

Common Fields in `sender`

The Personalsender object may include the following fields:

Parameter Code	Parameter Description	Type	Required	Remark
accountType	PERSONAL	String	Y	Default PERSONAL
`name`	name	String	Y
`email`	email	String	Y
`phone`	phone	String	Y	Example: `+8613002140325`
`phoneCountryCode`	Phone Country Code	String	Y	Example: `+86`
`firstName`	first name	String	N	CNY required
`lastName`	last name	String	N	CNY required
`dateOfBirth`	birthday	String	N	CNY required; INR required
`gender`	Gender: `M` Male, `F` Female	String	N	CNY required
`idType`	Id Type: `1` Passport `2` Identification Card `3` Company Registration Document `4` Others `5` Work Permit	String	N	CNY required
`idSubType`	`PASSPORT`, `ID_CARD`, `DRIVER_LICENSE`, `DRIVERS`, `VEHICLE_REGISTRATION_CERTIFICATE`, `RESIDENCE_PERMIT`, `LOCAL_ID`, `EMIRATES_ID`	String	N	INR required; INR supports `PASSPORT`, `ID_CARD`, `DRIVER_LICENSE`, `LOCAL_ID`, `EMIRATES_ID`
`idValue`	Id Value	String	N	CNY required; INR required
`idIssueCountry`	Id Issue Country, three digit country code, e.g. `CNH`	String	N	CNY required
`nationality`	Nationality, three digit country code, e.g. `CNH`	String	N	CNY required; INR required
`address`	address	String	N	INR required
`postalCode`	Postal code	String	N
`city`	city	String	N	INR required
`state`	state	String	N
`country`	Country, three digit country code, e.g. `CNH`	String	N	CNY required
`occupation`	Occupation: `1` PMET, `2` Blue Collar Staff, `3` Sales/Marketing Staff, `4` IT/Cyber Security Staff, `5` Student, `6` Engineer, `7` Customer Service, `8` Business Owner, `9` Retired	String	N

The Businesssender object may include the following fields:

Business Sender Object

Parameter Code	Parameter Description	Type	Required	Remark
accountType	BUSINESS	String	Y	Default PERSONAL
name	Legal name of the enterprise	String	Y
registrationNumber	Enterprise Registration Number	String	Y
country	The country where the sender is located	String	Y
registrationCountry	Country of Enterprise Registration	String	N
address	Enterprise address	String	Y
phoneCountryCode	Mobile country code, like: +86	String	Y
mobileNumber	Enterprise Mobile Number, like: +8613002140325	String	Y
type	1: Cashless Retailers 2: Online Small Retailers 3: Restaurants, Cafes and Supermarkets 4: Importers/Exporters	String	N	EUR required
bankBranchCode	Branch code of the company's bank	String	N	AUD required
city	Enterprise city	String	N	GBP/EUR/USD/CAD/JPY required
region	Location of the enterprise	String	N	USD required
zipCode	Enterprise postal code	String	N	GBP/USD/CAD required
structure	Corporate structure: 1: SP 2: Co. 3: Corp. 4: LP 5: LLP 6: LLC 7: Pte Ltd. 8: Public Ltd.	String	N	EUR/USD/KRW required
incorporationDate	Date of establishment of the enterprise	String	N	USD required
remark	Include any additional comments or notes related to the transaction by the sender company	String	N	AUD required

Dynamic Beneficiary Method

The Dynamic Beneficiary Method requires different parameters based on the payout currency.

Currency: IDR

Parameter Code	Parameter Description	Type	Verification	Required
`accountNumber`	bank card number	String	`^\d{10,16}$`	Y
`bankCode`	bank code: See Bank Code list	String		Y
`name`	name	String	`^[a-zA-Z.\s]+$`	Y

Bank Code List: https://docs.google.com/document/d/1SzctcDhvwsN9cgzzMxYG2LRvzX6srYihivEORVqjuZQ/edit?usp=sharing

Currency: INR

Parameter Code	Parameter Description	Type	Verification	Required
`accountNumber`	bank card number	String	`^\d{9,18}$`	N
`ifsc`	IFSC code	String	`^[A-Z]{4}0[a-zA-Z0-9]{6}$`	N
`name`	name	String	`^[a-zA-Z.\s]+$`	Y
`vpa`	VPA	String		N
`transactionType`	Electronic Funds Transfer System	String	`IMPS`	Y

Note: The vpa field is mutually exclusive with accountNumber, name, and ifsc; one option must be selected and filled in.

Currency: VND

Parameter Code	Parameter Description	Type	Required
`accountNumber`	bank card number	String	Y
`napasCode`	napas code: Napas Code List	String	Y
`name`	name	String	Y

Napas Code List: https://docs.google.com/document/d/1b1rMOOpNOWIyNmBgHXAoDmxt5ChmN6V9zToISK-ZyLw/edit?tab=t.0

Currency: PHP

Parameter Code	Parameter Description	Type	Verification	Required
`accountNumber`	bank card number	String		Y
`bankCode`	bank code: See Bank Code list	String		Y
`name`	name	String	`^[a-zA-Z.\s]+$`	Y

Bank Code List: https://docs.google.com/document/d/1RAp4R9WNrueEnfpNtqq7R_MmA9KXbwTq2CNeecctK7M/edit?tab=t.0

Currency: CNY

Parameter Code	Parameter Description	Type	Verification	Required
accountType	PERSONAL or BUSINESS	String	Y	Default PERSONAL

Personal

The following parameters are old version parameters. Please use the following parameters for new connections.

~~Parameter Code~~	~~Parameter Description~~	~~Type~~	~~Verification~~	~~Required~~
~~receiverBankAccountNumber~~	~~Receiver bank card number~~	~~String~~		Y
~~receiverDateOfBirth~~	~~Receiver birthday~~	~~String~~	~~yyyy-MM-dd or dd/MM/yyyy or MM-dd-yyyy or MM/dd/yy~~	N
~~receiverGender~~	~~Receiver gender~~	~~String~~	M: Male F: Female	Y
~~receiverNativeName~~	~~National ID. The recipient must be a Chinese citizen with a Chinese national ID~~	~~String~~		Y
~~receiverIdType~~	~~Receiver id type~~	~~String~~	~~2: Identification Card~~	Y
~~receiverMobileNumber~~	~~Receiver mobile number~~	~~String~~	~~like: +8613902140325~~	Y
~~receiverNativeFirstName~~	~~First name (Chinese)~~	~~String~~		Y
~~receiverNativeLastName~~	~~Last name (Chinese)~~	~~String~~		Y

New Connection Parameters

Parameter Code	Parameter Description	Type	Verification	Required
bankAccountNumber	Receiver bank card number	String	max:50	Y
idNumber	National ID. The recipient must be a Chinese citizen with a Chinese national ID	String	min:3	max:18	alpha_num	Y
idType	Receiver id type	String	2: Identification Card	Y
nativeFirstName	First name (Chinese)	String	string	max:50	regex:/^[\p{script=Han}]+/u	Y
nativeLastName	Last name (Chinese)	String	string	max:50	regex:/^[\p{script=Han}]+/u	Y

Business

Parameter Code	Parameter Description	Type	Verification	Required
nativeName	The native legal name of the receiver company (Chinese)	String	max:50	Y
bankAccountNumber	Bank account number	String	max:30	Y
registrationNumber	The identification number of the receiver company	String	max:50	Y

Currency: GBP

Parameter Code	Parameter Description	Type	Verification	Required
accountType	PERSONAL or BUSINESS	String	Y	Default PERSONAL

Personal

Parameter Code	Parameter Description	Type	Verification	Required
firstName	First name	String	Max:50 ^[A-Za-z0-9 .'-]+$	Y
lastName	Last name	String	Max:50 ^[A-Za-z0-9 .'-]+$	Y
dateOfBirth	Date of birth	String	^\d4-((0[1-9]\|1[012]))-((0[1-9]\|[12][0-9]\|3[01]))$	Y
bankBranchCode	Branch code of the receiver company's bank	String	min:1	max:6	Y
bankAccountNumber	Bank account number	String	max:50	Y

Business

Parameter Code	Parameter Description	Type	Verification	Required
name	Legal name of the receiver company	String	Max:100 ^[A-Za-z0-9 .'-]+$	Y
bankBranchCode	Branch code of the receiver company's bank	String	digits:6	Y
bankAccountNumber	Bank account number	String	digits:8	Y

Currency: EUR

Parameter Code	Parameter Description	Type	Verification	Required
accountType	PERSONAL or BUSINESS	String	Y	Default PERSONAL

Personal

Parameter Code	Parameter Description	Type	Verification	Required
firstName	First name	String	Max:50 ^[A-Za-z0-9 .'-]+$	Y
lastName	Last name	String	Max:50 ^[A-Za-z0-9 .'-]+$	Y
dateOfBirth	Date of birth	String	^\d4-((0[1-9]\|1[012]))-((0[1-9]\|[12][0-9]\|3[01]))$	Y
idType	1: Passport 2: Identification Card 4: Others 5: Work Permit	String		Y
idNumber	Identification number	String	alpha_num	min:3	max:20	Y
address	Address	String	max:50	Y
bankAccountNumber	Bank account number	String	max:50	Y

Business

Parameter Code	Parameter Description	Type	Verification	Required
name	Legal name of the receiver company	String	Max:50 ^[A-Za-z0-9 .'-]+$	Y
bankAccountNumber	Bank account number	String	alpha_num	min:1	max:34	Y
address	Address of the receiver company	String	min:1	max:50	Y
structure	Corporate structure: 1:SP 2:Co. 3:Corp. 4:LP 5:LLP 6:LLC 7:Pte Ltd. 8:Public Ltd.	String		Y
registrationNumber	Identification number of the receiver company	String	min:3	max:20	Y

Currency: USD

Parameter Code	Parameter Description	Type	Verification	Required
accountType	PERSONAL or BUSINESS	String	Y	Default PERSONAL

Personal

Parameter Code	Parameter Description	Type	Verification	Required
firstName	First name	String	Max:50 ^[A-Za-z0-9 .'-]+$	Y
lastName	Last name	String	Max:50 ^[A-Za-z0-9 .'-]+$	Y
dateOfBirth	Date of birth	String	^\d4-((0[1-9]\|1[012]))-((0[1-9]\|[12][0-9]\|3[01]))$	Y
bankCode	American banks are identified by a 9 digit ABA number, also known as "Routing Number". The ABA should be valid for FedACH payments.	String	digits:9	Y
phoneCountryCode	Mobile country code	String		Y
mobileNumber		String	digits_between:8,11	Y
zipCode	The receiver's personal or residential details as applicable	String	digits:5	Y
idType	1: Passport 2: Identification Card	String		Y
idNumber	Identification number	String	max:20\|alpha_num	Y
nationality	Receiver's nationality or citizenship. See: Nationality list	String		Y
region	Northeast: Northeast Southwest: Southwest West: West Southeast: Southeast Midwest: Midwest	String		Y
city	City	String	^[A-Za-z .'-]+$	Y
address	Address	String	max:50	Y
bankAccountType	2: Saving 3: Current 4: Checking 6: Corporate	String		Y
bankAccountNumber	Bank account number	String	max:50	Y

Nationality list: https://docs.google.com/document/d/1ZavJOD2vE6JRteOWsJpHh5UUsxkOB3yO783Qo7O7Lcc/edit?tab=t.0

Business

Parameter Code	Parameter Description	Type	Verification	Required
name	Legal name of the receiver	String	Max:50 ^[A-Za-z0-9 .'-]+$	Y
phoneCountryCode	Mobile country code	String		Y
mobileNumber		String	digits_between:8,11	Y
registrationNumber	Identification number of the receiver company	String	alpha_num	Y
zipCode	Postal code or ZIP code where the receiver company is located	String	digits:5	Y
bankAccountType	2: Saving 3: Current 4: Checking 6: Corporate	String		Y
bankAccountNumber	Bank account number	String	alpha_num	min:1	max:34	Y
registrationCountry	Receiver's nationality or citizenship. See: Registration Country list	String		Y
region	Northeast: Northeast Southwest: Southwest West: West Southeast: Southeast Midwest: Midwest	String		Y
city	City	String	^[A-Za-z .'-]+$	Y
address	Address of the receiver company	String	^[A-Za-z0-9 .'-]+$	Y
bankCode	American banks are identified by a 9 digit ABA number, also known as "Routing Number". The ABA should be valid for FedACH payments.	String	digits:9	Y
structure	Corporate structure: 1: LLC 2: Inc. 3: Co. 4: Corp. 5: LLP	String		Y

Registration Country list: https://docs.google.com/document/d/1gng7wnUAQ4MXX2gdJ0Pr2okhYvOUgBJ9yewhAa147cM/edit?tab=t.0

Currency: AED

Parameter Code	Parameter Description	Type	Verification	Required
accountType	PERSONAL or BUSINESS	String	Y	Default PERSONAL

Personal

Parameter Code	Parameter Description	Type	Verification	Required
firstName	First name	String	Max:50 ^[A-Za-z0-9 .'-]+$	Y
lastName	Last name	String	Max:50 ^[A-Za-z0-9 .'-]+$	Y
bankName	Bank name		max:100	Y
address	Address	String	max:50	Y
ibanNumber	The IBAN number of the receiver	String	max:50	Y

Business

Parameter Code	Parameter Description	Type	Verification	Required
name	Legal name of the receiver company	String	Max:50 ^[A-Za-z0-9 .'-]+$	Y
ibanNumber	The IBAN number of the receiver's company		max:50
bankName	Bank name	String	string	min:1	max:100	Y
address	Address of the receiver company	String	min:1	max:50	Y

Response

The standard response structure is R<object>.

data fields:

Field	Type	Description
`payoutId`	`string`	Payout transaction ID
`deductionAmount`	`number`	Deduction amount
`rate`	`number`	Exchange rate
`payoutAmount`	`number`	Payout amount
`payoutCurrency`	`string`	Payout currency
`deductionCurrency`	`string`	Deduction currency
`transactionType`	`string`	Transaction type
`status`	`string`	Transaction status
`totalFee`	`number`	Total fee
`feeCurrency`	`string`	Fee currency
`merchantId`	`string`	Merchant ID
`merchantReferenceId`	`string`	Merchant reference ID
`completeTime`	`string`	Completion time
`createdTime`	`string`	Creation time
`updatedTime`	`string`	Update time
`errorPayload`	`string`	Error details

For fields: errorPayload
It is primarily designed for humans and for reconcilliation purposes.
Please do not build your integration with while relying on this field.
If you have a use case for some information is not available otherwise, please contact us.

Create Fiat Payout API

API Information

Description

Request Parameters

Common Fields in sender

Business Sender Object

Dynamic Beneficiary Method

Currency: IDR

Currency: INR

Currency: VND

Currency: PHP

Currency: CNY

Personal

New Connection Parameters

Business

Currency: GBP

Personal

Business

Currency: EUR

Personal

Business

Currency: USD

Personal

Business

Currency: AED

Personal

Business

Response

Common Fields in `sender`