Pular para o conteúdo principal
POST
Cancel a PIX Automatico schedule

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

endToEndId
string
obrigatório

The payment-transaction id (32-char).

Exemplo:

"E00038166202409171500y6j6mt9l0pi"

Corpo

application/json
reason
integer<int64>
obrigatório

motivoCancelamento (0..6).

Exemplo:

0

recipientIspb
string
obrigatório

Destination participant ISPB (ispbDestinatario, string).

Exemplo:

"00038166"

reconciliationId
string
obrigatório

Receiver conciliation id (idConciliacaoRecebedor).

Exemplo:

"JDPI2024091700000000000000000000001"

requester
integer<int64>
obrigatório

solCancelamento (0=payer's PSP, 1=recipient's PSP).

Exemplo:

1

requesterDocument
string
obrigatório

Requester CPF/CNPJ (cpfCnpjSolCancelamento, string).

Exemplo:

"04623217035"

requesterIspb
string
obrigatório

Requester participant ISPB (string). The schedule row this cancellation signs for has to be booked in this participant's books, or the cancellation is refused 404 PIX-0147 before JDPI is asked; an ISPB this deployment does not act as is 422 PIX-0128.

Exemplo:

"04358798"

requesterPersonType
integer<int64>
obrigatório

tpPessoaSol (0=Pessoa Fisica, 1=Pessoa Juridica).

Exemplo:

0

Resposta

Accepted

cancellationId
string
obrigatório

The cancellation id (29-char, CA...).

Exemplo:

"CA0435879820240605abcd1234567"

cancelledAt
string
obrigatório

Cancellation timestamp (dtHrCancelamento, UTC).

Exemplo:

"2024-10-01T10:00:00Z"

endToEndId
string
obrigatório

The payment-transaction id (echoed).

Exemplo:

"E00038166202409171500y6j6mt9l0pi"

reconciliationId
string
obrigatório

The receiver conciliation id (echoed).

Exemplo:

"JDPI2024091700000000000000000000001"

status
string
obrigatório

The local schedule status, unchanged until the counterparty answers the cancellation.

Exemplo:

"Accepted"