Payout API — SPEI OUT Transfer
Overview
Sends an SPEI transfer to a beneficiary CLABE account.
API Info
- Endpoint:
POST /api/mx/payout - Method: POST
- Content-Type: application/json
Request Headers
See API Signature: Content-Type、MerchantId、Timestamp、Nonce、Signature.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| merchantOrderId | String(≤32) | Y | Merchant order ID, globally unique (idempotency key) |
| amount | BigDecimal(2dp) | Y | Payout amount, > 0, MXN |
| currency | string | Y | Fixed MXN |
| accountType | string | Y | Fixed CLABE (maps to channel idTipoCtaDestino=40) |
| bankCode | string | Y | EIYU bank catalog IdBanco (e.g. "90659"); at least one of bankId/bankCode |
| bankId | Long | N | Platform bank ID (alternative to bankCode) |
| payeeName | String(≤128) | Y | Beneficiary name |
| payeeAccountNo | string | Y | Beneficiary CLABE (18 digits) |
| payeeIdType | string | Y | Beneficiary ID type |
| payeeIdCard | String(≤50) | Y | Beneficiary RFC (13 chars) |
| payeeMobile | String(≤36) | Y | Beneficiary mobile |
| payeeEmail | string | Y | Beneficiary email |
Request Example
json
{
"merchantOrderId": "MO20260813002",
"amount": "50.00",
"currency": "MXN",
"accountType": "CLABE",
"bankCode": "90659",
"payeeName": "BENEFICIARIO",
"payeeAccountNo": "659794001000000041",
"payeeIdType": "RFC",
"payeeIdCard": "LETJ960811XXX",
"payeeMobile": "5551234567",
"payeeEmail": "payee@example.com"
}Response Parameters (data)
| Parameter | Type | Description |
|---|---|---|
| orderId | string | Platform order ID |
| merchantOrderId | string | Merchant order ID |
| orderStatus | string | PENDING / SUCCESS / FAILED |
| amount | BigDecimal | Payout amount |
| currency | string | MXN |
| fee | BigDecimal | Fee |
| errorCode | string | Error code (on failure) |
| errorMsg | string | Error description (on failure) |
| createDatetime | string | Create time |
| completionDatetime | string | Completion time |
