Skip to main content
GET
Consult a PIX Automatico schedule cancellation

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"

idCancelamento
string
obrigatório

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

Exemplo:

"CA0435879820240605abcd1234567"

Resposta

OK

cancelStatus
integer<int64>
obrigatório

stCancelamento (0=Aceito, 1=Rejeitado; -1 when absent).

Exemplo:

0

endToEndId
string
obrigatório

The payment-transaction id.

Exemplo:

"E00038166202409171500y6j6mt9l0pi"

idCancelamento
string
obrigatório

The cancellation id (CA...).

Exemplo:

"CA0435879820240605abcd1234567"

localStatus
string
obrigatório

Local ScheduleStatus projected from the JDPI situation.

Exemplo:

"Cancelled"

localStatusKnown
boolean
obrigatório

False when the JDPI situation carries no projected local status.

Exemplo:

true

reason
integer<int64>
obrigatório

motivoCancelamento (0..6).

Exemplo:

0

recipientIspb
string
obrigatório

ispbDestinatario (string).

Exemplo:

"00038166"

requester
integer<int64>
obrigatório

solCancelamento (0=PSP pagador, 1=PSP recebedor).

Exemplo:

1

requesterDocument
string
obrigatório

Requester CPF/CNPJ (string).

Exemplo:

"04623217035"

requesterIspb
string
obrigatório

ispbSolicitante (string).

Exemplo:

"04358798"

requesterType
integer<int64>
obrigatório

tpPessoaSol.

Exemplo:

0

stJdPi
integer<int64>
obrigatório

JDPI overall situation.

Exemplo:

9

stJdPiProc
integer<int64>
obrigatório

JDPI intermediate situation.

Exemplo:

9

cancelledAt
string

Cancellation timestamp (UTC).

Exemplo:

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

errorCode
string

JDPI error code.

Exemplo:

""

errorDesc
string

JDPI error description.

Exemplo:

""

reconciliationId
string

The receiver conciliation id.

Exemplo:

"JDPI2024091700000000000000000000001"

requestedAt
string

JDPI request timestamp (UTC).

Exemplo:

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

situationAt
string

Situation timestamp (UTC).

Exemplo:

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