Skip to main content
GET
Obtener un cobro de Pix Automático

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Encabezados

X-Account-Id
string
requerido

Identificador único de la cuenta del Ledger de Midaz (formato UUID).

Parámetros de ruta

id
string
requerido

ID del cobro (formato UUID)

Respuesta

OK

accountId
string
Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

amount
string
Ejemplo:

"29.90"

attemptCount
integer
Ejemplo:

1

attempts
object[]
authorizationId
string
Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

authorizationRequestId
string
Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

cancelledAt
string<date-time>
createdAt
string<date-time>
currentDayIndex
integer
Ejemplo:

0

currentScheduleId
string
Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

dueDate
string<date>
Ejemplo:

"2026-04-25"

executedAt
string<date-time>
externalChargeId
string
Ejemplo:

"90d0b9e1551447f695985409bf9b7fb5"

failedAt
string<date-time>
failureCode
string

FailureCode es el código genérico que preserva la privacidad, reportado al receptor para el resultado actual del cobro (p. ej. CHARGE_REJECTED, OVER_LIMIT, ACCEPTED, DEBIT_FAILED). Es el ÚNICO código expuesto en la API de lectura y en el payload saliente; el motivo financiero interno nunca se incluye aquí.

Ejemplo:

"CHARGE_REJECTED"

id
string
Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

journey
enum<string>
Opciones disponibles:
J1,
J2,
J3,
J4
Ejemplo:

"J4"

maxAttempts
integer
Ejemplo:

4

recurrenceId
string
Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

status
enum<string>
Opciones disponibles:
RECEIVED,
SCHEDULED,
EXECUTED,
FAILED,
CANCELLED
Ejemplo:

"SCHEDULED"

updatedAt
string<date-time>