Cancelamento agendamento

O Cliente deve desenvolver do lado deles esperando receber esse payload e devendo nos devolver seguindo o exemplo.

post

Body

idCancelamentostring · max: 29Required

Identificador único do Cancelamento do agendamento. Formato: ICxxxxxxxxyyyyMMddkkkkkkkkkkk

Example: ICxxxxxxxxyyyyMMddkkkkkkkkkkk

stCancelamentonumber · enum | nullableOptional

Situação do Cancelamento. Domínio: 0 - Aceito; 1 - Rejeitado.

Default: 0Example: 0Possible values:

solCancelamentonumber · enumRequired

PSP que solicitou o cancelamento. Domínio: 0 – PSP do usuário pagador; 1 – PSP do usuário recebedor.

Default: 0Example: 0Possible values:

codigoErrostring · enum | nullableRequired

Código de Erro, informado quando “stJdPi” possuir valor “0” ou “-1”

Default: AP03Example: AP03Possible values:

descCodigoErrostring | nullableRequired

Descrição do Código de Erro, informado quando “stJdPi” possuir valor “0” ou “-1”.

Example: Descrição do erro

ispbSolicitantenumberRequired

ISPB do PSP Pagador ou Recebedor que solicitou o cancelamento.

Example: 12345678

ispbDestinatarionumberRequired

ISPB do PSP Pagador ou Recebedor que irá receber a solicitação de cancelamento.

Example: 87654321

idConciliacaoRecebedorstring · max: 35Required

Identificador único para Conciliação do Recebedor.

Example: AB123456789012345678901234567890

tpPessoaSolnumber · enumRequired

Tipo Pessoa do Solicitante do Cancelamento. Domínio: 0 – Pessoa Física 1 – Pessoa Jurídica

Default: 0Example: 0Possible values:

cpfCnpjSolCancelamentonumberRequired

CPF ou CNPJ do Solicitante do Cancelamento.

Example: 12345678901234

motivoCancelamentonumber · enumRequired

Motivo do Cancelamento do Agendamento. Domínio: 0 - Motivado por encerramento da conta transacional do usuário pagador ou do usuário recebedor; 1 - Motivado por bloqueio da conta transacional do usuário pagador ou do usuário recebedor; 2 - Motivado por cancelamento da autorização para pagamentos periódicos; 3 - Motivado por falha ou erro no fluxo de liquidação; 4 - Cancelamento por outros motivos, solicitado pelo participante do usuário pagador ou usuário recebedor; 5 - Solicitado pelo usuário pagador; 6 - Solicitado pelo usuário recebedor.

Default: 4Example: 4Possible values:

endToEndIdstring · max: 32Required

Identificador Único da transação de pagamento.

Example: E00038166202409171500y6j6mt9l0pi

dtHrCancelamentostring · max: 24Required

Data e hora do cancelamento informada pelo PSP do usuário Pagador ou data e hora da solicitação de cancelamento pelo PSP do usuário Recebedor. Formato: aaaa-mm-ddTHH:mm:ss.sssZ

Example: 2025-03-14T12:00:00.000Z

Responses

default

application/json

post

HTTPcURLJavaScriptPython

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

{
  "idCancelamento": "ICxxxxxxxxyyyyMMddkkkkkkkkkkk",
  "stCancelamento": 0,
  "solCancelamento": 0,
  "codigoErro": "AP03",
  "descCodigoErro": "Descrição do erro",
  "ispbSolicitante": 12345678,
  "ispbDestinatario": 87654321,
  "idConciliacaoRecebedor": "AB123456789012345678901234567890",
  "tpPessoaSol": 0,
  "cpfCnpjSolCancelamento": 12345678901234,
  "motivoCancelamento": 4,
  "endToEndId": "E00038166202409171500y6j6mt9l0pi",
  "dtHrCancelamento": "2025-03-14T12:00:00.000Z"
}

default

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