Skip to main content
POST
Register a PIX Automatico authorization validation

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"

Body

application/json
result
integer<int64>
required

resultado (0=Invalido, 1=Valido).

Example:

1

validatedAt
string<date-time>
required

Validation timestamp (dtHrValidacao, an RFC 3339 date-time). No row stores it, so a retry must resend the same value for JD to replay the reply.

Pattern: \S
Example:

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

ispb
string

The ISPB of the direct participant this reply is sent AS. It is ROUTING DATA you supply and guarantee - never a credential, never read from a header or a path, and it never widens what your token can reach. It is IGNORED when this deployment holds the authorization: a recorded mandate already names the direct participant whose books it lives in, and that is authoritative. It DECIDES when it does not - on jornada 3 the inbound 5.2.1 that obliges this reply writes no local row, so nothing but this field can say which of several participants is answering Bacen. OPTIONAL while this deployment acts as a single direct participant: omit it and that one replies. REQUIRED once it acts as several and no local row exists - omitted is 422 PIX-0127, and an ISPB this deployment does not act as is 422 PIX-0128. Sending one that contradicts a recorded authorization is 400 PIX-0061. Send it as an absent key, not an empty string; an empty value is refused 400 PIX-0061.

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

"12345678"

rejectionReason
string

Rejection reason (motivoRejeicao; the exact 4.3.10 domain: AP01, AP02, AP04, AP05, AP06, AP07, AP08, AP11, AP12, CH16; required when result=0).

Example:

"AP01"

Response

Accepted

idRecorrencia
string
required
deprecated

Deprecated: read recurrenceId, which carries the same value. The recurrence id.

Example:

"RR0435879820240605njua7shf40o"

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"