Skip to main content
POST
Solicitar envio de agendamento 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).

Corpo

application/json
dueDate
string
obrigatório

Data de vencimento (dtVencimento; aaaa-mm-dd).

endToEndId
string
obrigatório

Id único de transação de pagamento (chave natural de 32 caracteres).

idRecorrencia
string
obrigatório

Id da recorrência vinculando a autorização (29 caracteres, RR...).

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

finalidadeAgendamento (0=primeiro, 1=retentativa pós-vencimento, 2=reenvio por erro de liquidação).

recipient
object
obrigatório
reconciliationId
string
obrigatório

Id de conciliação do recebedor (idConciliacaoRecebedor; 26..35 caracteres).

amount
number<double>

Valor agendado em reais (valor).

debtor
object
infoBetweenClients
string

Informação em texto livre do recebedor para o pagador (infEntreClientes).

recipientReceivedAt
string

Data/hora de recepção do PSP recebedor (dtHrRecepcaoPspRecebedor, UTC; obrigatório quando purpose=0).

Resposta

Aceito

endToEndId
string
obrigatório

O id da transação de pagamento (ecoado).

idRecorrencia
string
obrigatório

O id da recorrência (ecoado).

reconciliationId
string
obrigatório

O id de conciliação do recebedor (ecoado).

requestedAt
string
obrigatório

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

status
string
obrigatório

O status local resultante do agendamento.