Skip to main content
POST
Receber evento de registro de autorização do lado do pagador 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).

Cabeçalhos

Authorization
string

Token de acesso Bearer (o portão de entrada financeira; o handler falha de forma fechada com Pix-0082 quando ausente).

X-DataHoraEvento
string
obrigatório

Instante de registro do evento (UTC: aaaa-mm-ddTHH:mm:ss.sssZ). Obrigatório conforme

X-NomeEvento
string
obrigatório

Nome do evento. Obrigatório conforme; passthrough informativo.

Corpo

application/json
dtHrCriacaoRecorrencia
string
obrigatório

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

dtHrCriacaoSolicitacao
string
obrigatório

Data/hora de criação da solicitação (UTC).

dtHrExpiracaoSolicitacao
string
obrigatório

Data/hora de expiração da solicitação (UTC).

dtInicialRecorrencia
string
obrigatório

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

idRecorrencia
string
obrigatório

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

idReqJdPi
string
obrigatório

Id da requisição upstream (GUID de 36 caracteres).

jornada
integer<int64>
obrigatório

Jornada de autorização (1 apenas na gênese do PSP Pagador).

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

idSolicitacaoRecorrencia
string

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

pisoValorMaximo
number<double>

Piso do recebedor em reais (um número JSON).

valor
number<double>

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

Resposta

Sem Conteúdo