Pluggy · Schema

IssuedBoleto

Response with information related to an issued boleto

CompanyOpen FinanceBankingFinancial DataPaymentsBrazilFintech

Properties

Name Type Description
id string Primary identifier
amount number Boleto amount
status string Current status of the boleto. - `OPEN`: the boleto has been issued and is awaiting payment. - `PAID`: the boleto has been paid (see `paidAt`, `amountPaid`, `paymentOrigin`). - `OVERDUE`: the due date
seuNumero string Your identifier for this boleto
dueDate string Due date of the boleto
payer object
pixQr string PIX QR code for payment
digitableLine string Boleto digitable line
nossoNumero string Bank's internal identifier for the boleto
barcode string Boleto barcode
boletoConnectionId string ID of the boleto connection used to create this boleto
createdAt string Date when the boleto was created
amountPaid numbernull Amount that was paid for this boleto
paymentOrigin stringnull Origin of the payment when the boleto is paid
fine objectnull Fine information for late payment
interest object Interest information for late payment
paidAt string Date when the boleto was paid
View JSON Schema on GitHub

JSON Schema

pluggy-issued-boleto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pluggy/json-schema/pluggy-issued-boleto-schema.json",
  "title": "IssuedBoleto",
  "description": "Response with information related to an issued boleto",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pluggy-boleto-management-api-openapi.yml#/components/schemas/IssuedBoleto",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Primary identifier"
    },
    "amount": {
      "type": "number",
      "description": "Boleto amount",
      "minimum": 2.5
    },
    "status": {
      "type": "string",
      "description": "Current status of the boleto.\n- `OPEN`: the boleto has been issued and is awaiting payment.\n- `PAID`: the boleto has been paid (see `paidAt`, `amountPaid`, `paymentOrigin`).\n- `OVERDUE`: the due date has passed and the boleto has not been paid.\n- `CANCELLED`: the boleto was canceled by the issuer.\n- `PROTESTED`: the boleto was sent to a protesto/credit-bureau process.",
      "enum": [
        "OPEN",
        "PAID",
        "OVERDUE",
        "CANCELLED",
        "PROTESTED"
      ]
    },
    "seuNumero": {
      "type": "string",
      "maxLength": 10,
      "description": "Your identifier for this boleto"
    },
    "dueDate": {
      "type": "string",
      "format": "date-time",
      "description": "Due date of the boleto"
    },
    "payer": {
      "type": "object",
      "properties": {
        "taxNumber": {
          "type": "string",
          "description": "Payer tax number (CPF/CNPJ)"
        },
        "personType": {
          "type": "string",
          "description": "Type of person (individual or business)"
        },
        "name": {
          "type": "string",
          "description": "Payer name"
        },
        "addressStreet": {
          "type": "string",
          "description": "Payer street address"
        },
        "addressNumber": {
          "type": "string",
          "description": "Payer address number"
        },
        "addressComplement": {
          "type": "string",
          "description": "Additional address information"
        },
        "addressNeighborhood": {
          "type": "string",
          "description": "Payer neighborhood"
        },
        "addressCity": {
          "type": "string",
          "description": "Payer city"
        },
        "addressState": {
          "type": "string",
          "description": "Payer state"
        },
        "addressZipCode": {
          "type": "string",
          "description": "Payer ZIP code"
        },
        "email": {
          "type": "string",
          "description": "Payer email"
        },
        "ddd": {
          "type": "string",
          "description": "Payer area code"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Payer phone number"
        }
      },
      "required": [
        "taxNumber",
        "name",
        "addressState",
        "addressZipCode"
      ]
    },
    "pixQr": {
      "type": "string",
      "description": "PIX QR code for payment"
    },
    "digitableLine": {
      "type": "string",
      "description": "Boleto digitable line"
    },
    "nossoNumero": {
      "type": "string",
      "description": "Bank's internal identifier for the boleto"
    },
    "barcode": {
      "type": "string",
      "description": "Boleto barcode"
    },
    "boletoConnectionId": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the boleto connection used to create this boleto"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Date when the boleto was created"
    },
    "amountPaid": {
      "type": [
        "number",
        "null"
      ],
      "description": "Amount that was paid for this boleto"
    },
    "paymentOrigin": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "PIX",
        "BOLETO",
        null
      ],
      "description": "Origin of the payment when the boleto is paid"
    },
    "fine": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "value": {
          "type": "number",
          "minimum": 0,
          "description": "Fine value"
        },
        "type": {
          "type": "string",
          "enum": [
            "PERCENTAGE",
            "FIXED"
          ],
          "description": "Type of fine calculation"
        }
      },
      "description": "Fine information for late payment"
    },
    "interest": {
      "type": "object",
      "properties": {
        "value": {
          "type": "number",
          "minimum": 0,
          "description": "Interest value"
        },
        "type": {
          "type": "string",
          "enum": [
            "PERCENTAGE"
          ],
          "description": "Type of interest calculation"
        }
      },
      "description": "Interest information for late payment"
    },
    "paidAt": {
      "type": "string",
      "format": "date-time",
      "description": "Date when the boleto was paid"
    }
  },
  "required": [
    "id",
    "amount",
    "status",
    "createdAt",
    "seuNumero",
    "dueDate",
    "payer",
    "digitableLine",
    "barcode",
    "boletoConnectionId"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/pluggy-issued-boleto"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.