Get boleto by ID

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

package main

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

func main() {

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

	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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

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

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

GET

boletos

{id}

Get boleto by ID

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

package main

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

func main() {

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

	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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

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

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

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Organization-Id

string

Midaz organization the boleto belongs to. Required: a request without it, or with a value that is not a canonical UUID, is refused with 400 PBP-0025. A boleto of another organization is answered 404, exactly as one that does not exist.

Path Parameters

string<uuid>

required

Boleto identifier (UUID).

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

amount

string

required

cancelable

boolean

required

Whether cancelling this boleto would effect a cancellation at the provider. Always present. Derived from the boleto's state, not from any request field: true only for a CREATED boleto that carries a providerId. An already-canceled boleto reads false even though POST /v1/boletos/{id}/cancel answers it 200 as an idempotent replay.

createdAt

string

required

dueDate

string

required

string

required

kind

string

required

ledgerId

string

required

Midaz ledger the boleto was written with. Always present.

midazAccountId

string

required

Midaz account the boleto was issued for: the midazAccountId it was created with. The settlement credit of a settled boleto is posted to this account. Always present.

organizationId

string

required

Midaz organization the boleto was written with. Always present, and always the organization of the X-Organization-Id header.

payer

object

required

Show child attributes

status

string

required

type

string

required

updatedAt

string

required

barcode

string

canceledAt

string

cancellationReason

string

digitableLine

string

discount

object

Show child attributes

errorMessage

string

failedAt

string

fine

object

Show child attributes

guarantor

object

Show child attributes

inactivatedAt

string

installmentLabel

string

instructions

string

interest

object

Show child attributes

midazOperationId

string

ourNumber

string

Bank-side identification of the boleto (nosso numero), as assigned by the provider and printed on the instrument. Read from the barcode and returned in the instrument's form, with leading zeros: the width is set by the connected provider (11 digits for the current one). When the payee supplied ourNumber on issuance, this field still reports the instrument and not the value supplied: if the two differ, the value here is the one printed on the boleto, and the divergence is recorded by the service. Optional: absent for boletos issued before this field existed, and absent while the provider has not produced a valid barcode. Absence means not yet known; the periodic reconciliation fills it in once the provider produces the instrument, with no action needed from the client; it is never sent as an empty string.

Example:

"00000000029"

ourNumberDigit

string

Check digit of ourNumber, computed by the bank and never accepted in a request. Optional: absent whenever the provider did not return it, in which case ourNumber is presented alone, with no trailing hyphen. It is absent in particular when the payee supplied ourNumber: the current provider returns the digit only for numbers it assigned itself. When present, the canonical presentation is {ourNumber}-{ourNumberDigit}.

Example:

"3"

providerId

string

Identifier the payment provider assigned to this boleto. Quote it when you contact the provider about this boleto.

qrCode

string

seriesId

string

settledAmount

string

settledAt

string

Boletos API

Payments API

Dashboards API

Admin API

Webhooks API

Error handling

Get boleto by ID

Authorizations

Headers

Path Parameters

Response