> ## 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. # Get a boleto batch > Reads one boleto batch of the X-Organization-Id organization: its outcome, its counts and every item, in ascending position. The outcome, the counts, `closed`, `finished` and each item's `overdue` are derived from the items on every read, at the instant of the read. A batch that does not exist and a batch of another organization are both answered 404 PBP-0005, with the same body. A request refused earlier keeps its own status: 401 or 403 for authentication and authorization, 400 PBP-0001 when batch_id is not a UUID, and 400 PBP-0025 when X-Organization-Id is missing or not a canonical UUID. ## OpenAPI ````yaml /es/openapi/v3-current/payments.yaml get /v1/boletos/batches/{batch_id} openapi: 3.1.0 info: description: >- API for the Lerian Payments interface via BTG. It covers boleto issuance, cancellation, and queries; bill payments (bankslip, utilities, and DARF) 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 as an RFC 9457 problem document on application/problem+json. Branch on the code member. A license refusal carries an LCS code, listed in the License Manager error list. title: Payments — via BTG API version: 1.0.0 servers: - url: https://api.example.com description: >- Replace the example host with the URL provided during environment onboarding. 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, and retrieving 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 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/batches/{batch_id}: get: tags: - Boletos summary: Get a boleto batch description: >- Reads one boleto batch of the X-Organization-Id organization: its outcome, its counts and every item, in ascending position. The outcome, the counts, `closed`, `finished` and each item's `overdue` are derived from the items on every read, at the instant of the read. A batch that does not exist and a batch of another organization are both answered 404 PBP-0005, with the same body. A request refused earlier keeps its own status: 401 or 403 for authentication and authorization, 400 PBP-0001 when batch_id is not a UUID, and 400 PBP-0025 when X-Organization-Id is missing or not a canonical UUID. operationId: getBoletoBatch parameters: - description: >- Organization the batch belongs to. Required: a request without it, or with a value that is not a canonical UUID, is refused with 400 PBP-0025. A batch of another organization is answered 404, exactly as one that does not exist. in: header name: X-Organization-Id schema: description: >- Organization the batch belongs to. Required: a request without it, or with a value that is not a canonical UUID, is refused with 400 PBP-0025. A batch of another organization is answered 404, exactly as one that does not exist. type: string - description: >- Batch identifier (UUID), the batchId the creation answered. A value that is not a UUID is refused with 400 PBP-0001. in: path name: batch_id required: true schema: description: >- Batch identifier (UUID), the batchId the creation answered. A value that is not a UUID is refused with 400 PBP-0001. examples: - 0192a3b4-c5d6-7e8f-9a0b-1c2d3e4f5a6b format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BoletoBatchResponse' description: >- The batch with its outcome, its counts and every item, derived at the instant of the read. '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Bad Request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- Authentication failed: the request carries no valid credential, or the credential does not identify a tenant. The error body is an RFC 9457 problem document (`application/problem+json`) with error code `PBP-0003`. Obtain a valid bearer token and send the request again. '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- The authenticated principal is not allowed to perform this request. The error body is an RFC 9457 problem document (`application/problem+json`) with error code `PBP-0004`: the principal lacks permission for this operation, and the permission has to be granted before the request can succeed. '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- Service Unavailable. PBP-0008 means a dependency the request needs, authentication or the tenant's storage, is temporarily unavailable. The request was not processed; wait and send it again. security: - BearerAuth: [] components: schemas: BoletoBatchResponse: additionalProperties: false properties: batchId: description: Batch identifier. examples: - 0192a3b4-c5d6-7e8f-9a0b-1c2d3e4f5a6b format: uuid type: string closed: description: >- Whether every item is SETTLED, CANCELED, INACTIVATED or FAILED: nothing else will happen to the batch, payment included. Always present. It moves back to false when a cancellation is refused and the item returns to CREATED. True implies finished. type: boolean counts: $ref: '#/components/schemas/BoletoBatchCounts' createdAt: description: When the batch was created, RFC 3339 in UTC. examples: - '2026-10-14T19:34:00Z' format: date-time type: string finished: description: >- Whether no item is PENDING: the issuance of the batch is over. Always present. It never moves back to false; an overdue item keeps it false. type: boolean items: description: >- Every item, in ascending position. Never paginated: a batch holds at most 25 items. items: $ref: '#/components/schemas/BoletoBatchItemResponse' type: - array - 'null' ledgerId: description: Ledger of the batch and of each item. examples: - 7c1e5b9a-3d2f-4a6b-8e0c-1f2a3b4c5d6e format: uuid type: string midazAccountId: description: Collection account of the batch and of each item. examples: - 3f9a2c1e-5b7d-4e8f-9a0b-1c2d3e4f5a6b type: string organizationId: description: >- Organization the batch was recorded with: always the organization of the X-Organization-Id header. examples: - 0f9d6c2a-1b3e-4f5a-8c7d-6e5f4a3b2c1d format: uuid type: string status: $ref: '#/components/schemas/BoletoBatchOutcome' required: - items - batchId - organizationId - ledgerId - midazAccountId - status - closed - finished - counts - createdAt type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). 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 BoletoBatchCounts: additionalProperties: false properties: canceled: description: Items CANCELED. examples: - 1 format: int64 minimum: 0 type: integer failed: description: Items FAILED. examples: - 1 format: int64 minimum: 0 type: integer inactivated: description: 'Items INACTIVATED: written off.' examples: - 0 format: int64 minimum: 0 type: integer overdue: description: >- Items still processing past the service's deadline (overdue: true). Never more than processing. examples: - 0 format: int64 minimum: 0 type: integer processing: description: Items PENDING, still being issued. examples: - 1 format: int64 minimum: 0 type: integer registered: description: 'Items CREATED: registered and available for payment.' examples: - 2 format: int64 minimum: 0 type: integer requested: description: 'Number of items requested: the size of the batch.' examples: - 5 format: int64 maximum: 25 minimum: 1 type: integer settled: description: 'Items SETTLED: paid.' examples: - 0 format: int64 minimum: 0 type: integer required: - requested - processing - registered - settled - canceled - inactivated - failed - overdue type: object BoletoBatchItemResponse: additionalProperties: false properties: amount: description: Requested amount, as a decimal string with two decimal places. examples: - '150.00' type: string boletoId: description: >- Identifier of the boleto this item produced: the id GET /v1/boletos/{id}, the PDF and the boleto cancellation take. format: uuid type: string cancelable: description: >- Same meaning as cancelable on GET /v1/boletos/{id}: true only for a CREATED item that carries a providerId. Always present. type: boolean discount: $ref: '#/components/schemas/DiscountResponse' dueDate: description: Requested due date. examples: - '2030-01-15' format: date type: string errorCode: description: >- Product code of the failure. Present only with status FAILED. The list is open; today PBP-0108 when the requested ourNumber is already in use, and PBP-0014 when the item was refused. examples: - PBP-0108 pattern: ^PBP-[0-9]{4}$ type: string errorMessage: description: >- Readable reason of the failure, present only with status FAILED. Written by this service; after provider reported ERROR it may carry, in parentheses, the error code the issuing bank sent. Translate it by errorCode. examples: - no title was issued for this emission maxLength: 500 type: string fine: $ref: '#/components/schemas/FineResponse' instructions: description: >- Instructions requested for the item. Absent when the item carried none. type: string interest: $ref: '#/components/schemas/InterestResponse' ourNumber: description: >- Bank-side identification of the item's boleto (nosso numero), read from the barcode with leading zeros, as GET /v1/boletos/{id} answers it. Absent while the provider has not produced the boleto. examples: - '00000000152' type: string ourNumberDigit: description: >- Check digit of ourNumber, computed by the bank, as GET /v1/boletos/{id} answers it. Absent whenever the provider did not return it. examples: - '3' type: string ourNumberHolderBoletoId: description: >- Boleto that held the requested ourNumber when the item collided with it on creation (errorCode PBP-0108). It may be an earlier issuance of the same charge, so read that boleto before requesting another number. Absent in every other case. type: string overdue: description: >- Whether the item is PENDING past the service's deadline. Derived on every read. It is not a failure: the item is still being processed. Always false outside PENDING. type: boolean payer: $ref: '#/components/schemas/PayerResponse' position: description: >- Position of the item in the request, from 0: its index in the request's items and in body.items[] of a refusal. Add 1 to show it as item n. examples: - 0 format: int64 maximum: 24 minimum: 0 type: integer providerId: description: >- Identifier the payment provider assigned to the item's boleto. Present only once the item is bound to a live boleto at the provider; absent while it is queued or being sent, and on FAILED. type: string requestedOurNumber: description: >- ourNumber requested for the item, in canonical form: no hyphen and no check digit. Absent when the item requested none, and on an item that failed with PBP-0108 on creation. Distinct from ourNumber, which reports the boleto. examples: - '00000000152' type: string status: description: >- Status of the item's boleto, the same GET /v1/boletos/{id} answers. PENDING covers an item queued, sent or still being processed; CREATED is a registered item with barcode and digitable line. An item becomes FAILED only once it is certain that no boleto was registered for it. enum: - PENDING - CREATED - SETTLED - CANCELED - INACTIVATED - FAILED examples: - CREATED type: string required: - position - boletoId - status - overdue - cancelable - amount - dueDate - payer type: object BoletoBatchOutcome: description: >- Issuance outcome of the batch, derived from its items on every read. CREATED: some item is still PENDING. COMPLETED: no item is PENDING and none is FAILED. PARTIAL_FAILURE: no item is PENDING and some, not all, are FAILED; those carry errorCode and errorMessage. FAILED: every item is FAILED. Only issuance moves it: payment, cancellation and write-off do not, and it never moves back to CREATED. enum: - CREATED - COMPLETED - PARTIAL_FAILURE - FAILED type: string 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 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 PayerResponse: additionalProperties: false properties: address: $ref: '#/components/schemas/AddressResponse' document: type: string name: type: string required: - name - document type: object AddressResponse: 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.