Skip to main content
GET
Consultar situação de autorização de Pix Automático

Autorizações

Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Parâmetros de caminho

idRecorrencia
string
obrigatório

O id da recorrência (29 caracteres, RR...).

Parâmetros de consulta

idReqJdPi
string

O id da requisição upstream (GUID) fallback quando a consulta por idRecorrencia dá 404.

Resposta

OK

authorizationGiven
boolean
obrigatório

resultadoAutorizacao.

debtor
object
obrigatório
frequency
integer<int64>
obrigatório

tpFrequencia (0..4).

idRecorrencia
string
obrigatório

O id da recorrência.

localStatus
string
obrigatório

AuthorizationStatus local projetado a partir da situação do upstream.

localStatusKnown
boolean
obrigatório

False quando a situação do upstream não carrega status local projetado.

payer
object
obrigatório
recipient
object
obrigatório
stJdPi
integer<int64>
obrigatório

Situação geral do upstream (-1/0/9/10).

stJdPiProc
integer<int64>
obrigatório

Situação intermediária do upstream (0..10).

startDate
string
obrigatório

Data do primeiro pagamento (aaaa-mm-dd).

amount
number<double>

Valor fixo de pagamento em reais.

authorizedAt
string

Data/hora da autorização (UTC).

cancellations
object[] | null

Histórico de cancelamentos (cancelamentos).

contractDesc
string

Descrição de contrato em texto livre.

contractNumber
string

Identificador de contrato/pedido (nrContrato).

endDate
string

Data do último pagamento (aaaa-mm-dd).

floorMaxAmount
number<double>

Piso do recebedor em reais.

idReqJdPi
string

O id da requisição upstream (GUID).

idSolicitacao
string

O id da solicitação (29 caracteres, IS...).

journey
integer<int64>

jornada (1..4).

payerMaxAmount
number<double>

Teto máximo do pagador em reais.

requestedAt
string

Data/hora da requisição upstream (UTC).

retry
integer<int64>

retentativa (0/1).

situationAt
string

Data/hora da situação (dtHrSituacao, UTC).

updatedAt
string

Data/hora da última atualização (UTC).