Pular para o conteúdo principal

Visão Geral

O cash-in SPEI gera uma CLABE descartável que o pagador usa para fazer uma transferência SPEI pelo app do banco. Quando a NTX Pay recebe a liquidação, a transação passa para CONFIRMED e dispara o webhook cash_in. Características:
  • CLABE válida para uma única transferência (uso único)
  • Confirmação assíncrona (segundos a minutos)
  • Expira em data configurável (padrão ~24 horas)

Endpoint

POST /api/spei/cash-in

Headers

Authorization: Bearer {token}
Content-Type: application/json

Request

curl -X POST https://sandbox.mx.ntxpay.com/api/spei/cash-in \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amountCentavos": 50000,
    "externalId": "order-abc-123",
    "description": "Order #123",
    "customerName": "Juan Perez",
    "customerEmail": "juan@example.com",
    "customerTaxId": "PEPJ800101ABC"
  }'

Response (201)

{
  "id": 12345,
  "status": "PENDING",
  "destinationClabe": "012180001234567890",
  "beneficiary": {
    "name": "NTX Pay MX",
    "taxId": "NTX800101ABC"
  },
  "referenceNumerical": "1234567",
  "checkoutUrl": "https://pay.ntxpay.com/checkout/xyz",
  "expiresAt": "2026-05-14T23:59:59.000Z",
  "amountCentavos": 50000
}

Campos do Request

amountCentavos
integer
obrigatório
Valor em centavos MXN (mínimo 1). Ex.: 50000 = $500,00 MXN.
externalId
string
Identificador externo único (até 100 caracteres). Use para correlacionar com o seu sistema. Recomendado para idempotência.
description
string
Descrição da cobrança (até 255 caracteres).
customerName
string
obrigatório
Nome do pagador (1–255 caracteres), exibido no checkout SPEI.
customerEmail
string
obrigatório
E-mail do pagador (formato de e-mail válido).
customerTaxId
string
RFC/CURP do pagador (10–20 caracteres).

Fluxo de Pagamento

Estados da Transação

StatusSignificado
PENDINGCLABE emitida, aguardando transferência
CONFIRMEDTransferência recebida e liquidada
FAILEDErro de processamento
EXPIREDCLABE expirou sem receber transferência

Idempotência

Reenvie a mesma requisição com o mesmo externalId para garantir que uma falha de rede não gere duas cobranças. Em caso de duplicação, a NTX Pay retorna a cobrança existente.

Próximos Passos

Webhook cash_in

Detalhes do payload do webhook de confirmação

SPEI Cash-Out

Envie transferências SPEI