Pluggy

Pluggy Boleto Management API

Boleto payment management

Documentation GitHub OpenAPI

Operations 5

POST /boleto-connections Connect boleto credentials #

POST /boleto-connections/from-item Create boleto connection from Item #

POST /boletos Issue Boleto #

POST /boletos/{id}/cancel Cancel Boleto #

GET /boletos/{id} Get Boleto #

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/pluggy:pluggy-boleto-management-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Pluggy Boleto Management API
  description: Pluggy's main API to review data and execute connectors
  license:
    name: MIT
  contact:
    email: hello@pluggy.ai
    name: Pluggy
    url: https://pluggy.ai
  version: 1.0.0
servers:
- url: https://api.pluggy.ai
  description: Pluggy API
tags:
- name: Boleto Management
  description: Boleto payment management
paths:
  /boleto-connections:
    post:
      operationId: boleto-connection-create
      summary: Connect boleto credentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBoletoConnection'
        required: true
      responses:
        '200':
          description: Boleto connection created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoletoConnection'
        '400':
          description: Incorrect credentials
          content:
            application/json:
              example:
                message: INVALID_CREDENTIALS
                code: 400
                codeDescription: BOLETO_CONNECTION_CREATION_CREDENTIALS_ERROR
                errorId: 10aa01fe-4587-404e-8ec3-3ae5f6a63a5d
      tags:
      - Boleto Management
      security:
      - default: []
  /boleto-connections/from-item:
    post:
      operationId: boleto-connection-create-from-item
      summary: Create boleto connection from Item
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBoletoConnectionFromItem'
        required: true
      responses:
        '200':
          description: Boleto connection created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoletoConnection'
      tags:
      - Boleto Management
      security:
      - default: []
  /boletos:
    post:
      operationId: boleto-create
      summary: Issue Boleto
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBoleto'
        required: true
      responses:
        '200':
          description: Boleto created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssuedBoleto'
      tags:
      - Boleto Management
      security:
      - default: []
  /boletos/{id}/cancel:
    post:
      operationId: boleto-cancel
      summary: Cancel Boleto
      parameters:
      - description: Boleto primary identifier
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
        example: 82da0d63-fbc0-4e20-b191-50e6df030875
      responses:
        '200':
          description: Boleto cancelled successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssuedBoleto'
      tags:
      - Boleto Management
      security:
      - default: []
  /boletos/{id}:
    get:
      operationId: boleto-get
      summary: Get Boleto
      parameters:
      - description: Boleto primary identifier
        in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
        example: 82da0d63-fbc0-4e20-b191-50e6df030875
      responses:
        '200':
          description: Issued Boleto
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssuedBoleto'
      tags:
      - Boleto Management
      security:
      - default: []
components:
  schemas:
    CreateBoletoConnection:
      description: Request with information to create a boleto connection
      type: object
      required:
      - connectorId
      - credentials
      properties:
        connectorId:
          type: integer
          minimum: 1
          description: Connector identifier. Check out the list of connectors, and if it has the flag 'supportsBoletoManagement' as true, it means it's possible to create a boleto connection with it.
        credentials:
          type: object
          description: 'Credentials required for the connection. For Inter, they are clientId, clientSecret, certificate and privateKey, follow: https://docs.pluggy.ai/docs/connect-an-account#inter-pj'
          additionalProperties:
            type: string
      example:
        connectorId: 225
        credentials:
          clientId: your-client-id
          clientSecret: your-client-secret
          certificate: your-certificate-no-newlines
          privateKey: your-private-key-no-newlines
    CreateBoleto:
      description: Request with information to create a boleto
      type: object
      properties:
        boletoConnectionId:
          type: string
          format: uuid
          description: Primary identifier of the boleto connection
        boleto:
          type: object
          properties:
            seuNumero:
              type: string
              maxLength: 10
              description: Your identifier for this boleto
            amount:
              type: number
              minimum: 2.5
              description: Boleto amount
            dueDate:
              type: string
              format: date-time
              description: Due date for the boleto. Must be today or in the future.
            payer:
              type: object
              properties:
                taxNumber:
                  type: string
                  description: Payer tax number (CPF/CNPJ)
                  example: 33.333.333/0001-33
                name:
                  type: string
                  description: Payer name
                  example: NOME LEGAL EMPRESA
                addressStreet:
                  type: string
                  description: Payer street address
                addressCity:
                  type: string
                  description: Payer city
                addressState:
                  type: string
                  description: Payer state
                addressZipCode:
                  type: string
                  description: Payer ZIP code
              required:
              - taxNumber
              - name
              - addressState
              - addressZipCode
            fine:
              type: object
              description: Fine information for late payment
              properties:
                value:
                  type: number
                  minimum: 0
                  description: Fine value
                type:
                  type: string
                  enum:
                  - PERCENTAGE
                  - FIXED
                  description: Type of fine calculation
              required:
              - value
              - type
            interest:
              type: object
              description: Interest information for late payment
              properties:
                value:
                  type: number
                  minimum: 0
                  description: Interest value
                type:
                  type: string
                  enum:
                  - PERCENTAGE
                  description: Type of interest calculation
              required:
              - value
              - type
          required:
          - seuNumero
          - amount
          - dueDate
          - payer
      required:
      - boletoConnectionId
      - boleto
    IssuedBoleto:
      description: Response with information related to an issued boleto
      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.

            - `OPEN`: the boleto has been issued and is awaiting payment.

            - `PAID`: the boleto has been paid (see `paidAt`, `amountPaid`, `paymentOrigin`).

            - `OVERDUE`: the due date has passed and the boleto has not been paid.

            - `CANCELLED`: the boleto was canceled by the issuer.

            - `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
    BoletoConnection:
      description: Response with information related to a boleto connection
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Primary identifier
        connectorId:
          type: integer
          description: Primary identifier of the connector associated with this connection
        createdAt:
          type: string
          format: date-time
          description: Date when the connection was created
        updatedAt:
          type: string
          format: date-time
          description: Date when the connection was last updated
      required:
      - id
      - connectorId
      - createdAt
      - updatedAt
      example:
        id: dc3537ad-13b4-4770-b248-e4578983899c
        connectorId: 225
        createdAt: '2023-01-01T00:00:00.000Z'
        updatedAt: '2023-01-01T00:00:00.000Z'
    CreateBoletoConnectionFromItem:
      description: Request with information to create a boleto connection from an Item
      type: object
      required:
      - itemId
      properties:
        itemId:
          type: string
          format: uuid
          description: Item ID
      example:
        itemId: 0303c07b-fef0-4903-af9a-007fa086ca8c
  securitySchemes:
    default:
      type: apiKey
      name: X-API-KEY
      in: header
x-provenance:
  method: harvested
  publisher: Pluggy
  source: https://v2.docs.pluggy.ai/openapi/pluggy-api.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)