Boletos

List boletos

get

/banking/cashin/boletos

List all available boletos

Required scopes

This endpoint requires the following scopes:

Authorizations

Query parameters

entity_idstring · uuidOptional

Unique identifier

virtual_account_idstring · uuidOptional

Unique identifier

bank_account_idstring · uuidOptional

Unique identifier

external_idstringOptional

External ID

counterparty_idstringOptional

Counterparty ID

statusstringOptional

Status

from_datetimestring · date-timeRequired

Datetime schema

to_datetimestring · date-timeRequired

Datetime schema

search_termstringOptional

Search term

beforestringOptional

Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==

afterstringOptional

Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==

limitinteger · min: 10Optional

Limit list

Responses

200

Boletos

application/json

Boleto list response

401

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

get

/banking/cashin/boletos

GET /banking/cashin/boletos?from_datetime=2026-04-02T11%3A12%3A48.180Z&to_datetime=2026-04-02T11%3A12%3A48.180Z HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": [
    {
      "amount": 10000,
      "barcode": "12341111222233334444555566667777888899990000",
      "boleto_url": "https://example.com/boleto_1",
      "description": "description",
      "digitable_line": "12341111222233334444555566667777888899990000",
      "due_detail": {
        "discount": {
          "fixed_until_due": {
            "amounts": [
              {
                "amount": 10,
                "date": "2024-08-13"
              },
              {
                "amount": 9,
                "date": "2024-08-14"
              },
              {
                "amount": 8,
                "date": "2024-08-15"
              }
            ],
            "calculation_type": "amount"
          },
          "per_day_antecipated": {
            "amount": 2,
            "calculation_days": "working",
            "calculation_type": "amount"
          }
        },
        "due_date": "2024-08-10",
        "fine": {
          "amount": 10,
          "calculation_type": "percentage"
        },
        "interest": {
          "amount": 20,
          "calculation_type": "daily_rate"
        }
      },
      "expiration_date": "2024-08-30T23:59:59.999999Z",
      "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
      "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
      "invoice_type": "commercial_duplicate",
      "issue_date": "2024-07-24T10:00:00.000000Z",
      "notes": [
        "note 1",
        "note 2",
        "note 3"
      ],
      "status": "confirmed",
      "virtual_account_id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
      "wallet_type": "direct_electronic_partial_emission_booklet"
    }
  ]
}

Create boleto

post

/banking/cashin/boletos

Creates a new boleto

Required scopes

This endpoint requires the following scopes:

Authorizations

Body

Body params to create a boleto

amountintegerRequired

Amount of the boleto

descriptionstring · max: 25 · nullableOptional

expiration_datestring · dateRequired

external_idstring · max: 40 · nullableOptional

External ID

invoice_typestring · enum · nullableRequired

Boleto invoice type

Possible values:

notesstring[] · max: 3 · nullableOptional

virtual_account_idstring · uuidRequired

Unique identifier

wallet_typestring · enumRequired

Boleto wallet type

Possible values:

Responses

201

Created

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

/banking/cashin/boletos

POST /banking/cashin/boletos HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 939

{
  "amount": 402,
  "counterparty": {
    "address": "Rua Arapongas, 368",
    "city": "Araucaria",
    "district": "Capela Velha",
    "name": "Luiz Paulo Pilegi de Almeida",
    "postal_code": "83706160",
    "state": "PR",
    "tax_number": "09122209964"
  },
  "description": "Pago a trio.com.br",
  "due_detail": {
    "discount": {
      "fixed_until_due": {
        "amounts": [
          {
            "amount": 10,
            "date": "2025-12-13"
          },
          {
            "amount": 9,
            "date": "2025-12-14"
          },
          {
            "amount": 8,
            "date": "2025-12-15"
          }
        ],
        "calculation_type": "amount | percentage"
      },
      "per_day_antecipated": {
        "amount": 10,
        "calculation_days": "working | calendar",
        "calculation_type": "amount | percentage"
      }
    },
    "due_date": "2025-12-16",
    "fine": {
      "amount": 10,
      "calculation_type": "amount | percentage"
    },
    "interest": {
      "amount": 10,
      "calculation_type": "daily_rate | monthly_fee | exempt | bank_control"
    }
  },
  "expiration_date": "2025-12-10",
  "external_id": "external id 123",
  "invoice_type": "invoice",
  "virtual_account_id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
  "wallet_type": "book_entry_electronic_bloquete"
}

{
  "data": {
    "amount": 10000,
    "barcode": "12341111222233334444555566667777888899990000",
    "boleto_url": "https://example.com/boleto_1",
    "description": "description",
    "digitable_line": "12341111222233334444555566667777888899990000",
    "due_detail": {
      "discount": {
        "fixed_until_due": {
          "amounts": [
            {
              "amount": 10,
              "date": "2024-08-13"
            },
            {
              "amount": 9,
              "date": "2024-08-14"
            },
            {
              "amount": 8,
              "date": "2024-08-15"
            }
          ],
          "calculation_type": "amount"
        },
        "per_day_antecipated": {
          "amount": 2,
          "calculation_days": "working",
          "calculation_type": "amount"
        }
      },
      "due_date": "2024-08-10",
      "fine": {
        "amount": 10,
        "calculation_type": "percentage"
      },
      "interest": {
        "amount": 20,
        "calculation_type": "daily_rate"
      }
    },
    "expiration_date": "2024-08-30T23:59:59.999999Z",
    "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
    "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "invoice_type": "commercial_duplicate",
    "issue_date": "2024-07-24T10:00:00.000000Z",
    "notes": [
      "note 1",
      "note 2",
      "note 3"
    ],
    "status": "confirmed",
    "virtual_account_id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "wallet_type": "direct_electronic_partial_emission_booklet"
  }
}

