Skip to main content
POST
Validar autorização de Pix Automático de entrada

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).

Corpo

application/json
dtHrCriacaoRecorrencia
string
obrigatório

Data/hora de criação da recorrência (UTC).

dtInicialRecorrencia
string
obrigatório

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

idRecorrencia
string
obrigatório

Id único de recorrência (29 caracteres, RR...).

jornada
integer<int64>
obrigatório

Jornada de autorização (1..4).

nrContrato
string
obrigatório

Identificador de contrato/pedido (35 caracteres).

pagador
object
obrigatório
recebedor
object
obrigatório
retentativa
integer<int64>
obrigatório

Política de retentativa (0=nenhuma, 1=até 3 em 7 dias).

tpFrequencia
integer<int64>
obrigatório

Periodicidade da recorrência (0..4).

descContrato
string

Descrição de contrato em texto livre (35 caracteres).

devedor
object
dtFinalRecorrencia
string

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

dtHrAutorizacaoRecorrencia
string

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

idSolicitacaoRecorrencia
string

Id da solicitação de confirmação (29 caracteres, IS...).

motivoRejeicao
string

Código de motivo de rejeição (4 caracteres; obrigatório quando resultadoAutorizacao=false).

resultadoAutorizacao
boolean

Resultado da análise do pagador (true=Aceita, false=Rejeitada).

valor
number<double>

Valor fixo de pagamento em reais (um número JSON).

Resposta

OK

dtHrValidacao
string
obrigatório

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

motivoRejeicao
string

Código de motivo de rejeição (obrigatório quando resultado=0).

resultado
integer<int64>

Resultado da validação (0=Invalido, 1=Valido); omitido no reconhecimento assíncrono 202.