Payouts
Create Payout Examples
NGN to CNY Bank Transfer (Company)

CNY Payout – BANK TRANSFER (BUSINESS)

This guide explains how to initiate CNY payouts via bank transfer to business accounts using the meCash API. Requests must be sent as multipart/form-data with a stringified JSON payload under the transaction field.


Endpoint

POST {{baseURL}}/v1/payout


Header

HeaderValueRequired
x-api-keyYOUR_API_KEY✅ Yes

Example Request (Business Bank Transfer)

curl --location 'https://{{baseURL}}/v1/payout' \
--header 'x-api-key: YOUR_API_KEY_HERE' \
--form 'transaction="{
  \"recipient\": {
    \"name\": \"sad sada\",
    \"firstName\": \"王\",
    \"lastName\": \"坤\",
    \"idType\": \"ID_CARD\",
    \"idNumber\": \"91510104MA6A3FYD7B\",
    \"mobileNumber\": \"+123 456789\",
    \"city\": \"NEW YORK CITY\",
    \"address\": \"usa\",
    \"countryName\": \"US\",
    \"relationship\": \"SELF\",
    \"type\": \"BUSINESS\",
    \"invoiceNo\": \"12345613\",
    \"account\": {
      \"name\": \"北京华海潮商贸有限责任公司\",
      \"accountNumber\": \"6222040000030016\",
      \"type\": \"COMPANY\",
      \"sortCode\": \"003\",
      \"bankName\": \"STANDARD CHARTERED BANK (HONG KONG) LIMITED\"
    },
    \"paymentChannel\": \"BANK_TRANSFER\",
    \"currency\": \"CNY\",
    \"country\": \"CN\",
    \"stored\": false
  },
  \"quoteId\": \"{{quoteIdCny}}\",
  \"transactionPin\": \"123456\",
  \"remark\": \"Testing\",
  \"reason\": \"Gift\"
"}'

Success Response (200 OK)

{
    "message": "transaction created successfully",
    "status": "success",
    "data": {
        "id": "cb9c1def-ed41-44db-9e9e-xxxxxxxxxxxxx",
        "remark": "Testing",
        "reason": "Gift",
        "referenceNumber": "OK0JPSRYFNFVF",
        "type": "SEND",
        "state": "PROCESSING",
        "quote": {
            "id": "1813914b-6ddd-498d-89a6-b947bf9e59cd",
            "source": {
                "currency": "NGN",
                "country": "NG",
                "amount": 3000.00
            },
            "target": {
                "currency": "CNY",
                "country": "CN",
                "amount": 12.93
            },
            "rate": 232.00000000,
            "fee": {
                "amount": 5.00
            },
            "summary": {
                "total": 3005.00
            },
            "expiresInSeconds": 0
        },
        "recipient": {
            "name": "sad sada",
            "firstName": "王",
            "lastName": "坤",
            "idType": "ID_CARD",
            "idNumber": "91510104MA6A3FYD7B",
            "mobileNumber": "+123 456789",
            "city": "NEW YORK CITY",
            "address": "usa",
            "countryName": "US",
            "relationship": "SELF",
            "type": "BUSINESS",
            "invoiceNo": "12345613",
            "account": {
                "name": "北京华海潮商贸有限责任公司",
                "accountNumber": "6222040000030016",
                "type": "COMPANY",
                "sortCode": "003",
                "bankName": "STANDARD CHARTERED BANK (HONG KONG) LIMITED"
            },
            "paymentChannel": "BANK_TRANSFER",
            "currency": "CNY",
            "country": "CN"
        },
        "created": "2025-05-19T21:13:20.527698839",
        "processed": "2025-05-19T21:13:20.527698839"
    }
}

Response Breakdown

General Information

FieldTypeDescription
messageStringTransaction status message
statusStringOperation status (success/error)

Transaction Data

FieldTypeDescription
idStringUnique transaction ID
remarkStringInternal reference note
reasonStringTransaction purpose
referenceNumberStringTracking reference
typeStringAlways SEND
stateStringCurrent status
createdStringISO 8601 creation time
processedStringISO 8601 processing time

Business Recipient Details

FieldTypeDescription
recipient.idTypeStringID type (ID_CARD)
recipient.idNumberStringGovernment ID number
recipient.mobileNumberStringContact number
recipient.cityStringBusiness location
recipient.addressStringPhysical address
recipient.countryNameStringCountry of operation
recipient.invoiceNoStringBusiness invoice reference

Corporate Account Details

FieldTypeDescription
account.nameStringRegistered company name
account.accountNumberStringCorporate account number
account.typeStringCOMPANY
account.sortCodeStringBank branch code
account.bankNameStringRecipient bank name

Error Handling

Status CodeMeaningExample ResponseHow to Handle
400Invalid Bank DetailsInvalid sort code for bankVerify bank routing information
400ID Validation FailedInvalid business registration IDCheck government-issued ID
400Invalid Transaction PINInvalid transaction authorizationVerify 6-digit PIN
400Business Info MismatchAccount name mismatch with registrationEnsure names match official records