Initiate CNY Payout

Changed on

This API lets you make payouts to China using CNY or CNH currencies.

post/disbursements/payouts

Request

Request body

sourceCurrency'USDT' | 'GHS' | 'KES' | 'UGX' | 'TZS' | 'USD' | 'EUR' | 'GBP' | 'ZMW' | 'ZAR' | 'USDC' | 'CNGN' | 'NGN' | 'XAF' | 'XOF' required

The currency which is used to fund the payout

destinationCurrency'CNY' | 'CNH' required

The currency in which the recipient will be receiving funds

amountnumber required

The value that is to be transferred from the source currency wallet.

businessstring required

Your unique business ID

descriptionstring

The description of the payout

customerReferencestring required

The transaction's unique identifier on your system. Customer references prevent duplicate transactions.

paymentDestination'bank_account' required

Payment destination type

paymentScheme'cnaps' | 'swift' required

The payment scheme relevant to the destination currency payment network. "cnaps" supports only CNY, while "swift" supports CNY and CNH.

quoteReferencestring

This is the reference generated for FX quote. Required for cross-currency payouts (e.g. NGN→CNY); optional only when source and destination currency match.

feeBearer'business'
purposeOfFund'goods_trade' | 'services_trade' | 'payment_for_services' | 'professional_services' | 'information_services' | 'transportation_services' | 'software_purchase' | 'construction_services' | 'employee_payroll' required

Reason for payment

filesstring[] required

Supporting document URLs for the payment.

relationshipWithBeneficiary'self' | 'parents' | 'child' | 'siblings' | 'other_relatives' | 'spouse' | 'ex_spouse' | 'vendor' | 'supplier' | 'employee' | 'friends' | 'business_partner' | 'customer' | 'agent' | 'creditor' | 'debtor' | 'subsidiary_company' | 'branch_office' | 'holding_company' | 'franchisee' required

Relationship type between sender and beneficiary

Response

200

successboolean required
messagestring

Example response

{
  "success": true,
  "message": "Payout processed successfully",
  "data": {
    "id": 1254,
    "reference": "5dcf24700a9a4f67",
    "customerReference": "TXT-001",
    "status": "processing"
  }
}

Changes