Skip to content

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 ​

ParameterTypeRequiredDescription
merchantOrderIdString(≤32)YMerchant order ID, globally unique (idempotency key)
amountBigDecimal(2dp)YPayout amount, > 0, MXN
currencystringYFixed MXN
accountTypestringYFixed CLABE (maps to channel idTipoCtaDestino=40)
bankCodestringYEIYU bank catalog IdBanco (e.g. "90659"); at least one of bankId/bankCode
bankIdLongNPlatform bank ID (alternative to bankCode)
payeeNameString(≤128)YBeneficiary name
payeeAccountNostringYBeneficiary CLABE (18 digits)
payeeIdTypestringYBeneficiary ID type
payeeIdCardString(≤50)YBeneficiary RFC (13 chars)
payeeMobileString(≤36)YBeneficiary mobile
payeeEmailstringYBeneficiary 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) ​

ParameterTypeDescription
orderIdstringPlatform order ID
merchantOrderIdstringMerchant order ID
orderStatusstringPENDING / SUCCESS / FAILED
amountBigDecimalPayout amount
currencystringMXN
feeBigDecimalFee
errorCodestringError code (on failure)
errorMsgstringError description (on failure)
createDatetimestringCreate time
completionDatetimestringCompletion time

Released under the MIT License.