Payout

Developing

POST

/gateway/base/biz

beneficiaryAccountNumber: Beneficiary account number: CLABE number or bank account number.

paymentType: SPEI or NET_BANKING. When it is SPEI, beneficiaryAccountNumber must be a CLABE number; when it is NET_BANKING, beneficiaryAccountNumber should be filled with the bank card number.

For Mexico payouts, the bank will default to a successful callback. If the account is abnormal or incorrect, the payout order will change from SUCCESS status to REVERSED status.

Request

Header Params

Body Params application/json

Example

{
    "mchOrderId": "string",
    "amount": "string",
    "currency": "string",
    "purpose": "string",
    "beneficiaryName": "string",
    "beneficiaryEmail": "string",
    "beneficiaryMobile": "string",
    "beneficiaryAccountNumber": "string",
    "callbackUrl": "string",
    "beneficiaryBankCode": "37006",
    "paymentType": "SPEI"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/gateway/base/biz' \
--header 'method: payOut' \
--header 'signType: SHA512' \
--header 'serviceName: api.pay' \
--header 'mchId: 1416010331032883200' \
--header 'timestamp: 1631671670' \
--header 'sign: 32554324534545432543' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mchOrderId": "string",
    "amount": "string",
    "currency": "string",
    "purpose": "string",
    "beneficiaryName": "string",
    "beneficiaryEmail": "string",
    "beneficiaryMobile": "string",
    "beneficiaryAccountNumber": "string",
    "callbackUrl": "string",
    "beneficiaryBankCode": "37006",
    "paymentType": "SPEI"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "resultCode": "string",
    "errorCode": "string",
    "errorMsg": "string",
    "data": [
        {
            "orderId": "string"
        }
    ]
}

Modified at 2025-12-05 12:56:10

Payment