Payout

Create a Mexico payout order to transfer funds to the recipient account.

POST/api/v2/payout/create

Use this endpoint to submit a payout order and receive the initial platform acceptance result.

Request Headers

x-access-keystringRequired

Merchant access identifier

signaturestringRequired

Request signature

Request Parameters

timestampstringRequired

Millisecond timestamp string, for example 1715941383720

merchantOrderNostringRequired

Unique identifier. Recommended format: YYYYMMDDHHMMSS + random number

orderAmountstringRequired

Payment amount

customerNamestringRequired

Recipient name

customerEmailstringRequired

Recipient email

customerPhonestringRequired

Recipient mobile number

accountTypestringRequired

Recipient account type: DEBITCARD or CLABE

bankAccountNamestringRequired

Bank code from the supported bank list. Real verification is required

bankAccountNostringRequired

Recipient debit card number or CLABE. Real verification is required

callbackUrlstringRequired

Async callback URL

Response Parameters

messagestringReturned

Request result. success only means the current API call succeeded and should not be used as the final business result

codestringReturned

Business status code. 00000 means the request was accepted. Other 5-digit values indicate specific error reasons; refer to the error code page

timestampstringReturned

Transaction timestamp

successbooleanReturned

API call result

dataobjectReturned

Response object

data.platformOrderNostringReturned

Unique platform order number

data.orderStatusstringReturned

Order status. SUCCESS means success, PENDING means processing, FAILED means failure, EXPIRED means expired, CANCELLED means cancelled, and REFUNDED means refunded

data.messagestringReturned

Status description message