Get boleto

get

/banking/cashin/boletos/{id}

Gets a specific boleto

Required scopes

This endpoint requires the following scopes:

Authorizations

Path parameters

idstring · uuidRequired

Unique identifier

Responses

200

Show

application/json

Boleto list response

401

Unauthorized

application/json

404

Unprocessable Entity

application/json

500

Internal server error

application/json

get

/banking/cashin/boletos/{id}

GET /banking/cashin/boletos/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": [
    {
      "amount": 10000,
      "barcode": "12341111222233334444555566667777888899990000",
      "boleto_url": "https://example.com/boleto_1",
      "description": "description",
      "digitable_line": "12341111222233334444555566667777888899990000",
      "due_detail": {
        "discount": {
          "fixed_until_due": {
            "amounts": [
              {
                "amount": 10,
                "date": "2024-08-13"
              },
              {
                "amount": 9,
                "date": "2024-08-14"
              },
              {
                "amount": 8,
                "date": "2024-08-15"
              }
            ],
            "calculation_type": "amount"
          },
          "per_day_antecipated": {
            "amount": 2,
            "calculation_days": "working",
            "calculation_type": "amount"
          }
        },
        "due_date": "2024-08-10",
        "fine": {
          "amount": 10,
          "calculation_type": "percentage"
        },
        "interest": {
          "amount": 20,
          "calculation_type": "daily_rate"
        }
      },
      "expiration_date": "2024-08-30T23:59:59.999999Z",
      "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
      "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
      "invoice_type": "commercial_duplicate",
      "issue_date": "2024-07-24T10:00:00.000000Z",
      "notes": [
        "note 1",
        "note 2",
        "note 3"
      ],
      "status": "confirmed",
      "virtual_account_id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
      "wallet_type": "direct_electronic_partial_emission_booklet"
    }
  ]
}

Update boleto due date

put

/banking/cashin/boletos/{id}

Updates a boleto due date

Required scopes

This endpoint requires the following scopes:

Authorizations

Path parameters

idstring · uuidRequired

Unique identifier

Body

Body params to update a boleto

Responses

200

Show

application/json

Response for boleto

401

Unauthorized

application/json

500

Internal server error

application/json

put

/banking/cashin/boletos/{id}

PUT /banking/cashin/boletos/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "due_detail": {
    "due_date": "2024-08-10"
  }
}

{
  "data": {
    "amount": 10000,
    "barcode": "12341111222233334444555566667777888899990000",
    "boleto_url": "https://example.com/boleto_1",
    "description": "description",
    "digitable_line": "12341111222233334444555566667777888899990000",
    "due_detail": {
      "discount": {
        "fixed_until_due": {
          "amounts": [
            {
              "amount": 10,
              "date": "2024-08-13"
            },
            {
              "amount": 9,
              "date": "2024-08-14"
            },
            {
              "amount": 8,
              "date": "2024-08-15"
            }
          ],
          "calculation_type": "amount"
        },
        "per_day_antecipated": {
          "amount": 2,
          "calculation_days": "working",
          "calculation_type": "amount"
        }
      },
      "due_date": "2024-08-10",
      "fine": {
        "amount": 10,
        "calculation_type": "percentage"
      },
      "interest": {
        "amount": 20,
        "calculation_type": "daily_rate"
      }
    },
    "expiration_date": "2024-08-30T23:59:59.999999Z",
    "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
    "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "invoice_type": "commercial_duplicate",
    "issue_date": "2024-07-24T10:00:00.000000Z",
    "notes": [
      "note 1",
      "note 2",
      "note 3"
    ],
    "status": "confirmed",
    "virtual_account_id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "wallet_type": "direct_electronic_partial_emission_booklet"
  }
}

Cancel boleto

put

/banking/cashin/boletos/{id}/cancel

Cancel a boleto

Required scopes

This endpoint requires the following scopes:

Authorizations

Path parameters

idstring · uuidRequired

Unique identifier

Responses

200

Show

application/json

Response for boleto

401

Unauthorized

application/json

500

Internal server error

application/json

put

/banking/cashin/boletos/{id}/cancel

