CNY Payout – BANK TRANSFER (CUSTOMER)

This guide explains how to initiate CNY payouts to customer accounts via bank transfer 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
HeaderValueRequired
x-api-keyYOUR_API_KEY✅ Yes

Example Request (Customer Bank Transfer)

    Request Breakdown


    Headers

    HeaderValue ExampleDescription
    x-api-keyAPI_KEYAPI authentication key

    Form Data Parameters

    ParameterTypeDescription
    transactionJSONStringified JSON transaction payload

    Transaction Object

    FieldTypeDescription
    quoteIdStringQuote ID from FX pricing
    transactionPinString6-digit security PIN
    remarkStringInternal reference note
    reasonStringTransaction purpose

    Recipient Object (Business)

    FieldTypeDescription
    nameStringLegal business name
    firstNameStringContact first name
    idTypeStringID type (ID_CARD)
    idNumberStringGovernment-issued ID
    mobileNumberStringContact number with country code
    relationshipStringRecipient relationship (EMPLOYEE)
    typeStringEntity type (BUSINESS)
    invoiceNoStringBusiness invoice reference (optional)
    paymentChannelStringPayment method (BANK_TRANSFER)
    currencyStringTransaction currency (CNY)
    countryStringCountry code (CN)
    storedBooleanSave recipient details

    Account Object

    FieldTypeDescription
    nameStringAccount holder name
    accountNumberStringCorporate bank account number
    typeStringAccount type (INDIVIDUAL)

    Success Response (200 OK)

    Returns a JSON response confirming the transaction was processed successfully.
    {
      "message": "Payout initiated successfully",
      "status": "success",
      "data": {
        "transactionId": "txn_1234567890abcdef",
        "quoteId": "qte_0987654321fedcba",
        "status": "PENDING",
        "created": "2025-05-20T12:00:00.000Z"
      }
    }
    

    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