API Flow
Order Information
Global Payout Create Order Table
Name
Type
Required
Description
orderNo
string
256
Required
Merchant Unique Order No
lockRate
boolean
Required
queryNo
string
256
Required
purpose
string
256
Required
Purpose of remittance
Enum:
- Salary
- Family Support
- Payroll
- Goods
- Service
- Tuition
- Insurance
- Travel
- Rent
- Living
Go here to see the detailed description of the purpose code.
sourceAmount
float
256
Required
sourceCurrency
string
3
Required
targetAmount
float
256
Required
targetCurrency
string
3
Required
beneficiary
object
Conditional Required
Details for the beneficiary . If beneficiaryId provided then beneficiary should be empty
beneficiary → accountInfo
object
Required
Beneficiary Account Info
beneficiary → accountInfo → name
string
256
Required
Account Name
beneficiary → accountInfo → bankName
string
256
Required
Account Bank Name
beneficiary → accountInfo → currency
string
3
Required
Account Currency
beneficiary → accountInfo → number
string
256
Required
Account Number
beneficiary → accountInfo → address
string
256
Optional
Account Address
beneficiary → accountInfo → routingType
string
256
Conditional Required
- Enum
- bsb
- swift
- sort
- ifsc
- aba
beneficiary → accountInfo → routingValue
string
256
Conditional Required
When the routingType is not empty
beneficiary → entityType
string
1
Required
I : Individual
B: Business
beneficiary → nationality
string
2
Required
Nationality (ISO 3166-1 two-digit code, e.g. CN, US, JP)
beneficiary → phoneCode
string
10
Optional
beneficiary → phoneNumber
string
256
Optional
beneficiary → email
string
256
Optional
beneficiary → address
object
beneficiary → address → state
string
256
Optional
beneficiary → address →city
string
256
Required
beneficiary → address → address
string
256
Required
beneficiary → address → street
string
256
Optional
beneficiary → address → postCode
string
256
Optional
beneficiary → address → country
string
2
Required
Country of Address (ISO 3166-1 two-digit code, e.g. CN, US, JP)
beneficiaryId
string
256
Conditional Required
If you know the id of your beneficiary in advance, then you can submit all the information instead
payer
object
Conditional Required
Details for the payer . If payerId provided then payer should be empty
payer→ firstName
string
256
Required
payer → lastName
string
256
Required
payer → nationality
string
2
Required
Nationality (ISO 3166-1 two-digit code, e.g. CN, US, JP)
payer → phoneNumber
string
256
Optional
payer → phoneCode
string
10
Optional
payer → email
string
256
Optional
payer → idNumber
string
256
Required
Certificate number
payer → idType
string
256
Required
- Enum
- idcard
- passport
- driver
- residence
- workpermit
- other
payer → gender
string
10
Conditional Required
- Enum
- Male
- FeMale
payer → entityType
string
1
Required
I : Individual
B: Business
payer → dob
string
10
Required
Date of Birth (Format YYYY-MM-DD)
payer → reference
string
32
Optional
Reference from payer to beneficiary
payer → address
object
Required
payer → address → state
string
256
Optional
payer → address → city
string
256
Optional
payer → address → street
string
256
Optional
payer → address → postCode
string
256
Optional
payer → address → address
string
256
Required
Full residential address
payer → address → country
string
2
Required
Country of Address (ISO 3166-1 two-digit code, e.g. CN, US, JP)
payerId
string
256
Conditional Required
If you know the id of your payer in advance, then you can submit all the information instead