PUT /banking/cashin/boletos/{id}/cancel HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": {
    "amount": 10000,
    "barcode": "12341111222233334444555566667777888899990000",
    "boleto_url": "https://example.com/boleto_1",
    "description": "description",
    "digitable_line": "12341111222233334444555566667777888899990000",
    "due_detail": {
      "discount": {
        "fixed_until_due": {
          "amounts": [
            {
              "amount": 10,
              "date": "2024-08-13"
            },
            {
              "amount": 9,
              "date": "2024-08-14"
            },
            {
              "amount": 8,
              "date": "2024-08-15"
            }
          ],
          "calculation_type": "amount"
        },
        "per_day_antecipated": {
          "amount": 2,
          "calculation_days": "working",
          "calculation_type": "amount"
        }
      },
      "due_date": "2024-08-10",
      "fine": {
        "amount": 10,
        "calculation_type": "percentage"
      },
      "interest": {
        "amount": 20,
        "calculation_type": "daily_rate"
      }
    },
    "expiration_date": "2024-08-30T23:59:59.999999Z",
    "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
    "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "invoice_type": "commercial_duplicate",
    "issue_date": "2024-07-24T10:00:00.000000Z",
    "notes": [
      "note 1",
      "note 2",
      "note 3"
    ],
    "status": "confirmed",
    "virtual_account_id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "wallet_type": "direct_electronic_partial_emission_booklet"
  }
}

Add protest

put

/banking/cashin/boletos/{id}/protest/add

Add protest to a boleto

Required scopes

This endpoint requires the following scopes:

Authorizations

Path parameters

idstring · uuidRequired

Unique identifier

Responses

200

Show

application/json

Response for boleto

401

Unauthorized

application/json

500

Internal server error

application/json

put

/banking/cashin/boletos/{id}/protest/add

PUT /banking/cashin/boletos/{id}/protest/add HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": {
    "amount": 10000,
    "barcode": "12341111222233334444555566667777888899990000",
    "boleto_url": "https://example.com/boleto_1",
    "description": "description",
    "digitable_line": "12341111222233334444555566667777888899990000",
    "due_detail": {
      "discount": {
        "fixed_until_due": {
          "amounts": [
            {
              "amount": 10,
              "date": "2024-08-13"
            },
            {
              "amount": 9,
              "date": "2024-08-14"
            },
            {
              "amount": 8,
              "date": "2024-08-15"
            }
          ],
          "calculation_type": "amount"
        },
        "per_day_antecipated": {
          "amount": 2,
          "calculation_days": "working",
          "calculation_type": "amount"
        }
      },
      "due_date": "2024-08-10",
      "fine": {
        "amount": 10,
        "calculation_type": "percentage"
      },
      "interest": {
        "amount": 20,
        "calculation_type": "daily_rate"
      }
    },
    "expiration_date": "2024-08-30T23:59:59.999999Z",
    "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
    "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "invoice_type": "commercial_duplicate",
    "issue_date": "2024-07-24T10:00:00.000000Z",
    "notes": [
      "note 1",
      "note 2",
      "note 3"
    ],
    "status": "confirmed",
    "virtual_account_id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "wallet_type": "direct_electronic_partial_emission_booklet"
  }
}

Remove protest

put

/banking/cashin/boletos/{id}/protest/remove

Remove protest from a boleto

Required scopes

This endpoint requires the following scopes:

Authorizations

Path parameters

idstring · uuidRequired

Unique identifier

Responses

200

Show

application/json

Response for boleto

401

Unauthorized

application/json

500

Internal server error

application/json

put

/banking/cashin/boletos/{id}/protest/remove

PUT /banking/cashin/boletos/{id}/protest/remove HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": {
    "amount": 10000,
    "barcode": "12341111222233334444555566667777888899990000",
    "boleto_url": "https://example.com/boleto_1",
    "description": "description",
    "digitable_line": "12341111222233334444555566667777888899990000",
    "due_detail": {
      "discount": {
        "fixed_until_due": {
          "amounts": [
            {
              "amount": 10,
              "date": "2024-08-13"
            },
            {
              "amount": 9,
              "date": "2024-08-14"
            },
            {
              "amount": 8,
              "date": "2024-08-15"
            }
          ],
          "calculation_type": "amount"
        },
        "per_day_antecipated": {
          "amount": 2,
          "calculation_days": "working",
          "calculation_type": "amount"
        }
      },
      "due_date": "2024-08-10",
      "fine": {
        "amount": 10,
        "calculation_type": "percentage"
      },
      "interest": {
        "amount": 20,
        "calculation_type": "daily_rate"
      }
    },
    "expiration_date": "2024-08-30T23:59:59.999999Z",
    "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
    "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "invoice_type": "commercial_duplicate",
    "issue_date": "2024-07-24T10:00:00.000000Z",
    "notes": [
      "note 1",
      "note 2",
      "note 3"
    ],
    "status": "confirmed",
    "virtual_account_id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "wallet_type": "direct_electronic_partial_emission_booklet"
  }
}

PreviousDynamic QR Codes NextRecurrences

Last updated 13 days ago

Was this helpful?

hashtagList boletos

hashtagCreate boleto

hashtagGet boleto

hashtagUpdate boleto due date

hashtagCancel boleto

hashtagAdd protest

hashtagRemove protest

List boletos

Create boleto

Get boleto

Update boleto due date

Cancel boleto

Add protest

Remove protest