Skip to main content
This endpoint allows you to process payouts in Chinese Yuan (CNY) to recipients with a bank account in China.

​
Endpoint

POST: {{baseURL}}/v2/payout

​
Supported Payment Channels

CNY payouts support the following payment channel:
ChannelDescriptionUse Case
BANK_TRANSFERStandard bank transfer to a Chinese bank accountBusiness/Personal transfers

​
Request Details

​
Headers

Include these headers in your request:
HeaderValueRequired
Content-Typeapplication/jsonβœ… Yes
x-api-keyYOUR_API_KEYβœ… Yes

​
Sample Requests

Use BANK_TRANSFER for payouts to Chinese bank accounts.
curl --location --request POST '{{baseURL}}/v2/payout' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "recipient": {
        "name": "张少杰",
        "nickName": "{{$randomColor}}",
        "occupation": "HEALTHCARE",
        "icNumber": "130132198812201310",
        "relationship": "SELF",
        "type": "BUSINESS",
        "account": {
            "accountNumber": "6217000130064754343",
            "sortCode": "01026",
            "bankName": "BAOSHANG BANK (εŒ…ε•†ι“Άθ‘Œ)",
            "bankCity": "SHENZHEN"
        },
        "companyName": "ιΎ™ε£εΈ‚ηŽ‰ζ°δΊ”ι‡‘ε·₯ε…·ζœ‰ι™ε…¬εΈ",
        "companyIdNumber": "91370681MABU8HLY6N",
        "gender": "F",
        "nationality": "CN",
        "itemCategory": "PRD0003",
        "itemType": "Pipe Wrench",
        "quantity": 100,
        "paymentChannel": "BANK_TRANSFER",
        "currency": "CNY",
        "country": "CN",
        "stored": false
    },
    "quoteId": "91e58c2d-ef14-4777-906b-xxxxxxxxxxxxx",
    "reason": "Gift",
    "remark": "Testing"
}'

​
Request Body Breakdown

FieldTypeDescriptionRequired
quoteIdStringThe unique ID of the quote for this payout.βœ… Yes
reasonStringThe purpose of the transfer.βœ… Yes
recipientObjectAn object containing all details about the person receiving the funds.βœ… Yes
recipient.nameStringThe full name of the recipient or business.βœ… Yes
recipient.nickNameStringRecipient nickname.❌ No
recipient.occupationStringRecipient occupation.❌ No
recipient.icNumberStringRecipient identity card number.❌ No
recipient.relationshipStringRelationship with the recipient.❌ No
recipient.typeStringThe type of recipient. Enum: INDIVIDUAL, BUSINESS.βœ… Yes
recipient.paymentChannelStringThe payment method. Use BANK_TRANSFER.βœ… Yes
recipient.currencyStringThe ISO currency code. Must be CNY.βœ… Yes
recipient.countryStringThe recipient’s two-letter ISO country code. Must be CN.βœ… Yes
recipient.accountObjectAn object containing the recipient’s bank account details.βœ… Yes
recipient.account.accountNumberStringThe recipient’s bank account number.βœ… Yes
recipient.account.sortCodeStringBank code / Sort code.❌ No
recipient.account.bankNameStringThe name of the recipient’s bank.βœ… Yes
recipient.account.bankCityStringCity of the bank.❌ No
recipient.companyNameStringCompany name (required if type is BUSINESS).❌ No
recipient.companyIdNumberStringCompany identification number (required if type is BUSINESS).❌ No
recipient.genderStringGender of the recipient (M or F).❌ No
recipient.nationalityStringNationality of the recipient (e.g., CN).❌ No
recipient.itemCategoryStringCategory of items (e.g., PRD0003).❌ No
recipient.itemTypeStringType of item (e.g., Pipe Wrench).❌ No
recipient.quantityNumberQuantity of items.❌ No

​
Success Response (200 OK)

If the payout is successfully created, the API returns the following response:
copy
{
  "message": "Transaction created successfully",
  "status": "success",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-xxxxxxxxxxxxx",
    "invoice": "4b9b6d30-a2ed-421a-bd69-11536344f071",
    "reason": "Payment for goods",
    "referenceNumber": "TXYZD6RWSQMKF",
    "type": "SEND",
    "state": "COMPLETED",
    "quote": {
      "id": "859b19e8-8a00-4d59-9970-xxxxxxxxxxxxx",
      "source": {
        "currency": "NGN",
        "country": "NG",
        "amount": 230000
      },
      "target": {
        "currency": "CNY",
        "country": "CN",
        "amount": 1000
      },
      "rate": 230,
      "fee": {
        "amount": 100
      }
    },
    "recipient": {
      "name": "张少杰",
      "nickName": "Green",
      "occupation": "HEALTHCARE",
      "icNumber": "130132198812201310",
      "relationship": "SELF",
      "type": "BUSINESS",
      "account": {
          "accountNumber": "6217000130064754343",
          "sortCode": "01026",
          "bankName": "BAOSHANG BANK (εŒ…ε•†ι“Άθ‘Œ)",
          "bankCity": "SHENZHEN"
      },
      "companyName": "ιΎ™ε£εΈ‚ηŽ‰ζ°δΊ”ι‡‘ε·₯ε…·ζœ‰ι™ε…¬εΈ",
      "companyIdNumber": "91370681MABU8HLY6N",
      "gender": "F",
      "nationality": "CN",
      "itemCategory": "PRD0003",
      "itemType": "Pipe Wrench",
      "quantity": 100,
      "paymentChannel": "BANK_TRANSFER",
      "currency": "CNY",
      "country": "CN"
    },
    "created": "2025-02-27T14:17:48.038044Z",
    "processed": "2025-02-27T14:20:49.712685Z"
  }
}

​
Response Breakdown

FieldTypeDescription
messageStringA confirmation message indicating the result of the request.
statusStringThe overall status of the request.
dataObjectA container for all the transaction data.
data.idStringThe unique identifier for this payout transaction.
data.stateStringThe current state of the payout (COMPLETED, PENDING, etc.).
data.quote.source.currencyStringThe three-letter currency code of the source funds.
data.quote.target.amountNumberThe converted amount that the recipient received.

​
Best Practices

βœ… Ensure quoteId is valid and linked to an existing quote.
βœ… Confirm that the recipient’s account number is correct for the destination bank.
βœ… Use recipient.country: "CN" and recipient.currency: "CNY".