Pular para o conteúdo principal
GET
Get a Pix Automático Charge

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Account-Id
string<uuid>
obrigatório

Account ID (UUID format)

Parâmetros de caminho

id
string<uuid>
obrigatório

Charge ID (UUID format)

Resposta

OK

accountId
string
obrigatório
Exemplo:

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

amount
string
obrigatório
Exemplo:

"29.90"

attemptCount
integer<int64>
obrigatório
Exemplo:

1

attempts
object[]
obrigatório
authorizationRequestId
string
obrigatório
Exemplo:

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

createdAt
string<date-time>
obrigatório
dueDate
string<date>
obrigatório
Exemplo:

"2026-04-25"

externalChargeId
string
obrigatório
Exemplo:

"90d0b9e1551447f695985409bf9b7fb5"

id
string
obrigatório
Exemplo:

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

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

"J4"

maxAttempts
integer<int64>
obrigatório
Exemplo:

4

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

"SCHEDULED"

updatedAt
string<date-time>
obrigatório
authorizationId
string
Exemplo:

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

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

0

currentScheduleId
string
Exemplo:

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

executedAt
string<date-time>
failedAt
string<date-time>
failureCode
string
Exemplo:

"CHARGE_REJECTED"

recurrenceId
string
Exemplo:

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