Read one scheduled Pix payment

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

package main

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

func main() {

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

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

import requests

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

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

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

print(response.text)

{
  "accountId": "019606a1-3b4c-7d8e-9f01-234567890abc",
  "amount": "150.00",
  "attempts": [
    {
      "attemptNumber": 1,
      "id": "<string>",
      "isLastAttempt": true,
      "startedAt": "2023-11-07T05:31:56Z",
      "endToEndId": "<string>",
      "finishedAt": "2023-11-07T05:31:56Z",
      "outcome": "SETTLED",
      "providerChannel": "PRIMARY"
    }
  ],
  "cancellationCutoff": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "currency": "BRL",
  "destination": {
    "accountType": "CACC",
    "ispb": "32074986",
    "name": "Ana Souza",
    "personType": "NATURAL_PERSON",
    "taxId": "39053344705",
    "accountNumber": "123456",
    "branch": "0001"
  },
  "firstWindowOpensAt": "2023-11-07T05:31:56Z",
  "id": "019606a1-3b4c-7d8e-9f01-234567890abc",
  "initiationType": "DICT",
  "purpose": "IPAY",
  "scheduledDate": "2026-09-10",
  "source": {
    "accountType": "CACC",
    "ispb": "32074986",
    "name": "Ana Souza",
    "personType": "NATURAL_PERSON",
    "taxId": "39053344705",
    "accountNumber": "123456",
    "branch": "0001"
  },
  "status": "PENDING",
  "updatedAt": "2023-11-07T05:31:56Z",
  "cancelledReason": "USER_REQUEST",
  "description": "Aluguel de setembro",
  "transferId": "<string>"
}

{
  "code": "ERR-0001",
  "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

scheduled-payments

{schedule_id}

Read one scheduled Pix payment

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

package main

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

func main() {

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

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

import requests

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

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

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

print(response.text)

{
  "accountId": "019606a1-3b4c-7d8e-9f01-234567890abc",
  "amount": "150.00",
  "attempts": [
    {
      "attemptNumber": 1,
      "id": "<string>",
      "isLastAttempt": true,
      "startedAt": "2023-11-07T05:31:56Z",
      "endToEndId": "<string>",
      "finishedAt": "2023-11-07T05:31:56Z",
      "outcome": "SETTLED",
      "providerChannel": "PRIMARY"
    }
  ],
  "cancellationCutoff": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "currency": "BRL",
  "destination": {
    "accountType": "CACC",
    "ispb": "32074986",
    "name": "Ana Souza",
    "personType": "NATURAL_PERSON",
    "taxId": "39053344705",
    "accountNumber": "123456",
    "branch": "0001"
  },
  "firstWindowOpensAt": "2023-11-07T05:31:56Z",
  "id": "019606a1-3b4c-7d8e-9f01-234567890abc",
  "initiationType": "DICT",
  "purpose": "IPAY",
  "scheduledDate": "2026-09-10",
  "source": {
    "accountType": "CACC",
    "ispb": "32074986",
    "name": "Ana Souza",
    "personType": "NATURAL_PERSON",
    "taxId": "39053344705",
    "accountNumber": "123456",
    "branch": "0001"
  },
  "status": "PENDING",
  "updatedAt": "2023-11-07T05:31:56Z",
  "cancelledReason": "USER_REQUEST",
  "description": "Aluguel de setembro",
  "transferId": "<string>"
}

{
  "code": "ERR-0001",
  "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

schedule_id

string

required

Schedule identifier.

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Response

accountId

string

required

Payer account.

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

amount

string

required

Amount to settle, in BRL.

Example:

"150.00"

attempts

object[] | null

required

Every attempt of the scheduled day, oldest first. Empty before that date, and never null.

Show child attributes

cancellationCutoff

string<date-time>

required

The first instant a cancellation is REFUSED. Cancellation is accepted right up to it and refused AT it, and it is strictly before the first window so the two can never overlap.

createdAt

string<date-time>

required

currency

string

required

Always BRL.

Example:

"BRL"

destination

object

required

The payee as photographed at creation. On the scheduled date this is compared against a fresh directory answer (REG-Art.9§6), which is why it is stored rather than re-resolved.

Show child attributes

firstWindowOpensAt

string<date-time>

required

When the first settlement window of the scheduled date opens (IN 513 art. 12 caput). Photographed at creation.

string

required

Schedule identifier.

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

initiationType

enum<string>

required

How the destination was resolved.

Available options:

MANUAL,

DICT,

QR_CODE

Example:

"DICT"

purpose

enum<string>

required

Always IPAY: REG-Art.11-P prohibits scheduling any other purpose.

Available options:

IPAY

Example:

"IPAY"

scheduledDate

string<date>

required

Civil settlement date in AAAA-MM-DD, in America/Sao_Paulo.

Example:

"2026-09-10"

source

object

required

The payer as photographed at creation.

Show child attributes

status

enum<string>

required

Lifecycle status. DISPATCHED_OUTCOME_UNKNOWN is NOT terminal: the order is awaiting reconciliation and will resolve to SETTLED or FAILED. It does NOT assert that the order reached the rail -- it also covers an order that provably did not, whose reserved funds are still being released.

Available options:

PENDING,

EXECUTING,

DISPATCHED_OUTCOME_UNKNOWN,

AWAITING_RETRY,

SETTLED,

CANCELLED,

FAILED

Example:

"PENDING"

updatedAt

string<date-time>

required

cancelledReason

enum<string>

Present exactly when status is CANCELLED. A cancellation the payer asked for and one the domain performed are deliberately distinguishable.

Available options:

USER_REQUEST,

OWNERSHIP_MISMATCH,

KEY_NOT_FOUND,

RECURRENCE_CANCELLED

description

string

The payer's memo, returned exactly as it was stored. Markup is not interpreted here and was not escaped on the way in (RF-16); escaping belongs to whoever renders it.

Example:

"Aluguel de setembro"

transferId

string

The transfer that settled this schedule, once it has.

DICT and Pix keys

Collections and BR Codes

Payments and refunds

Error handling

Read one scheduled Pix payment

Authorizations

Path Parameters

Response