Consult a Pix Automático authorization situation
Consults the live upstream situation of a recurring-payment authorization, projecting the upstream situation axes onto the local authorization status.
Authorizations
JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint
using client credentials (clientId and clientSecret).
Include token in Authorization header:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Token expires after 3600 seconds (1 hour).
Path Parameters
The recurrence id (29-char, RR...).
Query Parameters
The upstream request id (GUID) fallback when the idRecorrencia consult 404s.
Response
OK
resultadoAutorizacao.
tpFrequencia (0..4).
The recurrence id.
Local AuthorizationStatus projected from the upstream situation.
False when the upstream situation carries no projected local status.
Upstream overall situation (-1/0/9/10).
Upstream intermediate situation (0..10).
First payment date (aaaa-mm-dd).
Fixed payment amount in reais.
Authorization timestamp (UTC).
Cancellation history (cancelamentos).
Free-text contract description.
Contract/order identifier (nrContrato).
Last payment date (aaaa-mm-dd).
Receiver floor in reais.
The upstream request id (GUID).
The solicitation id (29-char, IS...).
jornada (1..4).
Payer max cap in reais.
Upstream request timestamp (UTC).
retentativa (0/1).
Situation timestamp (dtHrSituacao, UTC).
Last-update timestamp (UTC).

