v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Boleto Management

Connect boleto credentials

post/boleto-connections

Request body

connectorIdinteger required

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.

credentialsobject required

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

Example request

{
  "connectorId": 225,
  "credentials": {
    "clientId": "your-client-id",
    "clientSecret": "your-client-secret",
    "certificate": "your-certificate-no-newlines",
    "privateKey": "your-private-key-no-newlines"
  }
}

Response

Boleto connection created successfully

idstring uuid required

Primary identifier

connectorIdinteger required

Primary identifier of the connector associated with this connection

createdAtstring date-time required

Date when the connection was created

updatedAtstring date-time required

Date when the connection was last updated

Example response

{
  "id": "dc3537ad-13b4-4770-b248-e4578983899c",
  "connectorId": 225,
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z"
}