Skip to main content
GET
Get one authorization

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

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

Non-zero UUID of the payer account selected by the calling PSP. The PSP must authorize its end user for that account before calling this API. A resource outside the selected account returns 404; a read with no records returns an empty page. See the API overview for the complete trust boundary.

Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$

Parâmetros de caminho

authorization_id
string
obrigatório

Internal identifier of the mandate, in ANY lifecycle state. A mandate under a different X-Account-Id is answered 404, not 403, so the caller cannot confirm that a resource exists elsewhere.

Exemplo:

"01a044a8-f3bd-7488-a0dc-e8d4be4802be"

Resposta

The authorization.

authorizedAt
string<date-time>
obrigatório

When the mandate was granted.

Exemplo:

"2026-08-27T19:18:38Z"

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

"2026-08-27T19:18:38Z"

id
string
obrigatório

Internal identifier of the mandate.

Exemplo:

"01a044a8-f3bd-7488-a0dc-e8d4be4802be"

journey
enum<string>
obrigatório

Journey that granted the mandate.

Opções disponíveis:
JOURNEY_1,
JOURNEY_2,
JOURNEY_3,
JOURNEY_4
Exemplo:

"JOURNEY_1"

parameters
object
obrigatório
recurrenceId
string
obrigatório

BACEN idRec of the recurrence it covers.

Exemplo:

"RR12345678202608276bca619e690"

status
enum<string>
obrigatório

Lifecycle status of the mandate. AWAITING_CONCLUSION means the payer granted it and the receiving PSP has not yet concluded the process — it is NOT active at BACEN (Manual de Tempos do Pix v7.0 §3.2).

Opções disponíveis:
AWAITING_CONCLUSION,
APPROVED,
REJECTED,
EXPIRED,
CANCELLED
Exemplo:

"APPROVED"

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

"2026-08-27T20:00:00Z"

terminatedAt
string<date-time>

When the mandate ENDED — the instant it became REJECTED, EXPIRED or CANCELLED. Absent while it has not ended, which covers an APPROVED mandate and an AWAITING_CONCLUSION one alike: absence means the mandate has not ended, never that it is active.

Exemplo:

"2026-08-27T20:00:00Z"