List recurring series

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

package main

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

func main() {

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

	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-payment-recurrences', 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-payment-recurrences"

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

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

print(response.text)

{
  "items": [
    {
      "id": "01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0",
      "accountId": "0195948b-bf02-7e4f-9a1b-2c3d4e5f6a7b",
      "amount": "150.00",
      "currency": "BRL",
      "status": "ACTIVE",
      "initiationType": "DICT",
      "purpose": "IPAY",
      "description": "Aluguel",
      "metadata": {
        "contractRef": "A-4471"
      },
      "recurrence": {
        "periodicity": "MONTHLY",
        "firstPaymentDate": "2027-08-10",
        "paymentCount": 12,
        "endDate": null,
        "indefinite": false,
        "referenceDayOfMonth": 10
      },
      "source": {
        "branch": "0001",
        "accountNumber": "1234567",
        "accountType": "CACC",
        "ispb": "60746948",
        "personType": "NATURAL_PERSON",
        "taxId": "12345678909",
        "name": "Ana Souza"
      },
      "destination": {
        "branch": "0001",
        "accountNumber": "7654321",
        "accountType": "CACC",
        "ispb": "18236120",
        "personType": "NATURAL_PERSON",
        "taxId": "98765432100",
        "name": "Joao Pereira"
      },
      "payeeKey": {
        "keyType": "EMAIL",
        "keyValue": "joao.pereira@example.com"
      },
      "materializedThrough": "2027-10-10",
      "lastPaymentDate": "2028-07-10",
      "createdAt": "2026-09-25T14:32:10.123456Z",
      "updatedAt": "2026-09-25T14:32:10.123456Z"
    }
  ]
}

{
  "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 recurring series

Returns a page of the organization’s series, newest first. Creation order is the only ordering a series can offer: a series has no settlement date of its own — its occurrences carry those — which is also why this route takes no date range. To ask which payments fall in a period, or to see the occurrences of one series, use GET /v1/scheduled-payments with recurrence_id. Paging is by opaque cursor rather than offset: a series registered between two pages would shift every later row under an offset and silently skip one. Echo the cursor verbatim. The status filter takes the SERIES’ statuses (ACTIVE, COMPLETED, CANCELLED), not an occurrence’s — a cancelled series still has settled occurrences behind it.

GET

scheduled-payment-recurrences

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

package main

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

func main() {

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

	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-payment-recurrences', 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-payment-recurrences"

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

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

print(response.text)

{
  "items": [
    {
      "id": "01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0",
      "accountId": "0195948b-bf02-7e4f-9a1b-2c3d4e5f6a7b",
      "amount": "150.00",
      "currency": "BRL",
      "status": "ACTIVE",
      "initiationType": "DICT",
      "purpose": "IPAY",
      "description": "Aluguel",
      "metadata": {
        "contractRef": "A-4471"
      },
      "recurrence": {
        "periodicity": "MONTHLY",
        "firstPaymentDate": "2027-08-10",
        "paymentCount": 12,
        "endDate": null,
        "indefinite": false,
        "referenceDayOfMonth": 10
      },
      "source": {
        "branch": "0001",
        "accountNumber": "1234567",
        "accountType": "CACC",
        "ispb": "60746948",
        "personType": "NATURAL_PERSON",
        "taxId": "12345678909",
        "name": "Ana Souza"
      },
      "destination": {
        "branch": "0001",
        "accountNumber": "7654321",
        "accountType": "CACC",
        "ispb": "18236120",
        "personType": "NATURAL_PERSON",
        "taxId": "98765432100",
        "name": "Joao Pereira"
      },
      "payeeKey": {
        "keyType": "EMAIL",
        "keyValue": "joao.pereira@example.com"
      },
      "materializedThrough": "2027-10-10",
      "lastPaymentDate": "2028-07-10",
      "createdAt": "2026-09-25T14:32:10.123456Z",
      "updatedAt": "2026-09-25T14:32:10.123456Z"
    }
  ]
}

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

default:20

Page size, 1..100. Absent or 0 means 20.

Required range: 0 <= x <= 100

Example:

20

cursor

string

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

account_id

string<uuid>

Narrow to one payer account.

status

enum<string>

Narrow to one series status. These are the SERIES' statuses, not an occurrence's: a cancelled series still has settled occurrences behind it.

Available options:

ACTIVE,

COMPLETED,

CANCELLED

Response

items

object[]

required

The page, newest 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 recurring series

Authorizations

Query Parameters

Response