Skip to content

China Payout

Prefix: /api/v1/merchant. Auth: Signature.

Create payout

POST /api/v1/merchant/payout/create

FieldRequiredNotes
merchantOrderNoyesUnique
countryCodeyesCN
currencyyesCNY
amountyesBeneficiary amount (CNY)
receiverNameyesMust match bank account name
receiverAccountyesBank card number
receiverBankNameyesFull bank name
receiverBankCoderecommendedCNAPS / bank code
receiverPhoneno
notifyUrlnoFalls back to callbackUrl
metadatanoe.g. { "branch": "..." }

Freezes netAmount = amount + fee. payoutMethod is BANK_TRANSFER.

Query payout

GET /api/v1/merchant/payout/query?orderNo= or ?merchantOrderNo=

Webhook (completed)

Full checklist: Webhook guide.

POST JSON with signed headers. Body includes "orderType": "payout", "status": "completed", countryCode: "CN", currency: "CNY".

Respond 200 + OK. No webhook on cancelled / failed.

Statuses: created, market_available, processing, completed, failed, cancelled.

Released under the MIT License.

2-1-2 Nihonbashi-Hongokucho,Chuo-ku,Tokyo