About the Legacy APIs

We are transitioning to a unified Payout interface that will support all transaction scenarios and simplify access through a single platform. Therefore, the following interfaces will gradually not be updated.

China Payout For Personal API China Payout For Business API

Expand your business to China with our one-click, all-in-one payout API

Upgrade to our new all-in-one API with just a one-click path change, simplifying your expansion into China through a single, powerful interface that scales effortlessly with your business growth.

API	Category	Payout Scene	Legacy API Path	All-in-one payout API Path
Transfer Create	Order Manager	C2C	/payout/payment/create	/global/payout/transfer/create
Async confirm transfer	Order Manager	C2C	/payout/payment/transfer/async	/global/payout/transfer/create/aysnc
~~Confirm Transfer~~ ( Have been abandoned，pls use Async confirm transfer)	Order Manager	C2C	/payout/payment/transfer	-
Cancel transfer	Order Manager	C2C	/payout/payment/cancel	-
Get a transfer status	Order Manager	C2C	/payout/payment/status	/global/payout/transfer/query/status
Update Info	Order Manager	C2C	/payout/payment/update	/global/payout/transfer/update
Transfer Create	Order Manager	B2B	/payout/payment/business/transfer/create	/global/payout/transfer/create
Upload File By Multipart	Order Manager	B2B	/payout/payment/business/transfer/upload/multipart	/global/payout/transfer/upload/multipart
Upload Completed	Order Manager	B2B	/payout/payment/business/transfer/upload/completed	/global/payout//transfer/upload/completed
Query a transfer status	Order Manager	common	/payout/payment/business/transfer/status	/global/payout/transfer/query/status
Get a rate	Rate Manager	common	/payout/payment/business/query/rate	/global/payout/rate/query/price
Balance for single currency	Balance	common	/payout/wallet/get	-
Balance list	Balance	common	/payout/wallet/list	-

Fields comparison

Global Payout Create Order Table (1)

Global Payout Field

China Payout Field

Type

Description

orderNo

string

256

Merchant Unique Order No

lockRate

boolean

queryNo

string

256

purpose

string

256

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.

subpurpose

string

256

Sub Purpose of remittance 1. when the purpose is Goods: - CLOTHES_BAGS_SHOES_CLOTHES - DAILY_SUPPLIES_AND_COSMETICS - ELECTRONICS_AND_HOME_APPLIANCES - TOYS_KIDS_BABIES 2. when the purpose is Service: - INTERPRETATION_SERVICE - TRANSLATION_SERVICE - HUMAN_RESOURCE_SERVICE - ESTATE_AGENCY_SERVICE - SOFTWARE_DEVELOPMENT_SERVICE - WEB_DESIGN_OR_DEVELOPMENT_SERVICE - DRAFTING_LEGAL_SERVICE - LEGAL_RELATED_CERTIFICATION_SERVICE - ACCOUNTING_SERVICE TAX_SERVICE - ARCHITECTURAL_DECORATION_DESIGN_SERVICE - ADVERTISING_SERVICE MARKET_RESEARCH_SERVICE - EXHIBITION_BOOTH_SERVICE - OTHER_SERVICE

fundsSource

fundsSource

string

256

Source of funds Enum - Business income - Employment income - Part-time income - Saving deposits

relationship

string

256

The relationship with payer and beneficiary

sourceAmount

float

256

sourceCurrency

string

targetAmount

float

256

targetCurrency

string

beneficiary

object

Details for the beneficiary . If beneficiaryId provided then beneficiary should be empty

beneficiary → fullName

string

256

beneficiary → firstName

string

256

beneficiary → lastName

string

256

beneficiary → accountInfo

object

Beneficiary Account Info

beneficiary → accountType

string

- bank - alipay - wechat

beneficiary → accountInfo → name

beneficiary → accountName

string

256

Account Name

beneficiary → accountInfo → bankName

string

256

Account Bank Name

beneficiary → accountInfo → currency

string

Account Currency

beneficiary → accountInfo → number

beneficiary → accountNumber

string

256

Account Number

beneficiary → accountInfo → address

string

256

Account Address

beneficiary → accountInfo → routingType

string

256

- Enum - bsb - swift - sort - ifsc - aba - alipay - wechat

beneficiary → accountInfo → routingValue

string

256

When the routingType is not empty

beneficiary → entityType

string

I : Individual B: Business

beneficiary → idNumber

string

256

Certificate number

beneficiary → idType

string

256

- Enum - idcard - passport - driver - residence - workpermit - other

beneficiary → nationality

string

Nationality (ISO 3166-1 two-digit code, e.g. CN, US, JP)

beneficiary → phoneCode

beneficiary → iddCode

string

beneficiary → phoneNumber

beneficiary → phone

string

256

beneficiary → email

string

256

beneficiay → gender

beneficiary → sex

string

required once the entityType is Individual - Enum - Male - FeMale

beneficiary → address

object

beneficiary → address → state

string

256

beneficiary → address →city

string

256

beneficiary → address → address

string

256

beneficiary → address → street

string

256

beneficiary → address → postCode

string

256

beneficiary → address → country

string

Country of Address (ISO 3166-1 two-digit code, e.g. CN, US, JP)

beneficiary → address → district

beneficiary → address → district

string

256

beneficiary → occupation

string

256

beneficiary → idIssueDate

string

256

Certificate Issue Date (format YYYY-MM-DD)

beneficiary → idExpiryDate

string

256

Certificate Deadline (Format YYYY-MM-DD)

beneficiaryId

string

256

If you know the id of your beneficiary in advance, then you can submit all the information instead

payer

object

Details for the payer . If payerId provided then payer should be empty

payer→ firstName

string

256

payer → lastName

string

256

payer → fullName

string

256

payer → nationality

string

Nationality (ISO 3166-1 two-digit code, e.g. CN, US, JP)

payer → phoneNumber

payer → phone

string

256

payer → phoneCode

payer → iddCode

string

payer → email

string

256

payer → idNumber

string

256

Certificate number

payer → idType

string

256

- Enum - idcard - passport - driver - residence - workpermit - other

payer → idCountry

string

Country of Certificate (ISO 3166-1 two-digit code, e.g. CN, US, JP)

payer → idIssueDate

string

256

Certificate Issue Date (format YYYY-MM-DD)

payer → idExpiryDate

string

256

Certificate Deadline (Format YYYY-MM-DD)

payer → gender

payer → sex

string

- Enum - Male - FeMale

payer → entityType

string

I : Individual B: Business

payer → dob

string

Date of Birth (Format YYYY-MM-DD)

payer → reference

string

Reference from payer to beneficiary

payer → address

object

payer → address → state

string

256

payer → address → city

string

256

payer → address → street

string

256

payer → address → postCode

string

256

payer → address → address

string

256

Full residential address

payer → address → country

string

Country of Address (ISO 3166-1 two-digit code, e.g. CN, US, JP)

payer → accountInfo

object

payer → accountInfo → number

beneficiary → accountNumber

string

256

payer → accountInfo → bankName

string

256

payer → occupation

string

256

payerId

string

256

If you know the id of your payer in advance, then you can submit all the information instead

logisticsCompany

string

256

logisticsNumber

string

256

paymentType

string

Enum - DepositPayment - FullPayment - FinalPayment

transactionMode

string

256

Enum - classic - xpress - walletMode - cnyMode - originalMode - crossMode