Inspect a recorded Pix Automático schedule operation (internal operator read)

curl --request GET \
  --url https://api.example.com/api/v1/spi/scheduled-payments/{scheduleId} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://api.example.com/api/v1/spi/scheduled-payments/{scheduleId}"

	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/api/v1/spi/scheduled-payments/{scheduleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/spi/scheduled-payments/{scheduleId}"

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

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

print(response.text)

{
  "cancellationReceived": true,
  "correlationId": "schedule|SCHEDULE2026Ref001",
  "createdAt": "2026-06-10T15:00:00Z",
  "operationId": "550e8400-e29b-41d4-a716-446655440000",
  "operationState": "AWAITING_RESPONSE",
  "ownMessageRefused": false,
  "refusalSweepPending": false,
  "refusedCancellationMessageId": "",
  "scheduleId": "SCHEDULE2026Ref001",
  "scheduleState": "SCHEDULED",
  "side": "PAYER",
  "updatedAt": "2026-06-10T15:05:00Z"
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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

api

spi

scheduled-payments

{scheduleId}

Inspect a recorded Pix Automático schedule operation (internal operator read)

curl --request GET \
  --url https://api.example.com/api/v1/spi/scheduled-payments/{scheduleId} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://api.example.com/api/v1/spi/scheduled-payments/{scheduleId}"

	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/api/v1/spi/scheduled-payments/{scheduleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/spi/scheduled-payments/{scheduleId}"

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

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

print(response.text)

{
  "cancellationReceived": true,
  "correlationId": "schedule|SCHEDULE2026Ref001",
  "createdAt": "2026-06-10T15:00:00Z",
  "operationId": "550e8400-e29b-41d4-a716-446655440000",
  "operationState": "AWAITING_RESPONSE",
  "ownMessageRefused": false,
  "refusalSweepPending": false,
  "refusedCancellationMessageId": "",
  "scheduleId": "SCHEDULE2026Ref001",
  "scheduleState": "SCHEDULED",
  "side": "PAYER",
  "updatedAt": "2026-06-10T15:05:00Z"
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "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"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

scheduleId

string

obrigatório

Schedule (agendamento) identifier to inspect.

Resposta

cancellationReceived

boolean

obrigatório

True while a camt.055 this installation received for the schedule awaits the camt.029 it sends: the one that parked the schedule cancellation-pending (scheduleState SCHEDULED_CANCELLATION_PENDING or CANCELLATION_PENDING), or one that parked nothing (it crossed this installation's own camt.055, or the schedule owes this installation's own pain.014 RJCT and stays SCHEDULED). A camt.055 naming a retry attempt's EndToEndId counts on that attempt's row. False once the camt.029 is sent, and when only this installation's own camt.055 holds the schedule.

Exemplo:

true

correlationId

string

obrigatório

Persisted correlation handle (client_operations.business_key).

Exemplo:

"schedule|SCHEDULE2026Ref001"

createdAt

string<date-time>

obrigatório

Operation creation timestamp (RFC3339 UTC).

Exemplo:

"2026-06-10T15:00:00Z"

operationId

string

obrigatório

UUID of the recorded schedule operation (client_operations.id).

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

operationState

string

obrigatório

Operation lifecycle state (client_operations.state).

Exemplo:

"AWAITING_RESPONSE"

ownMessageRefused

boolean

obrigatório

True while BACEN refused (admi.002) a message this installation sent for the schedule and the operator owes its next step: its own camt.055, until the operator releases its reservation; its pain.014, or the camt.029 RJCR answering a received camt.055, until resent within the reply's deadline (2 hours after the pain.013, 12 hours after the camt.055). False otherwise.

Exemplo:

false

refusalSweepPending

boolean

obrigatório

True while this installation owes the received pain.013 its own pain.014 RJCT (the mandate is unknown or not confirmed) and the refusal sweep still sends it within the 2 hours: no operator answer is due. False once the sweep hands it to the operator (operationState REQUIRES_OPERATOR_ACTION), and on every other schedule.

Exemplo:

false

refusedCancellationMessageId

string

obrigatório

The MsgId of this installation's own camt.055 that BACEN refused (admi.002) while it holds the schedule cancellation-pending: the reservation the operator releases (POST /api/v1/spi/operations/{operationId}/reservations/release) once BACEN confirms it never arrived. Always the first attempt's MsgId, which a resend never replaces. Empty otherwise.

Exemplo:

""

scheduleId

string

obrigatório

Schedule (agendamento) identifier the operation tracks.

Exemplo:

"SCHEDULE2026Ref001"

scheduleState

string

obrigatório

Schedule lifecycle state (metadata pain_lifecycle_state); empty before any lifecycle transition.

Exemplo:

"SCHEDULED"

side

string

obrigatório

The PSP this installation is for the schedule (metadata pain_schedule_side): PAYER when it received the pain.013 and answers it with a pain.014, RECEIVER when it sent it; empty before the schedule opens.

Exemplo:

"PAYER"

updatedAt

string<date-time>

obrigatório

Operation last-update timestamp (RFC3339 UTC).

Exemplo:

"2026-06-10T15:05:00Z"