> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Issue a single boleto > Creates a new TRADITIONAL boleto via the banking provider. HYBRID (BolePix) and QR_CODE are out of V1 and are refused with 422 PBP-0006. ## OpenAPI ````yaml /en/openapi/v3-current/payments.yaml post /v1/boletos openapi: 3.1.0 info: description: >- API for the Lerian Payments interface via BTG. It covers boleto issuance, cancellation, installments, and queries; bill payments (bankslip, utilities, and DARF), cancellation, and queries; aggregated boleto and payment dashboards; provider connection and outbound webhook configuration; and the provider webhook receiver for settlement events. ERROR BODIES. A failed request arrives in one of three shapes, and which one you get depends on where the service catches the failure, not on which endpoint you called. The authentication and authorization layer runs ahead of everything else and answers plain text with a bare reason and no error code. A failure that the request pipeline catches next, before the API layer sees it, answers a flat JSON body on application/json; the idempotency check is the pipeline rule you meet most often. Everything the API layer catches answers an RFC 9457 problem document on application/problem+json. Read the media type to tell the two JSON bodies apart. The code member holds the same PBP-NNNN value in both, so branch on it, and handle 401 and 403 by status because a refusal from the authentication layer carries no code. One pipeline refusal is not listed on the operations below: while a first request under the same idempotency key is still in flight, a retry is answered 409 with code PBP-0007 and the flat body. title: Payments — via BTG API version: 1.0.0 servers: - url: https://payments.sandbox.lerian.net security: [] tags: - description: >- Tenant-level setup: connecting the banking provider and configuring where status notifications are delivered. name: Admin - description: >- Issuing, querying and cancelling boletos, including installment series and the rendered PDF. name: Boletos - description: >- Aggregated counts, amounts and breakdowns over a period, for boletos and for payments. name: Dashboards - description: >- Paying bankslips, utility bills and DARF tax slips, and querying or cancelling those payments. name: Payments - description: >- The webhook the payment provider posts settlement events to. Authenticated with a credential agreed with the provider, not with the platform identity used by the rest of this API. name: Settlement paths: /v1/boletos: post: tags: - Boletos summary: Issue a single boleto description: >- Creates a new TRADITIONAL boleto via the banking provider. HYBRID (BolePix) and QR_CODE are out of V1 and are refused with 422 PBP-0006. operationId: createBoleto parameters: - description: >- Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing. in: header name: X-Organization-Id schema: description: >- Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing. type: string - description: >- Client-supplied idempotency key. Required in practice even though the schema marks it optional: a request that omits this header is refused with 400 PBP-0012. in: header name: Idempotency-Key schema: description: >- Client-supplied idempotency key. Required in practice even though the schema marks it optional: a request that omits this header is refused with 400 PBP-0012. type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBoletoRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateBoletoResponse' description: Created '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' application/json: schema: $ref: '#/components/schemas/PipelineError' description: Bad Request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' text/plain: schema: type: string application/json: schema: $ref: '#/components/schemas/PipelineError' description: >- Authentication failed. Two shapes are possible and a client must accept both: the authentication middleware answers `text/plain` with a bare reason (for example `Missing Token`) and carries no error code, while a refusal raised inside the service answers `application/problem+json` with code `PBP-0003`. '403': content: text/plain: schema: type: string description: >- The authenticated principal is not permitted to perform this action. Answered as `text/plain` by the authorization middleware, with no error code. '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' application/json: schema: $ref: '#/components/schemas/PipelineError' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' application/json: schema: $ref: '#/components/schemas/PipelineError' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' application/json: schema: $ref: '#/components/schemas/PipelineError' description: Service Unavailable security: - BearerAuth: [] components: schemas: CreateBoletoRequest: additionalProperties: false properties: amount: description: Amount as a decimal string, at most two decimal places. examples: - '100.00' maxLength: 32 type: string discount: $ref: '#/components/schemas/DiscountRequest' dueDate: description: Due date, YYYY-MM-DD. examples: - '2030-01-15' format: date type: string fine: $ref: '#/components/schemas/FineRequest' guarantor: $ref: '#/components/schemas/GuarantorRequest' instructions: type: string interest: $ref: '#/components/schemas/InterestRequest' midazAccountId: description: Midaz account the boleto settles into. type: string payer: $ref: '#/components/schemas/PayerRequest' type: description: >- Boleto type. Only TRADITIONAL is supported in V1. HYBRID (BolePix) and QR_CODE are refused with 422 PBP-0006. examples: - TRADITIONAL type: string required: - type - payer - amount - dueDate - midazAccountId type: object CreateBoletoResponse: additionalProperties: false properties: amount: type: string barcode: type: string createdAt: type: string digitableLine: type: string discount: $ref: '#/components/schemas/DiscountResponse' dueDate: type: string fine: $ref: '#/components/schemas/FineResponse' id: type: string instructions: type: string interest: $ref: '#/components/schemas/InterestResponse' providerId: type: string qrCode: type: string status: type: string type: type: string required: - id - providerId - status - type - amount - dueDate - createdAt type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object PipelineError: additionalProperties: false description: >- The flat error body. A failure caught before the API layer sees the request answers this shape on the application/json media type, instead of the RFC 9457 problem document. Read the media type to tell the two apart. The idempotency check is the rule that answers this way most often. properties: code: description: >- Stable, machine-readable error code, in the form PBP-NNNN. Branch on this value. It carries the same meaning as the code member of the problem document. examples: - PBP-0013 type: string details: additionalProperties: true description: Optional object carrying further facts about this occurrence. type: - object - 'null' message: description: A human-readable explanation specific to this occurrence. examples: - >- The request body does not match the original request for this idempotency key. type: string title: description: Short label for the condition. examples: - Idempotency Key Conflict type: string required: - code - title - message type: object DiscountRequest: additionalProperties: false properties: amount: description: Discount amount as a decimal string. maxLength: 32 type: string limitDate: description: Last date the discount applies, YYYY-MM-DD. examples: - '2029-12-31' format: date type: string type: description: >- Discount type. Optional: may be omitted, and an empty value is accepted. When a discount is sent, amount and limitDate are required. type: string required: - amount - limitDate type: object FineRequest: additionalProperties: false properties: amount: description: Fine amount as a decimal string. maxLength: 32 type: string type: description: >- Fine type. Optional: may be omitted, and an empty value is accepted. When a fine is sent, amount is required. type: string required: - amount type: object GuarantorRequest: additionalProperties: false properties: address: $ref: '#/components/schemas/AddressRequest' document: description: >- Guarantor CPF or CNPJ. Optional: the checksum is validated only when a value is present. type: string name: description: >- Guarantor full name. Optional: may be omitted, and an empty value is accepted. type: string type: object InterestRequest: additionalProperties: false properties: amount: description: Interest amount as a decimal string. maxLength: 32 type: string type: description: >- Interest type. Optional: may be omitted, and an empty value is accepted. When interest is sent, amount is required. type: string required: - amount type: object PayerRequest: additionalProperties: false properties: address: $ref: '#/components/schemas/AddressRequest' document: description: Payer CPF or CNPJ, digits only. type: string name: description: Payer full name. type: string required: - document - name type: object DiscountResponse: additionalProperties: false properties: amount: type: string limitDate: type: string type: type: string required: - type - amount - limitDate type: object FineResponse: additionalProperties: false properties: amount: type: string type: type: string required: - type - amount type: object InterestResponse: additionalProperties: false properties: amount: type: string type: type: string required: - type - amount type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object AddressRequest: additionalProperties: false properties: city: type: string complement: type: string neighborhood: type: string number: type: string state: type: string street: type: string zipCode: type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````