Pular para o conteúdo principal
POST
/
api
/
oxxo
/
cash-in
Criar cobrança OXXO (cash-in)
curl --request POST \
  --url https://sandbox.ntxpay.com/api/oxxo/cash-in \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amountCentavos": 20000,
  "customerName": "Juan Perez",
  "customerTaxId": "PEPJ800101ABC",
  "externalId": "order-xyz-789"
}
'
{
  "id": 33333,
  "status": "PENDING",
  "barcode": "012345678901234567",
  "referenceNumerical": "12345-67890",
  "checkoutUrl": "https://pay.ntxpay.com/oxxo/abc",
  "expiresAt": "2026-05-20T23:59:59.000Z",
  "amountCentavos": 20000
}

Autorizações

Authorization
string
header
obrigatório

JWT obtido em POST /api/auth/token

Corpo

application/json
amountCentavos
integer
obrigatório
Intervalo obrigatório: x >= 1
Exemplo:

20000

customerName
string
obrigatório
Required string length: 3 - 255
Exemplo:

"Juan Perez"

customerTaxId
string

RFC/CURP (opcional)

Required string length: 10 - 20
Exemplo:

"PEPJ800101ABC"

externalId
string
Required string length: 1 - 100
Exemplo:

"order-xyz-789"

Resposta

Cobrança OXXO criada (PENDING)

id
integer
Exemplo:

33333

status
enum<string>
Opções disponíveis:
PENDING,
CONFIRMED,
EXPIRED
Exemplo:

"PENDING"

barcode
string | null

Código de barras OXXO para pagamento no caixa

Exemplo:

"012345678901234567"

referenceNumerical
string | null

Referência numérica OXXO

Exemplo:

"12345-67890"

checkoutUrl
string<uri> | null

URL do cupom imprimível

Exemplo:

"https://pay.ntxpay.com/oxxo/abc"

expiresAt
string<date-time> | null
Exemplo:

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

amountCentavos
integer
Exemplo:

20000