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 support: USD USDT USDC VND INR |
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
senderPersonal Sender Object
| Parameter Code | Parameter Description | type | Required | remark |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | N | Default PERSONAL |
| name | name | String | Y | |
| String | Y | |||
| phone | phone | String | Y | +8613002140325 |
| phoneCountryCode | Phone Country Code | String | Y | +86 |
| firstName | first name | String | N | |
| lastName | last name | String | N | |
| dateOfBirth | birthday | String | N | |
| gender | Gender M: Male F: Female | String | N | |
| idType | Id Type 1: Passport 2: Identification Card 3: Company Registration Document 4: Others 5: Work Permit | String | N | EUR support 1 2 4 5 GBP support 1 2 USD support 1 2 AUD support 1 2 4 5 JPY support 1 2 MYR support 1 2 CAD support 1 2 KRW support 1 2 HKD support 1 2 5 Other support all |
| idSubType | PASSPORT ID_CARD DRIVER_LICENSE DRIVERS VEHICLE_REGISTRATION_CERTIFICATE RESIDENCE_PERMIT LOCAL_ID EMIRATES_ID | String | N | INR support: PASSPORT / ID_CARD / DRIVER_LICENSE / LOCAL_ID / EMIRATES_ID IDR support: PASSPORT / ID_CARD |
| idValue | Id Value | String | N | |
| idIssueCountry | Id Issue Country Three digit country code like: CNH | String | N | |
| nationality | nationality Three digit country code like: CNH | String | N | |
| address | address | String | N | |
| postalCode | Postal code | String | N | |
| city | city | String | N | |
| state | state | String | N | |
| region | region | String | N | |
| country | country Three digit country code like: CNH | String | N | |
| 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 | |
| remark | String | N |
Other Currency Special Required Fields
- The required parameters above are for all currencies and will not be listed one by one in the table below
- For currencies not listed in the table below, only the required parameters need to be filled in
| Currency | Required Fields |
|---|---|
| IDR | idSubType、idValue、nationality |
| INR | dateOfBirth、idSubType、idValue、nationality、address、city、country |
| USD | payoutMethod = BANK_TRANSFER:firstName、lastName、dateOfBirth、idType、idValue、nationality、address、city、postalCode、region、countrypayoutMethod = BANK_TRANSFER_SWIFT:firstName、lastName、idType、idValue、address、city、country |
| CNY | firstName、lastName、dateOfBirth、gender、idType、idValue、idIssueCountry、nationality、country |
| EUR | firstName、lastName、dateOfBirth、idType、idValue、nationality、city、address、country、occupation |
| GBP | firstName、lastName、dateOfBirth、idType、idValue、nationality、address、postalCode、city、country |
| AED | firstName、lastName、idType、idValue、address、country |
| AUD | firstName、lastName、dateOfBirth、idType、idValue、nationality、city、country、remark |
| THB | firstName、lastName、dateOfBirth、idType、idValue、nationality、address |
| JPY | firstName、lastName、dateOfBirth、idType、idValue、nationality、address、city、country |
| MYR | firstName、lastName、dateOfBirth、idType、idValue、nationality、address、country |
| CAD | firstName、lastName、dateOfBirth、idType、idValue、nationality、city、address、postalCode、country |
| KRW | firstName、lastName、dateOfBirth、idType、idValue、nationality、country |
| HKD | firstName、lastName、dateOfBirth、idType、idValue、nationality、country、city、address、zipCode |
Business Sender Object
| Parameter Code | Parameter Description | type | Required | remark |
|---|---|---|---|---|
| accountType | PERSONAL or 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 | |
| incorporationDate | Date of establishment of the enterprise | String | Y | |
| type | type 1: Cashless Retailers 2: Online Small Retailers 3: Restaurants, Cafes and Supermarkets 4: Importers/Exporters | String | N | |
| bankBranchCode | the branch code of the company's bank | String | N | |
| city | Enterprise city | String | N | |
| region | Location of the enterprise | String | N | |
| zipCode | Enterprise postal code | String | N | |
| structure | corporate structure 1: SP 2: Co. 3: Corp. 4: LP 5: LLP 6: LLC 7: Pte Ltd. 8: Public Ltd. | String | N | |
| remark | Include any additional comments or notes related to the transaction by the sender company | String | N |
Other Currency Special Required Fields
-
The required parameters above are for all currencies and will not be listed one by one in the table below
-
For currencies not listed in the table below, only the required parameters need to be filled in
| Currency | Required Fields |
|---|---|
| USD | payoutMethod = BANK_TRANSFER:city、region、zipCode、structure、incorporationDatepayoutMethod = BANK_TRANSFER_SWIFT:city |
| EUR | type、city、structure |
| GBP | city、zipCode |
| AUD | bankBranchCode、remark |
| JPY | city |
| CAD | city、zipCode |
| KRW | structure |
| HKD | city、zipCode |
Dynamic Beneficiary Method
The Dynamic Beneficiary Method requires different parameters based on the payout currency.
Currency: INR
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Default PERSONAL | Y |
| 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 |
The VPA field is mutually exclusive with the account name and ifsc fields; one must be selected to fill in.
Currency: VND
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Default PERSONAL | Y |
Personal:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| name | Account Name | String | Max: 128 | Y |
| accountNumber | bank card number | String | ^[a-zA-Z0-9]+$ | Y |
| napasCode | See VND Bank Info | String | napasCode or bankCode, one must be filled in | N |
| bankCode | See VND Bank Info | String | napasCode or bankCode, one must be filled in | N |
| address | address | String | N | |
| city | City. See VND City list | String | N | |
| firstName | first name | String | Y | |
| lastName | last name | String | Y |
Business:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| name | Account Name | String | Max: 128 | Y |
| accountNumber | bank card number | String | ^[a-zA-Z0-9]+$ | Y |
| napasCode | See VND Bank Info | String | napasCode or bankCode, one must be filled in | N |
| bankCode | See VND Bank Info | String | napasCode or bankCode, one must be filled in | N |
| address | address | String | N | |
| city | City. See VND City list | String | N |
Bank Info List: VND Bank Info
City: VND City list
Currency: PHP
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Default PERSONAL | Y |
| accountNumber | bank card number | String | Y | |
| bankCode | bank code: See Bank Code list | String | Y | |
| name | name | String | ^[a-zA-Z.\s]+$ | Y |
Napas Code List: PHP Bank Info
Currency: CNY
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Default PERSONAL | Y |
Personal:
Abandoned:The table below has deleted all lines (header and all data rows) from the original document. For historical reference only, please use the updated parameter table for new connections.
^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$ | ||||
^[A-Za-z0-9 .-]{1,18}$ | ||||
Delete parameters as old version parameters. For new connections, please use the following 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 | string | min:1 | max:50 | Y |
| bankAccountNumber | bank account number | String | string | min:1 | max:30 | Y |
| registrationNumber | the identification number of the receiver company | String | string | min:1 | max:50 | Y |
Currency: GBP
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Default PERSONAL | Y |
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 | ^\d{4}\-(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 | Default PERSONAL | Y |
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 | ^\d{4}\-(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 | Default PERSONAL | Y |
Personal — payoutMethod = BANK_TRANSFER:
| 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 | ^\d{4}\-(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:9,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 Southwest West Southeast Midwest | String | Y | |
| city | city | String | ^[A-Za-z .,-]+$ | Y |
| address | address | String | max:50 | Y |
| bankAccountType | 3: Saving 4: Current 5: Checking 6: Corporate | String | Y | |
| bankAccountNumber | bank account number | String | max:50 | Y |
Personal — payoutMethod = BANK_TRANSFER_SWIFT:
| 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 |
| address | the receiver's personal or residential details as applicable | String | max:100 | Y |
| bankAccountNumber | bank account number | String | max:50 | Y |
| bankCode | the SWIFT code of the receiver's bank | String | min:8 | max:11 | Y |
| bankName | the receiver bank name | String | max:100 | Y |
| country | the country where the receiver is located. See: Registration Country list | String | Y |
Nationality list: Usd Nationality
Business — payoutMethod = BANK_TRANSFER:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| name | legal name of the receiver company | String | Max:50 ^[A-Za-z0-9 .-]+$ | Y |
| phoneCountryCode | Mobile country code | String | Y | |
| mobileNumber | String | digits_between:9,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 | 3: Saving 4: Current 5: 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 Southwest West Southeast 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: Ltd. | String | Y |
Business — payoutMethod = BANK_TRANSFER_SWIFT:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| name | legal name of the receiver company | String | max:100 ^[A-Za-z0-9 .-]+$ | Y |
| address | address of the receiver company | String | max:100 | Y |
| bankAccountNumber | bank account number | String | max:50 | Y |
| bankCode | the SWIFT code of the receiver company's bank | String | min:8 | max:11 | Y |
| bankName | the receiver company's bank name | String | max:100 | Y |
| country | the country of transfer destination. See: Registration Country list | String | Y |
Registration Country list: USD Registration Country
Currency: AED
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Default PERSONAL | Y |
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 |
Currency: AUD
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Default PERSONAL | Y |
Personal:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| bankAccountNumber | bank account number | String | numeric | Y |
| address | address | String | Y | |
| bankState | Indicate the state associated with the receiver's bank account. enums: Australian Capital Territory / New South Wales / Western Australia / Victoria / Queensland / South Australia / Tasmania / Northern Territory | String | ||
| bankCity | Specify the city where the receiver's bank is located. See: AUD bank city | String | Y | |
| bankId | Specify the receiver's bank ID. See: AUD bank id | String | Y | |
| bankBranchCode | bank branch code | String | digits:6 | Y |
| dateOfBirth | date of birth | String | ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$ | Y |
| firstName | first name | String | Y | |
| lastName | last name | String | Y | |
| idType | 1: Passport 2: Identification Card 4: Others 5: Work Permit | String | Y | |
| idNumber | identification number | String | max:20 | alpha_num | Y |
Business:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| name | the legal name of the receiver company | String | Y | |
| registrationNumber | identification number of the receiver company | String | alpha_num | Y |
| bankAccountNumber | bank account number | String | numeric | Y |
| address | address of the receiver company | String | Y | |
| bankState | the state associated with the receiver company's bank account. enums: Australian Capital Territory / New South Wales / Western Australia / Victoria / Queensland / South Australia / Tasmania / Northern Territory | String | Y | |
| bankCity | the city of the receiver company's bank. See: AUD bank city | String | Y | |
| bankId | the ID of the bank where the receiver company holds an account. See: AUD bank id | String | Y | |
| bankBranchCode | the branch code of the company's bank | String | digits:6 | Y |
AUD bank city:
AUD-B2C-receiverBankCity.csvAUD bank id: AUD bank
Currency: THB
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Default PERSONAL | Y |
Personal:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| bankAccountNumber | bank account number | String | max:50 | Y |
| bankId | the receiver's bank ID. See: THB bank id | String | Y | |
| dateOfBirth | date of birth | String | ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$ | Y |
| firstName | first name | String | max:50 | regex:/^[A-Za-z0-9 .-]+$/ | Y |
| lastName | last name | String | max:50 | regex:/^[A-Za-z0-9 .-]+$/ | Y |
Business:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| name | the legal name of the receiver company | String | alpha_spaces | Y |
| bankId | the ID of the bank where the receiver company holds an account. See: THB bank id | String | Y | |
| bankAccountNumber | bank account number | String | Y |
THB bank id: THB Bank Id
Currency: MYR
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Default PERSONAL | Y |
Personal:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| bankAccountNumber | bank account number | String | Y | |
| bankId | the receiver's bank ID. See: MYR bank id | String | Y | |
| firstName | first name | String | max:60 | alpha_spaces | Y |
| lastName | last name | String | max:60 | alpha_spaces | Y |
Business:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| name | the legal name of the receiver company | String | alpha_spaces | Y |
| bankId | the ID of the bank where the receiver company holds an account. See: MYR bank id | String | Y | |
| bankAccountNumber | bank account number | String | Y |
MYR Bank Id: MYR Bank Id
Currency: CAD
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Default PERSONAL | Y |
Personal:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| bankAccountNumber | bank account number | String | max:50 | Y |
| address | address | String | max:100 | regex:/^[A-Za-z0-9 .,-]+$/ | Y |
| bankBranchCode | bank branch code | String | max:6 | Y |
| bankId | the receiver's bank ID. See: CAD bank id | String | Y | |
| city | the city where the receiver company is located | String | max:50 | Y |
| dateOfBirth | date of birth | String | ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$ | Y |
| firstName | first name | String | max:50 | regex:/^[A-Za-z0-9 .-]+$/ | Y |
| lastName | last name | String | max:50 | regex:/^[A-Za-z0-9 .-]+$/ | Y |
| phoneCountryCode | Mobile country code | String | +1 | Y |
| mobileNumber | String | Y | ||
| zipCode | the postal code or ZIP code where the receiver company is located | String | max:6 | Y |
Business:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| name | the legal name of the receiver company | String | alpha_spaces | Y |
| bankId | the ID of the bank where the receiver company holds an account. See: CAD bank id | String | Y | |
| bankAccountNumber | bank account number | String | Y | |
| address | String | Y | ||
| bankBranchCode | bank branch code | String | max:50 | Y |
| city | the city where the receiver company is located | String | max:100 | regex:/^[A-Za-z0-9 .,-]+$/ | Y |
| phoneCountryCode | Mobile country code | String | +1 | Y |
| mobileNumber | String | regex:/^[0-9]+$/ | Y | |
| zipCode | the postal code or ZIP code where the receiver company is located | String | min:3 | max:8 | Y |
CAD Bank Id: CAD Bank Id
Currency: JPY
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Default PERSONAL | Y |
Personal:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| bankAccountNumber | bank account number | String | max:50 | Y |
| address | String | max:100 | Y | |
| bankBranchCode | bank branch code | String | max:6 | Y |
| bankId | the receiver's bank ID. See: JPY Bank id | String | Y | |
| dateOfBirth | date of birth | String | ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$ | Y |
| firstName | first name | String | max:50 | regex:/^[A-Za-z0-9 .,-]+$/ | Y |
| lastName | last name | String | max:50 | regex:/^[A-Za-z0-9 .,-]+$/ | Y |
Business:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| name | the legal name of the receiver company | String | max:100 | regex:/^[A-Za-z0-9 .,-]+$/ | Y |
| address | String | Y | ||
| bankBranchCode | bank branch code | String | max:6 | Y |
| bankId | the receiver's bank ID. See: JPY Bank id | String | Y | |
| bankAccountNumber | bank account number | String | Y |
JPY Bank id: JPY Bank Id
Currency: KRW
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Default PERSONAL | Y |
Personal:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| bankAccountNumber | bank account number | String | digits_between:1,16 | Y |
| nationality | See: KRW Country | String | Y | |
| bankId | the receiver's bank ID. See: KRW Bank Id | String | Y | |
| dateOfBirth | date of birth | String | ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$ | Y |
| phoneCountryCode | Mobile country code | String | Y | |
| mobileNumber | String | Y | ||
| firstName | first name | String | max:50 | regex:/^[A-Za-z0-9 .-]+$/ | Y |
| lastName | last name | String | max:50 | regex:/^[A-Za-z0-9 .-]+$/ | Y |
| idType | 1: Passport 2: Identification Card | String | Y | |
| idNumber | identification number | String | alpha_num | Y |
Business:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| name | the legal name of the receiver company | String | max:50 | regex:/^[A-Za-z0-9 .-]+$/ | Y |
| country | See: KRW Country | Y | ||
| address | String | Y | ||
| bankBranchCode | bank branch code | String | max:6 | Y |
| bankId | the receiver's bank ID. See: KRW Bank Id | String | Y | |
| bankAccountNumber | bank account number | String | digits_between:1,16 | Y |
| structure | corporate structure 1: SP 2: Co. 3: Corp. 4: LP 5: LLP 6: LLC 7: Pte Ltd. 8: Public Ltd. | String | Y | |
| phoneCountryCode | Mobile country code | String | Y | |
| mobileNumber | String | Y | ||
| registrationNumber | identification number of the receiver company | String | alpha_num | Y |
KRW Bank id: KRW Bank Id — KRW Country: KRW Country
Currency: HKD
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| accountType | PERSONAL or BUSINESS | String | Y | Default PERSONAL |
Personal:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| firstName | receiver's first name | String | max:50 | regex:/^[A-Za-z0-9 .-]+$/ | Y |
| lastName | receiver's last name | String | max:50 | regex:/^[A-Za-z0-9 .-]+$/ | Y |
| dateOfBirth | date of birth | String | ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$ | Y |
| address | String | max:100 | Y | |
| bankId | the receiver's bank ID. See: HKD Bank Id | String | Y | |
| bankAccountNumber | bank account number | String | digits_between:1,16 | Y |
Business:
| Parameter Code | Parameter Description | type | verification | Required |
|---|---|---|---|---|
| name | the legal name of the receiver company | String | max:50 | regex:/^[A-Za-z0-9 .-]+$/ | Y |
| incorporationDate | date of a company's establishment | String | ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$ | Y |
| address | String | Y | ||
| bankId | the receiver's bank ID. See: HKD Bank Id | String | Y | |
| bankAccountNumber | bank account number | String | digits_between:1,16 | Y |
HKD Bank id: HKD Bank Id
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.