Skip to main content
GET
Consultar cancelamento 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...).

idCancelamento
string
obrigatório

O id do cancelamento (29 caracteres, IC...).

Resposta

OK

cancelStatus
integer<int64>
obrigatório

stCancelamento (0=Aceito, 1=Rejeitado; -1 ausente).

idCancelamento
string
obrigatório

O id do cancelamento (IC...).

idRecorrencia
string
obrigatório

O id da recorrência.

payer
object
obrigatório
reason
integer<int64>
obrigatório

motivoCancelamento (0..10).

recipient
object
obrigatório
requesterDocument
string
obrigatório

CPF/CNPJ do solicitante (string).

requesterType
integer<int64>
obrigatório

tpPessoaSol.

cancelledAt
string

Data/hora do cancelamento (UTC).

errorCode
string

Código de erro do upstream.

errorDesc
string

Descrição de erro do upstream.

situationAt
string

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