Create Withdrawal Order (Mexico)

Request URL: /gateway/api/v2/payouts
Method: POST
Content-Type: application/json;charset=utf-8

API for creating Mexican Peso (MXN) withdrawal orders, supporting 18-digit CLABE and 16-digit bank accounts.

Request Information

Parameter	Required	Type	Description
platform_id	Yes	String(6)	Merchant ID
service_id	Yes	String(7)	Service ID, fixed value `SVC0004`
payout_cl_id	Yes	String(64)	Merchant Order ID
amount	Yes	Integer(10)	Amount (in cents, centavos)
notify_url	No	String(256)	Callback URL for transaction results
bank_name	Yes	String(45)	Bank code, or the bank's English name (case-insensitive), Bank List
name	Yes	String(64)	Beneficiary name
number	Yes	String(64)	Beneficiary account: 18-digit CLABE or 16-digit bank account, digits only
currency	Yes	String(3)	Fixed value: mxn
request_time	Yes	Integer(10)	Request time (seconds)
sign_type	No	String(16)	Signature type, fixed value `HMAC-SHA256`
sign	Yes	String(32\|64)	Order Signature

{
  "error_code": "0000",
  "data": { "payout_id": "POT00000001" }
}

Important

In case of a timeout or HTTP 500 error, rely on the order query interface for the status; do not treat it as a failed order.

Transaction amount is in Mexican Peso (cents, centavos), please multiply by 100 before sending
bank_name must be a code or English bank name listed in the Mexico Bank List
number format:
- 18-digit CLABE: 18 digits, and must pass the CLABE check digit validation
- 16-digit bank account: 16 digits
- Spaces, hyphens or other characters are not allowed; any other length is rejected
If the beneficiary details fail validation, the error is returned at creation time and no order is created: 0002 (Invalid request parameters) when bank_name is missing, name is empty, or number is empty or malformed (including a wrong CLABE check digit); 0012 (Bank not found) when bank_name is not in the bank list
"0000" only means the API call succeeded; call the query interface to confirm the result