Read a scheduled payment's receipt

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

package main

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

func main() {

	url := "https://api.example.com/spi/v1/scheduled-payments/{schedule_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-payments/{schedule_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-payments/{schedule_id}/receipt"

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

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

print(response.text)

{
  "amount": "<string>",
  "cancellationCutoff": "2023-11-07T05:31:56Z",
  "payee": {
    "accountType": "CACC",
    "ispb": "32074986",
    "name": "Ana Souza",
    "personType": "NATURAL_PERSON",
    "taxId": "39053344705",
    "accountNumber": "123456",
    "branch": "0001"
  },
  "payer": {
    "accountType": "CACC",
    "ispb": "32074986",
    "name": "Ana Souza",
    "personType": "NATURAL_PERSON",
    "taxId": "39053344705",
    "accountNumber": "123456",
    "branch": "0001"
  },
  "scheduleId": "<string>",
  "scheduledAt": "2023-11-07T05:31:56Z",
  "scheduledDate": "2023-12-25",
  "description": "<string>",
  "brCodePayload": "00020101021226900014br.gov.bcb.pix2568qrcodepix.exemplo.com.br/cobv/8f3a1c2d4e5b6f7a8b9c0d1e2f3a4b5c52040000530398654071500.005802BR5919Mercado Central LTDA6008BRASILIA62070503***6304A1B2",
  "txId": "COBV20260910MERCADOCENTRAL0001"
}

{
  "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 scheduled payment's receipt

Returns the proof of what was agreed: the amount, the settlement date, both parties as photographed at creation, and the cancellation deadline the payer was told. It carries no status and no attempt history on purpose — a receipt answers what was committed to, and putting the lifecycle in it would make a document people save go stale the moment the schedule moves.

GET

scheduled-payments

{schedule_id}

receipt

Read a scheduled payment's receipt

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

package main

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

func main() {

	url := "https://api.example.com/spi/v1/scheduled-payments/{schedule_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-payments/{schedule_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-payments/{schedule_id}/receipt"

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

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

print(response.text)

{
  "amount": "<string>",
  "cancellationCutoff": "2023-11-07T05:31:56Z",
  "payee": {
    "accountType": "CACC",
    "ispb": "32074986",
    "name": "Ana Souza",
    "personType": "NATURAL_PERSON",
    "taxId": "39053344705",
    "accountNumber": "123456",
    "branch": "0001"
  },
  "payer": {
    "accountType": "CACC",
    "ispb": "32074986",
    "name": "Ana Souza",
    "personType": "NATURAL_PERSON",
    "taxId": "39053344705",
    "accountNumber": "123456",
    "branch": "0001"
  },
  "scheduleId": "<string>",
  "scheduledAt": "2023-11-07T05:31:56Z",
  "scheduledDate": "2023-12-25",
  "description": "<string>",
  "brCodePayload": "00020101021226900014br.gov.bcb.pix2568qrcodepix.exemplo.com.br/cobv/8f3a1c2d4e5b6f7a8b9c0d1e2f3a4b5c52040000530398654071500.005802BR5919Mercado Central LTDA6008BRASILIA62070503***6304A1B2",
  "txId": "COBV20260910MERCADOCENTRAL0001"
}

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

schedule_id

string

obrigatório

Schedule identifier.

Exemplo:

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

Resposta

amount

string

obrigatório

Amount to settle, in BRL.

cancellationCutoff

string<date-time>

obrigatório

The deadline recorded for this schedule -- the one the payer was told, not one recomputed today.

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

scheduleId

string

obrigatório

Schedule identifier.

scheduledAt

string<date-time>

obrigatório

When the schedule was registered.

scheduledDate

string<date>

obrigatório

Civil settlement date in AAAA-MM-DD.

description

string

The payer's memo, exactly as stored. Not escaped here and not escaped on the way in.

brCodePayload

string

The BR Code the payer submitted, stored and returned VERBATIM -- re-serialising it would break the CRC-16 the standard embeds, and the receipt would show a code that pays nobody. Present only when initiationType is QR_CODE.

Exemplo:

"00020101021226900014br.gov.bcb.pix2568qrcodepix.exemplo.com.br/cobv/8f3a1c2d4e5b6f7a8b9c0d1e2f3a4b5c52040000530398654071500.005802BR5919Mercado Central LTDA6008BRASILIA62070503***6304A1B2"

txId

string

Identifier of the due-date collection this schedule pays, as carried by the BR Code. Present only when initiationType is QR_CODE.

Exemplo:

"COBV20260910MERCADOCENTRAL0001"

DICT e chaves Pix

Cobranças e BR Codes

Pagamentos e devoluções

API de Pix Automático

Tratamento de erros

Read a scheduled payment's receipt

Autorizações

Parâmetros de caminho

Resposta