List boletos

curl --request GET \
  --url https://payments.sandbox.lerian.net/v1/boletos \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://payments.sandbox.lerian.net/v1/boletos"

	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://payments.sandbox.lerian.net/v1/boletos', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "amount": "<string>",
      "cancelable": true,
      "createdAt": "<string>",
      "dueDate": "<string>",
      "id": "<string>",
      "kind": "<string>",
      "ledgerId": "<string>",
      "midazAccountId": "<string>",
      "organizationId": "<string>",
      "payer": {
        "document": "<string>",
        "name": "<string>",
        "address": {
          "city": "<string>",
          "complement": "<string>",
          "neighborhood": "<string>",
          "number": "<string>",
          "state": "<string>",
          "street": "<string>",
          "zipCode": "<string>"
        }
      },
      "status": "<string>",
      "type": "<string>",
      "updatedAt": "<string>",
      "barcode": "<string>",
      "canceledAt": "<string>",
      "cancellationReason": "<string>",
      "digitableLine": "<string>",
      "discount": {
        "amount": "<string>",
        "limitDate": "<string>",
        "type": "<string>"
      },
      "errorMessage": "<string>",
      "failedAt": "<string>",
      "fine": {
        "amount": "<string>",
        "type": "<string>"
      },
      "guarantor": {
        "document": "<string>",
        "name": "<string>",
        "address": {
          "city": "<string>",
          "complement": "<string>",
          "neighborhood": "<string>",
          "number": "<string>",
          "state": "<string>",
          "street": "<string>",
          "zipCode": "<string>"
        }
      },
      "inactivatedAt": "<string>",
      "installmentLabel": "<string>",
      "instructions": "<string>",
      "interest": {
        "amount": "<string>",
        "type": "<string>"
      },
      "midazOperationId": "<string>",
      "ourNumber": "00000000029",
      "ourNumberDigit": "3",
      "providerId": "<string>",
      "qrCode": "<string>",
      "seriesId": "<string>",
      "settledAmount": "<string>",
      "settledAt": "<string>"
    }
  ],
  "limit": 123,
  "page": 123,
  "total": 123
}

{
  "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>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

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

GET

boletos

List boletos

curl --request GET \
  --url https://payments.sandbox.lerian.net/v1/boletos \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://payments.sandbox.lerian.net/v1/boletos"

	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://payments.sandbox.lerian.net/v1/boletos', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "amount": "<string>",
      "cancelable": true,
      "createdAt": "<string>",
      "dueDate": "<string>",
      "id": "<string>",
      "kind": "<string>",
      "ledgerId": "<string>",
      "midazAccountId": "<string>",
      "organizationId": "<string>",
      "payer": {
        "document": "<string>",
        "name": "<string>",
        "address": {
          "city": "<string>",
          "complement": "<string>",
          "neighborhood": "<string>",
          "number": "<string>",
          "state": "<string>",
          "street": "<string>",
          "zipCode": "<string>"
        }
      },
      "status": "<string>",
      "type": "<string>",
      "updatedAt": "<string>",
      "barcode": "<string>",
      "canceledAt": "<string>",
      "cancellationReason": "<string>",
      "digitableLine": "<string>",
      "discount": {
        "amount": "<string>",
        "limitDate": "<string>",
        "type": "<string>"
      },
      "errorMessage": "<string>",
      "failedAt": "<string>",
      "fine": {
        "amount": "<string>",
        "type": "<string>"
      },
      "guarantor": {
        "document": "<string>",
        "name": "<string>",
        "address": {
          "city": "<string>",
          "complement": "<string>",
          "neighborhood": "<string>",
          "number": "<string>",
          "state": "<string>",
          "street": "<string>",
          "zipCode": "<string>"
        }
      },
      "inactivatedAt": "<string>",
      "installmentLabel": "<string>",
      "instructions": "<string>",
      "interest": {
        "amount": "<string>",
        "type": "<string>"
      },
      "midazOperationId": "<string>",
      "ourNumber": "00000000029",
      "ourNumberDigit": "3",
      "providerId": "<string>",
      "qrCode": "<string>",
      "seriesId": "<string>",
      "settledAmount": "<string>",
      "settledAt": "<string>"
    }
  ],
  "limit": 123,
  "page": 123,
  "total": 123
}

{
  "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>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

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

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Organization-Id

string

Midaz organization whose boletos are listed. Required: a request without it, or with a value that is not a canonical UUID, is refused with 400 PBP-0025. Only boletos of this organization are listed and counted. Declared optional on the schema so that refusal keeps its own code instead of the schema's PBP-0001.

Query Parameters

status

enum<string>

Status filter.

Available options:

PENDING,

CREATED,

SETTLED,

CANCELED,

INACTIVATED,

FAILED

Example:

"CREATED"

kind

enum<string>

Boleto kind filter.

Available options:

SINGLE,

INSTALLMENT

Example:

"SINGLE"

type

enum<string>

Boleto type filter.

Available options:

TRADITIONAL,

QR_CODE,

HYBRID

Example:

"TRADITIONAL"

from

string

Created-from bound, inclusive. A calendar date (YYYY-MM-DD) is a UTC day and starts at its first instant; an RFC 3339 date-time with offset (e.g. 2026-09-30T00:00:00-03:00) is used as the exact instant. A positive offset must be percent-encoded (%2B).

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?(Z|[+-][0-9]{2}:[0-9]{2}))?$

Example:

"2026-01-01"

string

Created-to bound, inclusive. A calendar date (YYYY-MM-DD) is a UTC day and covers it to its last instant; an RFC 3339 date-time with offset (e.g. 2026-09-30T23:59:59.999999-03:00) is used as the exact instant. A positive offset must be percent-encoded (%2B).

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?(Z|[+-][0-9]{2}:[0-9]{2}))?$

Example:

"2026-12-31"

dueDateFrom

string<date>

Due-date lower bound, inclusive.

Example:

"2026-02-01"

dueDateTo

string<date>

Due-date upper bound, inclusive.

Example:

"2026-11-30"

page

integer<int64>

default:1

Page number, one-based.

Required range: x >= 1

Example:

1

limit

integer<int64>

default:20

Items per page.

Required range: 1 <= x <= 100

Example:

20

Response

items

object[] | null

required

Show child attributes

limit

integer<int64>

required

page

integer<int64>

required

total

integer<int64>

required

Boletos API

Payments API

Dashboards API

Admin API

Webhooks API

Error handling

List boletos

Authorizations

Headers

Query Parameters

Response