Skip to main content
GET
Obter uma cobrança do Pix Automático

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Account-Id
string
obrigatório

Identificador único da Conta do Ledger Midaz (formato UUID).

Parâmetros de caminho

id
string
obrigatório

ID da cobrança (formato UUID)

Resposta

OK

accountId
string
Exemplo:

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

amount
string
Exemplo:

"29.90"

attemptCount
integer
Exemplo:

1

attempts
object[]
authorizationId
string
Exemplo:

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

authorizationRequestId
string
Exemplo:

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

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

0

currentScheduleId
string
Exemplo:

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

dueDate
string<date>
Exemplo:

"2026-04-25"

executedAt
string<date-time>
externalChargeId
string
Exemplo:

"90d0b9e1551447f695985409bf9b7fb5"

failedAt
string<date-time>
failureCode
string

FailureCode é o código genérico que preserva a privacidade reportado ao recebedor para o resultado atual da cobrança (por exemplo, CHARGE_REJECTED, OVER_LIMIT, ACCEPTED, DEBIT_FAILED). É o ÚNICO código exposto na API de leitura e no payload de saída — o motivo financeiro nunca é transmitido aqui.

Exemplo:

"CHARGE_REJECTED"

id
string
Exemplo:

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

journey
enum<string>
Opções disponíveis:
J1,
J2,
J3,
J4
Exemplo:

"J4"

maxAttempts
integer
Exemplo:

4

recurrenceId
string
Exemplo:

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

status
enum<string>
Opções disponíveis:
RECEIVED,
SCHEDULED,
EXECUTED,
FAILED,
CANCELLED
Exemplo:

"SCHEDULED"

updatedAt
string<date-time>