Read a recurring series' receipt

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

package main

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

func main() {

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

	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/{recurrence_id}/receipt', 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/{recurrence_id}/receipt"

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

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

print(response.text)

{
  "recurrenceId": "01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0",
  "scheduledAt": "2026-09-25T14:32:10.123456Z",
  "amount": "150.00",
  "firstPaymentDate": "2027-08-10",
  "periodicity": "MONTHLY",
  "paymentCount": 12,
  "lastPaymentDate": "2028-07-10",
  "payer": {
    "branch": "0001",
    "accountNumber": "1234567",
    "accountType": "CACC",
    "ispb": "60746948",
    "personType": "NATURAL_PERSON",
    "taxId": "12345678909",
    "name": "Ana Souza"
  },
  "payee": {
    "branch": "0001",
    "accountNumber": "7654321",
    "accountType": "CACC",
    "ispb": "18236120",
    "personType": "NATURAL_PERSON",
    "taxId": "98765432100",
    "name": "Joao Pereira"
  },
  "description": "Aluguel",
  "metadata": {
    "contractRef": "A-4471"
  },
  "cancellationCutoff": "2027-08-10T02:59:59.999999Z"
}

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

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

Read a recurring series' receipt

Returns the proof of what the payer committed to when they created the series: when it was registered, the amount of each payment, the first payment date, the frequency, the number of payments when one was chosen, and the last payment date when the series has one. It is a DIFFERENT document from the single schedule’s receipt and shares no field with it — a series has no settlement date of its own and a single schedule has no frequency, so one shared schema would leave half the fields null on either side. paymentCount and lastPaymentDate are null on an indefinite series, where stating either would be a fabrication. cancellationCutoff is the deadline of the NEXT pending occurrence, because a cut-off belongs to a date and a series spans many; it is null when no occurrence is pending. The receipt carries no status and no history on purpose — a document people save should not go stale the moment the series moves.

GET

scheduled-payment-recurrences

{recurrence_id}

receipt

Read a recurring series' receipt

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

package main

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

func main() {

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

	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/{recurrence_id}/receipt', 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/{recurrence_id}/receipt"

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

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

print(response.text)

{
  "recurrenceId": "01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0",
  "scheduledAt": "2026-09-25T14:32:10.123456Z",
  "amount": "150.00",
  "firstPaymentDate": "2027-08-10",
  "periodicity": "MONTHLY",
  "paymentCount": 12,
  "lastPaymentDate": "2028-07-10",
  "payer": {
    "branch": "0001",
    "accountNumber": "1234567",
    "accountType": "CACC",
    "ispb": "60746948",
    "personType": "NATURAL_PERSON",
    "taxId": "12345678909",
    "name": "Ana Souza"
  },
  "payee": {
    "branch": "0001",
    "accountNumber": "7654321",
    "accountType": "CACC",
    "ispb": "18236120",
    "personType": "NATURAL_PERSON",
    "taxId": "98765432100",
    "name": "Joao Pereira"
  },
  "description": "Aluguel",
  "metadata": {
    "contractRef": "A-4471"
  },
  "cancellationCutoff": "2027-08-10T02:59:59.999999Z"
}

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

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

recurrence_id

string<uuid>

obrigatório

Series identifier.

Exemplo:

"01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0"

Resposta

amount

string

obrigatório

Amount of every occurrence, in BRL.

Exemplo:

"150.00"

cancellationCutoff

string<date-time> | null

obrigatório

Deadline to cancel the NEXT pending occurrence. A cut-off belongs to a date and a series spans many, so this is the one field here that is not a property of the series itself. Null when no occurrence is pending -- there is then nothing left to cancel in the materialized window.

firstPaymentDate

string<date>

obrigatório

Civil date of the first payment.

Exemplo:

"2027-08-10"

lastPaymentDate

string<date> | null

obrigatório

Civil date of the final payment, when the series has one. Null on an indefinite series.

Exemplo:

"2028-07-10"

payee

object

obrigatório

The payee as photographed at creation.

Show child attributes

payer

object

obrigatório

The payer as photographed at creation.

Show child attributes

paymentCount

integer<int64> | null

obrigatório

How many payments the series has in all, when the payer terminated it by count. Null otherwise -- an indefinite series has no total, and reporting one would be a fabrication.

Exemplo:

12

periodicity

enum<string>

obrigatório

How often the series pays.

Opções disponíveis:

WEEKLY,

MONTHLY

Exemplo:

"MONTHLY"

recurrenceId

string

obrigatório

Series identifier.

Exemplo:

"01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0"

scheduledAt

string<date-time>

obrigatório

When the series was registered.

description

string

The payer's memo, exactly as stored.

Exemplo:

"Aluguel"

metadata

object

The annotation the caller sent at creation, returned verbatim.

Show child attributes

Exemplo:

{ "contractRef": "A-4471" }

DICT e chaves Pix

Cobranças e BR Codes

Pagamentos e devoluções

API de Pix Automático

Tratamento de erros

Read a recurring series' receipt

Autorizações

Parâmetros de caminho

Resposta