Criar cobrança SPEI (cash-in)

curl --request POST \ --url https://sandbox.ntxpay.com/api/spei/cash-in \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "amountCentavos": 50000, "externalId": "order-abc-123", "description": "Pedido #123", "customerName": "Juan Perez", "customerEmail": "juan@example.com", "customerTaxId": "PEPJ800101ABC", "amount": "500.00", "payer_name": "Juan Perez", "conciliationId": "order_abc_123" } '

{ "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, "conciliationId": "order_abc_123" }

Autorizaciones

Authorization

string

header

requerido

JWT obtido em POST /api/auth/token

Cuerpo

application/json

amountCentavos

integer

Valor em centavos MXN (mín. 1). Use ESTE campo OU amount (mutuamente exclusivos).

Rango requerido: x >= 1

Ejemplo:

50000

externalId

string

Identificador externo (idempotência)

Required string length: 1 - 100

Ejemplo:

"order-abc-123"

description

string

Required string length: 1 - 255

Ejemplo:

"Pedido #123"

customerName

string

Nome do pagador

Required string length: 1 - 255

Ejemplo:

"Juan Perez"

customerEmail

string<email>

Ejemplo:

"juan@example.com"

customerTaxId

string

RFC/CURP do pagador

Required string length: 10 - 20

Ejemplo:

"PEPJ800101ABC"

amount

string

Alias Voluti — valor como string "100.00". Convertido para centavos. Não usar junto com amountCentavos.

Pattern: ^\d+\.\d{2}$

Ejemplo:

"500.00"

payer_name

string

Alias Voluti de customerName. Nome do pagador.

Maximum string length: 255

Ejemplo:

"Juan Perez"

conciliationId

string

Alias Voluti de externalId. Aceita apenas letras, dígitos e underscore.

Maximum string length: 100

Pattern: ^[a-zA-Z0-9_]+$

Ejemplo:

"order_abc_123"

Respuesta

Cobrança SPEI criada (PENDING)

integer

Ejemplo:

12345

status

enum<string>

Opciones disponibles:

PENDING,

CONFIRMED,

FAILED,

EXPIRED

Ejemplo:

"PENDING"

destinationClabe

string

CLABE descartável de destino para o pagador transferir

Ejemplo:

"012180001234567890"

beneficiary

object

Show child attributes

referenceNumerical

string | null

Ejemplo:

"1234567"

checkoutUrl

string<uri> | null

Ejemplo:

"https://pay.ntxpay.com/checkout/xyz"

expiresAt

string<date-time> | null

Ejemplo:

"2026-05-14T23:59:59.000Z"

amountCentavos

integer

Ejemplo:

50000

conciliationId

string | null

Alias Voluti — espelha externalId recebido na requisição (presente quando enviado).

Ejemplo:

"order_abc_123"