Skip to main content
POST
Confirmar 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...).

Corpo

application/json
contractNumber
string
obrigatório

Identificador de contrato/pedido (nrContrato).

frequency
integer<int64>
obrigatório

tpFrequencia (0..4).

journey
integer<int64>
obrigatório

jornada (2..4).

payer
object
obrigatório
recipient
object
obrigatório
startDate
string
obrigatório

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

amount
number<double>

Valor fixo de pagamento em reais (valor).

authorizedAt
string

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

contractDesc
string

Descrição de contrato em texto livre.

createdDateTime
string

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

debtor
object
endDate
string

Data do último pagamento (dtFinalRecorrencia).

floorMaxAmount
number<double>

Piso do recebedor em reais (pisoValorMaximo).

payerMaxAmount
number<double>

Teto máximo do pagador em reais (vlrMaxPagador).

settlementConfirmedAt
string

Data/hora de confirmação da liquidação (dtHrConfirmacaoLiquidacao, UTC; obrigatório para jornada=3).

Resposta

Aceito

idRecorrencia
string
obrigatório

O id da recorrência.

requestedAt
string
obrigatório

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

idReqJdPi
string

O id da requisição upstream (GUID de 36 caracteres; omitido pela 4.3.10).

status
string

O status local resultante da autorização.