Introdução
Por meio dos endpoints apresentados nesta sessão, o parceiro integrador pode solicitar o agendamento de transações do
tipo pix. Com esta funcionalidade será possível criar, listar e cancelar agendamentos de uma determinada conta.
- A data de agendamento leva em consideração o horário de Brasília (BRT ou UTC/GMT -03:00)
- As transações serão tentadas a partir de 8h BRT
- Transações que tenham falhado por falta de saldo serão retentadas em 1 hora com um limite de 3 tentativas
- Para transaçôes do tipo key, static_qr_code e dynamic_qr_code, antes de a transação ser completada, será
realizada uma nova verificação da chave Pix para garantir que a conta destino não foi alterada. Caso seja detectada
alguma discrepância, o agendamento será rejeitado (rejected)
- Um webhook será enviado ao parceiro integrador informando o sucesso ou rejeição de um agendamento
- Não é possível agendar um dynamic_qr_code instantâneo
- Transferencias por agendamento consomem limite de transação pix
| Enumerador | Descrição |
|---|
| scheduled | Transação agendada |
| sent | Agendamento concluído e enviado com sucesso. Estado final |
| rejected | Agendamento rejeitado durante criação ou execução. Estado final |
| cancelled | Agendamento cancelado por solicitação de cliente. Estado final |
| pending_2fa_approval | Pendente de aprovação por autenticação de dois fatores |
| pending_creation | Agendamento em processo de criação (Estado transitório para agendamento em lote) |
| waiting_batch_approval | Agendamento criado e vinculado a um lote aguardando aprovação por autenticação de dois fatores |
No dia do agendamento, após a realização da verificação de consistência da conta alvo, será tentada a transação pix.
Neste momento é gerada uma pix_transfer e esta será adicionada à lista de schedule_transfers. Serão tentadas um
máximo 3 transações pix.
| Campo | Tipo | Descrição | Caracteres |
|---|
pix_transfer_key | uuidv4 | Chave única de identificação da transferência Pix no sistema QI. | 36 |
end_to_end_id * | string | Chave de idempotência de uma transação Pix dentro do SPI (Sistema de Pagamento Instantâneo) | 32 |
pix_transfer_status | string | Status da transação. | Enumeradores pix_transfer_status |
created_at | string | Data e hora de criação da transação. | 20 |
| Enumerador | Descrição |
|---|
| sent | Transação enviada com sucesso. Estado final |
| rejected | Transação rejeitada durante execução. Estado final |
| pending | Transação pendente de conclusão. Estado Transitório |