Skip to main content
POST
Cancel a PIX Automatico schedule

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

endToEndId
string
required

The payment-transaction id (32-char).

Example:

"E00038166202409171500y6j6mt9l0pi"

Body

application/json
reason
integer<int64>
required

motivoCancelamento (0..6).

Example:

0

recipientIspb
string
required

Destination participant ISPB (ispbDestinatario, string).

Example:

"00038166"

reconciliationId
string
required

Receiver conciliation id (idConciliacaoRecebedor).

Example:

"JDPI2024091700000000000000000000001"

requester
integer<int64>
required

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

Example:

1

requesterDocument
string
required

Requester CPF/CNPJ (cpfCnpjSolCancelamento, string).

Example:

"04623217035"

requesterIspb
string
required

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.

Example:

"04358798"

requesterPersonType
integer<int64>
required

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

Example:

0

Response

Accepted

cancellationId
string
required

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

Example:

"CA0435879820240605abcd1234567"

cancelledAt
string
required

Cancellation timestamp (dtHrCancelamento, UTC).

Example:

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

endToEndId
string
required

The payment-transaction id (echoed).

Example:

"E00038166202409171500y6j6mt9l0pi"

reconciliationId
string
required

The receiver conciliation id (echoed).

Example:

"JDPI2024091700000000000000000000001"

status
string
required

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

Example:

"Accepted"