Consult a PIX Automatico schedule situation

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

package main

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

func main() {

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

	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}', 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}"

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

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

print(response.text)

{
  "endToEndId": "E00038166202409171500y6j6mt9l0pi",
  "localStatus": "Accepted",
  "localStatusKnown": true,
  "payer": {
    "account": "0007654321",
    "accountType": 0,
    "agency": "0001",
    "cnpj": "61695227000193",
    "cpfCnpj": "04623217035",
    "ispb": "04358798",
    "name": "Enel",
    "personType": 0
  },
  "purpose": 0,
  "recipient": {
    "account": "0007654321",
    "accountType": 0,
    "agency": "0001",
    "cnpj": "61695227000193",
    "cpfCnpj": "04623217035",
    "ispb": "04358798",
    "name": "Enel",
    "personType": 0
  },
  "recurrenceId": "RR0435879820240605njua7shf40o",
  "stJdPi": 9,
  "stJdPiProc": 9,
  "acceptRejectAt": "2024-09-17T15:10:05Z",
  "amount": 55000,
  "cancellations": [
    {
      "cancellationId": "CA0435879820240605abcd1234567",
      "cancelledAt": "2024-10-01T10:00:00Z",
      "reason": 0,
      "recipientIspb": "00038166",
      "requesterDocument": "04623217035",
      "requesterIspb": "04358798",
      "requesterType": 0,
      "cancelStatus": 0,
      "errorCode": "",
      "errorDesc": ""
    }
  ],
  "debtor": {
    "personType": 0,
    "cpfCnpj": "04623217035",
    "name": "Ciclano da Silva"
  },
  "dueDate": "2024-09-24",
  "errorCode": "",
  "errorDesc": "",
  "infoBetweenClients": "",
  "pendingReason": "INSUFFICIENT_BALANCE",
  "recipientReceivedAt": "2024-09-17T10:25:49Z",
  "reconciliationId": "JDPI2024091700000000000000000000001",
  "requestedAt": "2024-09-17T10:10:05Z",
  "scheduleStatus": 0,
  "situationAt": "2024-09-18T16:34:18Z",
  "waitingSince": "2026-10-25T12:00: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}

Consult a PIX Automatico schedule situation

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

package main

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

func main() {

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

	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}', 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}"

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

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

print(response.text)

{
  "endToEndId": "E00038166202409171500y6j6mt9l0pi",
  "localStatus": "Accepted",
  "localStatusKnown": true,
  "payer": {
    "account": "0007654321",
    "accountType": 0,
    "agency": "0001",
    "cnpj": "61695227000193",
    "cpfCnpj": "04623217035",
    "ispb": "04358798",
    "name": "Enel",
    "personType": 0
  },
  "purpose": 0,
  "recipient": {
    "account": "0007654321",
    "accountType": 0,
    "agency": "0001",
    "cnpj": "61695227000193",
    "cpfCnpj": "04623217035",
    "ispb": "04358798",
    "name": "Enel",
    "personType": 0
  },
  "recurrenceId": "RR0435879820240605njua7shf40o",
  "stJdPi": 9,
  "stJdPiProc": 9,
  "acceptRejectAt": "2024-09-17T15:10:05Z",
  "amount": 55000,
  "cancellations": [
    {
      "cancellationId": "CA0435879820240605abcd1234567",
      "cancelledAt": "2024-10-01T10:00:00Z",
      "reason": 0,
      "recipientIspb": "00038166",
      "requesterDocument": "04623217035",
      "requesterIspb": "04358798",
      "requesterType": 0,
      "cancelStatus": 0,
      "errorCode": "",
      "errorDesc": ""
    }
  ],
  "debtor": {
    "personType": 0,
    "cpfCnpj": "04623217035",
    "name": "Ciclano da Silva"
  },
  "dueDate": "2024-09-24",
  "errorCode": "",
  "errorDesc": "",
  "infoBetweenClients": "",
  "pendingReason": "INSUFFICIENT_BALANCE",
  "recipientReceivedAt": "2024-09-17T10:25:49Z",
  "reconciliationId": "JDPI2024091700000000000000000000001",
  "requestedAt": "2024-09-17T10:10:05Z",
  "scheduleStatus": 0,
  "situationAt": "2024-09-18T16:34:18Z",
  "waitingSince": "2026-10-25T12:00: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"

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-9A-Z]{8}$

Example:

"12345678"

Response

endToEndId

string

required

The payment-transaction id (32-char).

Example:

"E00038166202409171500y6j6mt9l0pi"

localStatus

string

required

Local ScheduleStatus projected from the JDPI situation.

Example:

"Accepted"

localStatusKnown

boolean

required

False when the JDPI situation carries no projected local status.

Example:

true

payer

object

required

The scheduled pagador.

Show child attributes

purpose

integer<int64>

required

finalidadeAgendamento (0=first attempt, 1=post-due retry, 2=resend after a settlement error). Always present, including 0.

Example:

0

recipient

object

required

The scheduled recebedor.

Show child attributes

recurrenceId

string

required

The recurrence id (RR...).

Example:

"RR0435879820240605njua7shf40o"

stJdPi

integer<int64>

required

JDPI overall situation (-1/0/9/10/11).

Example:

9

stJdPiProc

integer<int64>

required

JDPI intermediate situation (0/1/2/5/7/8/9/10/11).

Example:

9

acceptRejectAt

string

Accept/reject timestamp (dtHrAceiteRejeite, UTC).

Example:

"2024-09-17T15:10:05Z"

amount

integer<int64>

Scheduled amount in centavos.

Example:

55000

cancellations

object[] | null

Cancellation history (cancelamento).

Show child attributes

debtor

object

The scheduled devedor; absent when the debtor is the payer.

Show child attributes

dueDate

string

Due date (aaaa-mm-dd).

Example:

"2024-09-24"

errorCode

string

JDPI error code.

Example:

""

errorDesc

string

JDPI error description.

Example:

""

infoBetweenClients

string

Free-text receiver-to-payer info.

Example:

""

pendingReason

enum<string>

Set only on the by-endToEndId consult, never on the list: why the payer's §5.4.2 debit, which the SPI already settled, is not yet in the payer's ledger. INSUFFICIENT_BALANCE: the ledger refused it for funds, and JD's redelivery posts it once the payer is funded. TRACER_DENIED: the client's Tracer refused it (a rule or a limit), and JD's redelivery posts it once the Tracer lets it through. No deadline is known. Absent when nothing waits, and when the consult names a participant other than the payer's.

Available options:

INSUFFICIENT_BALANCE,

TRACER_DENIED

Example:

"INSUFFICIENT_BALANCE"

recipientReceivedAt

string

Recipient PSP reception timestamp (UTC).

Example:

"2024-09-17T10:25:49Z"

reconciliationId

string

The receiver conciliation id.

Example:

"JDPI2024091700000000000000000000001"

requestedAt

string

JDPI request timestamp (UTC).

Example:

"2024-09-17T10:10:05Z"

scheduleStatus

integer<int64>

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

Example:

0

situationAt

string

Situation timestamp (UTC).

Example:

"2024-09-18T16:34:18Z"

waitingSince

string<date-time>

With pendingReason: when this deployment first tried to post the debit (UTC).

Example:

"2026-10-25T12:00:00Z"

Direct participant APIs

Indirect participant APIs

Consult a PIX Automatico schedule situation

Authorizations

Path Parameters

Query Parameters

Response