Consult a PIX Automatico schedule cancellation

curl --request GET \
  --url https://api.example.com/v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento} \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "cancellationId": "CA0435879820240605abcd1234567",
  "endToEndId": "E00038166202409171500y6j6mt9l0pi",
  "localStatus": "Cancelled",
  "localStatusKnown": true,
  "reason": 0,
  "recipientIspb": "00038166",
  "requester": 1,
  "requesterDocument": "04623217035",
  "requesterIspb": "04358798",
  "requesterType": 0,
  "stJdPi": 9,
  "stJdPiProc": 9,
  "cancelStatus": 0,
  "cancelledAt": "2024-10-01T10:00:00Z",
  "errorCode": "",
  "errorDesc": "",
  "reconciliationId": "JDPI2024091700000000000000000000001",
  "requestedAt": "2024-10-01T10:00:00Z",
  "situationAt": "2024-10-01T10:05:00Z"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

GET

pix-automatico

schedules

{endToEndId}

cancel

{idCancelamento}

Consult a PIX Automatico schedule cancellation

curl --request GET \
  --url https://api.example.com/v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento} \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "cancellationId": "CA0435879820240605abcd1234567",
  "endToEndId": "E00038166202409171500y6j6mt9l0pi",
  "localStatus": "Cancelled",
  "localStatusKnown": true,
  "reason": 0,
  "recipientIspb": "00038166",
  "requester": 1,
  "requesterDocument": "04623217035",
  "requesterIspb": "04358798",
  "requesterType": 0,
  "stJdPi": 9,
  "stJdPiProc": 9,
  "cancelStatus": 0,
  "cancelledAt": "2024-10-01T10:00:00Z",
  "errorCode": "",
  "errorDesc": "",
  "reconciliationId": "JDPI2024091700000000000000000000001",
  "requestedAt": "2024-10-01T10:00:00Z",
  "situationAt": "2024-10-01T10:05:00Z"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

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"

idCancelamento

string

required

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

Example:

"CA0435879820240605abcd1234567"

Query Parameters

ispb

string

The ISPB of the direct participant this consult is made AS. It is ROUTING DATA you supply and guarantee - never a credential, never read from a header or a path, and it never widens what your token can reach. While exactly ONE participant of this deployment holds this recurrence, the recorded row names the direct participant whose books it lives in, and that is authoritative: naming that one changes nothing, naming another is refused. It DECIDES when TWO do - this deployment can be both PSPs of one recurrence inside its own economic group, and then it holds one row per side, in two participants' books, with no way to choose between them. OPTIONAL in every other case: omit it and the row, or the tenant default when there is no row, answers. Omitting it with a row on each side is 422 PIX-0127, an ISPB this deployment does not act as is 422 PIX-0128, and one that holds none of the recorded rows is 400 PIX-0061. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9]{8}$

Example:

"12345678"

Response

cancellationId

string

required

The cancellation id (CA...).

Example:

"CA0435879820240605abcd1234567"

endToEndId

string

required

The payment-transaction id.

Example:

"E00038166202409171500y6j6mt9l0pi"

localStatus

string

required

Local ScheduleStatus projected from the JDPI situation.

Example:

"Cancelled"

localStatusKnown

boolean

required

False when the JDPI situation carries no projected local status.

Example:

true

reason

integer<int64>

required

motivoCancelamento (0..6).

Example:

0

recipientIspb

string

required

ispbDestinatario (string).

Example:

"00038166"

requester

integer<int64>

required

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

Example:

1

requesterDocument

string

required

Requester CPF/CNPJ (string).

Example:

"04623217035"

requesterIspb

string

required

Requester participant ISPB (string).

Example:

"04358798"

requesterType

integer<int64>

required

tpPessoaSol.

Example:

0

stJdPi

integer<int64>

required

JDPI overall situation.

Example:

9

stJdPiProc

integer<int64>

required

JDPI intermediate situation.

Example:

9

cancelStatus

integer<int64>

stCancelamento (0=Aceito, 1=Rejeitado). Absent when JDPI did not report it.

Example:

0

cancelledAt

string

Cancellation timestamp (UTC).

Example:

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

errorCode

string

JDPI error code.

Example:

""

errorDesc

string

JDPI error description.

Example:

""

reconciliationId

string

The receiver conciliation id.

Example:

"JDPI2024091700000000000000000000001"

requestedAt

string

JDPI request timestamp (UTC).

Example:

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

situationAt

string

Situation timestamp (UTC).

Example:

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

Direct participant APIs

Indirect participant APIs

Consult a PIX Automatico schedule cancellation

Authorizations

Path Parameters

Query Parameters

Response