Request & response code description
Transfer statuas
Status | Description |
pending_material | Pending for the merchant to complete the upload certification materials |
awaiting_transfer | Pending for transfer. Only in this status can be transferred |
overrule | Due to incomplete materials, the order needs to be resubmitted |
pending | Submitted successfully, processing in xCurency Hubs |
transferring | Remittance in progress |
transferred | Remittance is transferred but don’t confirm user account has credited |
completed | Remittance is complete. User has received payment |
failed | Transfer fail, the Cross-Currency Transaction Mode will refund |
rejected | Sender's compliance information is not approved or for risk control reasons, etc. |
canceled | Payment cancelled |
refunded | Payment Refunded |
Support Docs Type Enums
Name | Description |
proforma_invoice | Proforma Invoice，PI |
purchase_order | Purchase Order，PO |
logistics_material | Logistics Proof |
export_declaration | Customs declaration or Export declaration
|
communication_record | Communication record |
beneficiary_id_card | Beneficiary Id Card |
beneficiary_power_attorney | Beneficiary power attorney from Company |
historical_transaction_material | Historical transaction proof |
proof_purchase | Proof of purchase |
other | Other |
Transaction Mode Difference
Original Currency
Flow
Name
Type
Required
Description
orderNo
string
256
Required
Merchant Order No
sourceAmount
float
32
Required
Source Amount
sourceCurrency
string
3
Required
Source Currency
targetAmount
float
32
Required
Target Amount
targetCurrency
string
3
Required
Target Currency
payer
object
Required
The Payer
payer → fullName
string
256
Required
Full Name, Must be a business
payer → accountNumber
string
256
Required
Bank Account Number, Must be a business account
payer → address
object
Required
Address
payer → address → country
string
2
Optional
The country where the payer is located.Country code of the user (ISO 3166-1 two-digit code, e.g. CN, US, JP)
payer → address → state
string
256
Optional
The state where the payer is located
payer → address → postCode
string
256
Optional
The postCode where the payer is located
payer → address → address
string
256
Required
The address where the payer is located;
beneficiary
object
Required
beneficiary → fullName
string
256
Required
Full Name, Must be a business
beneficiary → accountName
string
256
Required
Bank Account Number, It can be a business account or a personal account
beneficiary → accountNumber
string
256
Required
Bank Account Number
beneficiary → bankName
string
256
Required
Account bank, need to be specific to the branch
beneficiary → address
object
Required
beneficiary → address → country
string
2
Optional
The country where the beneficiary is located.Country code of the user (ISO 3166-1 two-digit code, e.g. CN, US, JP)
beneficiary → address → state
string
256
Optional
The state where the beneficiary is located
beneficiary → address → postCode
string
256
Optional
The postCode where the beneficiary is located
beneficiary → address → address
string
256
Required
The address where the beneficiary is located;
beneficiary → swiftCode
string
256
Required
Bank Swift Code
CNY Currency
Flow
- Beneficiary Account Type is a personal
Name
Type
Required
Description
orderNo
string
256
Required
Merchant Order No
sourceAmount
float
32
Required
Source Amount
sourceCurrency
string
3
Required
Source Currency
targetAmount
float
32
Required
Target Amount
targetCurrency
string
3
Required
Target Currency
paymentType
string
32
Required
Enum
- DepositPayment
- FullPayment
- FinalPayment
- Other
logisticsCompany
string
256
Conditional Required
Logistics company ;
When the targetCurrency is CNY and paymentType is fullPayment and FinalPayment, the field is required.
logisticsNumber
string
256
Conditional Required
Logistics Number ;
When the targetCurrency is CNY and paymentType is fullPayment and FinalPayment, the field is required.
payer
object
Required
The Payer
payer → fullName
string
256
Required
Full Name, Must be a business
payer → accountNumber
string
256
Optional
Bank Account Number, Must be a business account
payer → address
object
Optional
Address
payer → address → country
string
2
Optional
The country where the payer is located.Country code of the user (ISO 3166-1 two-digit code, e.g. CN, US, JP)
payer → address → state
string
256
Optional
The state where the payer is located
payer → address → postCode
string
256
Optional
The postCode where the payer is located
beneficiary
object
Required
beneficiary → fullName
string
256
Required
Full Name, Must be a business
beneficiary → accountName
string
256
Required
Bank Account Number, It can be a business account or a personal account
beneficiary → accountNumber
string
256
Required
Bank Account Number
beneficiary → idNumber
string
256
Required
Chinese mainland resident ID card；
beneficiary → address
object
Optional
beneficiary → address → country
string
2
Optional
The country where the beneficiary is located.Country code of the user (ISO 3166-1 two-digit code, e.g. CN, US, JP)
beneficiary → address → state
string
256
Optional
The state where the beneficiary is located
beneficiary → address → postCode
string
256
Optional
The postCode where the beneficiary is located
beneficiary → address →address
string
256
Optional
The address where the beneficiary is located
- Beneficiary Account Type is a business
Name
Type
Required
Description
orderNo
string
256
Required
Merchant Order No
sourceAmount
float
32
Required
Source Amount
sourceCurrency
string
3
Required
Source Currency
targetAmount
float
32
Required
Target Amount
targetCurrency
string
3
Required
Target Currency
paymentType
string
32
Required
Enum
- DepositPayment
- FullPayment
- FinalPayment
- Other
logisticsCompany
string
256
Conditional Required
Logistics company ;
When the targetCurrency is CNY and paymentType is fullPayment and FinalPayment, the field is required.
logisticsNumber
string
256
Conditional Required
Logistics Number ;
When the targetCurrency is CNY and paymentType is fullPayment and FinalPayment, the field is required.
payer
object
Required
The Payer
payer → fullName
string
256
Required
Full Name, Must be a business
payer → accountNumber
string
256
Optional
Bank Account Number, Must be a business account
payer → address
object
Optional
Address
payer → address → country
string
2
Optional
The country where the payer is located.Country code of the user (ISO 3166-1 two-digit code, e.g. CN, US, JP)
payer → address → state
string
256
Optional
The state where the payer is located
payer → address → postCode
string
256
Optional
The postCode where the payer is located
beneficiary
object
Required
beneficiary → fullName
string
256
Required
Full Name, Must be a business
beneficiary → accountName
string
256
Required
Bank Account Number, It can be a business account or a personal account
beneficiary → accountNumber
string
256
Required
Bank Account Number
beneficiary → bankName
string
256
Required
Account bank, need to be specific to the branch；
beneficiary → address
object
Optional
beneficiary → address → country
string
2
Optional
The country where the beneficiary is located.Country code of the user (ISO 3166-1 two-digit code, e.g. CN, US, JP)
beneficiary → address → state
string
256
Optional
The state where the beneficiary is located
beneficiary → address → postCode
string
256
Optional
The postCode where the beneficiary is located
beneficiary → address →address
string
256
Optional
The address where the beneficiary is located
beneficiary → companyNumber
string
256
Conditional Required
Company incorporation number, Unified Social Credit Identifier; When accountName is a business account, the field is required.
Cross Currency
Name
Type
Required
Description
orderNo
string
256
Required
Merchant Order No
sourceAmount
float
32
Required
Source Amount
sourceCurrency
string
3
Required
Source Currency
targetAmount
float
32
Required
Target Amount
targetCurrency
string
3
Required
Target Currency
paymentType
string
32
Required
Enum
- DepositPayment
- FullPayment
- FinalPayment
- Other
logisticsCompany
string
256
Conditional Required
Logistics company ;
When the targetCurrency is CNY and paymentType is fullPayment and FinalPayment, the field is required.
logisticsNumber
string
256
Conditional Required
Logistics Number ;
When the targetCurrency is CNY and paymentType is fullPayment and FinalPayment, the field is required.
payer
object
Required
The Payer
payer → fullName
string
256
Required
Full Name, Must be a business
payer → accountNumber
string
256
Optional
Bank Account Number, Must be a business account
payer → address
object
Optional
Address
payer → address → country
string
2
Optional
The country where the payer is located.Country code of the user (ISO 3166-1 two-digit code, e.g. CN, US, JP)
payer → address → state
string
256
Optional
The state where the payer is located
payer → address → postCode
string
256
Optional
The postCode where the payer is located
beneficiary
object
Required
beneficiary → fullName
string
256
Required
Full Name, Must be a business
beneficiary → accountName
string
256
Required
Bank Account Number, It can be a business account or a personal account
beneficiary → accountNumber
string
256
Required
Bank Account Number
beneficiary → bankName
string
256
Conditional Required
Account bank, need to be specific to the branch；
When accountName is a business account, the field is required.
beneficiary → idNumber
string
256
Conditional Required
Chinese mainland resident ID card；
When accountName is a personal account, the field is required.
beneficiary → address
object
Optional
beneficiary → address → country
string
2
Optional
The country where the beneficiary is located.Country code of the user (ISO 3166-1 two-digit code, e.g. CN, US, JP)
beneficiary → address → state
string
256
Optional
The state where the beneficiary is located
beneficiary → address → postCode
string
256
Optional
The postCode where the beneficiary is located
beneficiary → address →address
string
256
Optional
The address where the beneficiary is located
beneficiary → companyNumber
string
256
Optional
Company incorporation number, Unified Social Credit Identifier; When accountName is a business account, the field is required.