Skip to main content
PUT
Respond to a PIX Automatico authorization

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

idRecorrencia
string
required

The recurrence id (29-char, RR...).

Example:

"RR0435879820240605njua7shf40o"

Query Parameters

ispb
string

The ISPB of the direct participant this request acts for. OPTIONAL: omit it and the request is answered exactly as before. Named, the recurrence row this write addresses has to be booked in that participant's books, or the answer is 404 PIX-0147 and nothing is sent to JDPI or changed. An ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply, never a credential, and a token confined to one participant has to name it here. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9]{8}$
Example:

"12345678"

Body

application/json
accountType
integer<int64>
required

tpContaPagador (0..3).

Example:

0

payerName
string
required

Payer name (nomePagador). Blank is 400 PIX-0061.

Example:

"Fulano de Tal"

result
boolean
required

resultadoAutorizacao (true=accept, false=reject).

Example:

true

authorizedAt
string

Authorization timestamp (dtHrAutorizacaoRecorrencia, an RFC 3339 date-time). Required when result=true, so a retry resends the same value for JD to replay the response; omitted, blank or not a date-time on an acceptance is 400 PIX-0061. Not sent on a rejection.

Example:

"2024-01-06T10:00:00.000Z"

ibgeCode
integer<int64>

Municipality IBGE code (codMunIbge; required when accepting).

Example:

3550308

payerMaxAmount
integer<int64>

Payer max cap in centavos (vlrMaxPagador).

Example:

200000

rejectionReason
string

Rejection reason (AP13/AP14/AP15). Required when result=false; omitted or blank there is 400 PIX-0061.

Example:

"AP13"

Response

Accepted

recurrenceId
string
required

The recurrence id.

Example:

"RR0435879820240605njua7shf40o"

requestedAt
string
required

JDPI request timestamp (dtHrReqJdPi, UTC).

Example:

"2024-01-06T10:00:01Z"

idReqJdPi
string

The JDPI request id (36-char GUID; omitted by 4.3.10).

Example:

"52c43361-caa1-4ddb-9152-708426a25db3"

status
string

The resulting local authorization status.

Example:

"Accepted"