List scheduled Pix payments

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

package main

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

func main() {

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

	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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "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>"
    }
  ],
  "nextCursor": "<string>"
}

{
  "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"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "validation failed",
  "errors": [
    {
      "message": "invalid integer",
      "location": "query.limit",
      "value": "abc"
    }
  ]
}

{
  "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"
  }
}

List scheduled Pix payments

Returns a page of the organization’s scheduled payments, newest settlement date first. Paging is by opaque cursor rather than offset: a schedule registered between two pages would shift every later row under an offset and silently skip one. Echo the cursor verbatim. The page carries no attempt history — that is per-schedule data a list view does not show, and it is on the single-schedule route instead. Filtering by recurrence_id is how the occurrences of a recurring series are enumerated: an occurrence IS a scheduled payment, so it is listed here rather than under a route of its own, which would give the same row two identities.

GET

scheduled-payments

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

package main

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

func main() {

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

	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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "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>"
    }
  ],
  "nextCursor": "<string>"
}

{
  "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"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "validation failed",
  "errors": [
    {
      "message": "invalid integer",
      "location": "query.limit",
      "value": "abc"
    }
  ]
}

{
  "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.

Query Parameters

limit

integer<int64>

Page size, 1..100. Absent or 0 means 20. A negative value or one above 100 is REFUSED, never clamped -- a clamped page size makes a caller believe it read everything.

Required range: 0 <= x <= 100

Example:

20

cursor

string

Opaque cursor from a previous page's pagination block. Echo it verbatim -- it is not a document to build.

account_id

string

Narrow to one payer account.

status

enum<string>

Narrow to one lifecycle status.

Available options:

PENDING,

EXECUTING,

DISPATCHED_OUTCOME_UNKNOWN,

AWAITING_RETRY,

SETTLED,

CANCELLED,

FAILED

start_date

string<date>

Earliest settlement date to include, inclusive.

Example:

"2026-09-01"

end_date

string<date>

Latest settlement date to include, inclusive.

Example:

"2026-09-30"

recurrence_id

string

Narrow to the occurrences of ONE recurring series. This is how a series' occurrences are enumerated: an occurrence IS a scheduled payment, so it is listed here rather than under a route of its own, which would give the same row two identities.

Example:

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

Response

items

object[] | null

required

The page, newest settlement date first. Never null.

Show child attributes

nextCursor

string

Pass back as cursor for the following page. Absent on the last page -- its absence is how the listing ends, not an empty items array.

DICT and Pix keys

Collections and BR Codes

Payments and refunds

Pix Automático API

Error handling

List scheduled Pix payments

Authorizations

Query Parameters

Response