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
`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 sender object may include the following fields:

Parameter Code	Parameter Description	Type	Required	Remark
`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

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	Verification	Required
`accountNumber`	bank card number	String	`^\d{9,18}$`	Y
`napasCode`	napas code: Napas Code List	String		Y
`name`	name	String	`^[a-zA-Z.\s]+$`	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	`^\d{9,18}$`	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
`receiverBankAccountNumber`	Receiver bank card number	String	`^\d{9,18}$`	Y
`receiverDateOfBirth`	Receiver birthday	String	`^\d4-(0[1-9]	1[012])-(0[1-9]	[12][0-9]	3[01])$`	N
`receiverGender`	Receiver gender	String	`M`: Male, `F`: Female	Y
`receiverIdNumber`	National ID (The recipient must be a Chinese citizen with a Chinese national ID)	String	`^[A-Za-z0-9 .-]{1,18}$`	Y
`receiverIdType`	Receiver ID type	String	`1`: Passport, `2`: Identification Card	Y
`receiverMobileNumber`	Receiver mobile number	String	Example: `+8613002140325`	Y
`receiverNativeFirstName`	First name (Chinese)	String		Y
`receiverNativeLastName`	Last name (Chinese)	String		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.