Notificar Agendamento

O cliente deve construir esta API do lado deles para que consigamos fazer a confirmação que recebeu o webhook

Notificar sobre a confirmação do agendamento via API.

post

Body

endToEndIdstring · max: 32Required

Identificador Único da transação de pagamento. Deve ser gerado pelo PSP Recebedor, será utilizado em toda a cadeia de mensagens da instrução de pagamento. *Regra de preenchimento: O PSP Recebedor deverá, no que tange a composição do “endToEndId” utilizar a data para qual o Pix está sendo agendado e horário fixo 15H:00 UTC, que dará para o PSP Pagador a janela de efetivação de 00:00 e 23:59 do horário de Brasília.

Example: E00038166202409171500y6j6mt9l0pi

idConciliacaoRecebedorstring · min: 26 · max: 35Required

Identificador único para Conciliação do Recebedor. Este identificador deverá ser o mesmo utilizado na ordem de pagamento contida na pacs.008, gerada para efetivação do pagamento agendado. Deve conter entre 26 e 35 caracteres alfanuméricos ([a-z|A-Z|0-9])

Example: AB123456789012345678901234567890

idRecorrenciastringRequired

dentificador único da recorrência para os pagamentos periódicos

Example: RR0435879820240605njua7shf40o

dtHrRecepcaoPspRecebedorstringRequired

Data e horário em que o PSP do usuário recebedor recebe do usuário recebedor as informações da cobrança recorrente. Formato UTC: aaaa-mm-ddTHH:mm:ss.sssZ

Example: 2023-01-01T00:00:00.000Z

dtVencimentostring · max: 10Required

Data de vencimento da cobrança recorrente. Formato: aaaa-mm-dd

Example: 2023-01-01

valorstring | nullableRequired

Valor dos pagamentos.

Example: 100.00

recebedorall ofRequired

Grupo de informações do Recebedor

pagadorall ofRequired

Grupo de informações do Pagador

devedorall ofRequired

Grupo de informações do Pagador

infEntreClientesstring · max: 140Required

Conjunto de elementos usado para envio de informações do Cliente Recebedor para o Cliente Pagador.

finalidadeAgendamentonumber · enumRequired

Finalidade do agendamento. Identifica se é um agendamento original ou uma nova tentativa. Domínio: 0 – Agendamento (primeira tentativa); 1 – Nova tentativa pós vencimento; 2 – Reenvio devido a erro na liquidação.

Default: 0Example: 0Possible values:

Responses

default

application/json

post

HTTPcURLJavaScriptPython

POST /psti/notifica-agendamento-pagador HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 587

{
  "endToEndId": "E00038166202409171500y6j6mt9l0pi",
  "idConciliacaoRecebedor": "AB123456789012345678901234567890",
  "idRecorrencia": "RR0435879820240605njua7shf40o",
  "dtHrRecepcaoPspRecebedor": "2023-01-01T00:00:00.000Z",
  "dtVencimento": "2023-01-01",
  "valor": "100.00",
  "recebedor": {
    "ispb": 12345678,
    "cnpj": 61695227000193,
    "nome": "Enel"
  },
  "pagador": {
    "ispb": 12345678,
    "tpPessoa": 0,
    "cpfCnpj": 12345678901,
    "nrAgencia": "0001",
    "nrConta": "12345678901234567890",
    "codMunIbge": 1234567
  },
  "devedor": {
    "ispb": 12345678,
    "nome": "Enel",
    "tpPessoa": 0,
    "cpfCnpj": 12345678901
  },
  "infEntreClientes": "text",
  "finalidadeAgendamento": 0
}

default

{
  "idReqJdPi": "45F763C6-7487-4363-9406-A1DE2A9636D3",
  "idSgct": "69F963C6-7487-4363-9406-A1DE2A9636D4",
  "dtHrSgct": "2023-01-01T00:00:00.000Z"
}