> This page is for Internet banking (beta).

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.api.corpx.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.api.corpx.com/_mcp/server.

# Get an issued boleto

GET https://client.api.corpx.com/v1/accounts/{accountId}/boleto/charge/{chargeId}

Always reads the current boleto from the settlement bank, upserts the
local mirror, and returns that live result with `updatedAt` set to the
successful synchronization instant. `chargeId` is the settlement-bank
id returned by the issue call. Requires `boleto_charge`.

A provider failure is returned as an error. This route never falls back
to a stale mirror row.

Reference: https://docs.api.corpx.com/ib/referencia/boleto-charge/get-boleto-charge

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `accountId` (string, required) — Account identifier.
- `chargeId` (string, required) — Settlement-bank id returned by the issue call (`chargeId`).

### Headers

- `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing.
- `X-Request-Timestamp` (string, required) — Unix seconds. Required on the signed host; tolerance is 300s either way (`403 request_timestamp_skew`).
- `X-Content-SHA256` (string, required) — Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns `400 body_hash_mismatch`.
- `X-Request-Signature` (string, required) — Detached JWS (`<protected>..<signature>`, ES256 or PS256) over `METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256`.

## Response

### 200

Boleto

- `chargeId` (string, required) — Settlement-bank id of this boleto. Use it on the item route and in webhooks.
- `identifier` (string, required) — Your idempotency key.
- `status` (enum, required) — Canonical status.
  - Allowed values: `OPEN`, `SETTLED`, `OVERDUE`, `WRITTEN_OFF`, `CANCELLED`, `EXPIRED`
- `updatedAt` (datetime, required) — Last successful synchronization with the settlement bank, in UTC.
- `barcode` (string, optional) — Barcode.
- `digitableLine` (string, optional) — Linha digitável.
- `ourNumber` (string, optional) — Our number at the settlement bank.
- `registrationCondition` (enum, optional) — Registration at the central base. PENDING right after issuance.
  - Allowed values: `REGISTERED`, `PENDING`, `REJECTED`
- `dueDate` (date, optional) — Due date.
- `amount` (BoletoChargeAmount, optional)
- `statusReason` (string, optional) — Present when the settlement bank sent a reason.
- `paymentLimitDate` (date, optional) — Last day payment is accepted.
- `payment` (BoletoChargePayment, optional) — Present after settlement.
- `payer` (BoletoChargePayer, optional)
- `request` (BoletoChargeCreateRequest, optional) — Original normalized issuance request, available on item detail.

## Errors

### 403 Forbidden Error

Requester does not have permission to perform the operation.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

### 404 Not Found Error

Requested resource was not found.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

### 502 Bad Gateway Error

Settlement-bank lookup failed. No stale cached boleto is returned.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

## Types

### BoletoChargeAmount

- `nominal` (double, optional) — Face amount in BRL.
- `updatedAmount` (double, optional) — Amount with interest, fine and discount as of today.
- `currency` (string, optional) — Currency.

### BoletoChargePayment

Present after settlement.

- `amount` (double, optional) — Amount paid, in BRL.
- `settledAt` (datetime, optional) — When it was paid.

### BoletoChargePayer

- `name` (string, optional)
- `taxNumber` (string, optional)
- `personType` (enum, optional)
  - Allowed values: `person`, `company`

### BoletoChargeCreateRequest

One boleto issuance request. `identifier` is required and is the sole idempotency key for this account; `Idempotency-Key` is not a fallback.

- `identifier` (string, required) — Caller-owned idempotency key, unique per account.
- `dueDate` (date, required) — Due date, YYYY-MM-DD.
- `amount` (BoletoChargeCreateRequestAmount, required) — Face amount of the boleto.
- `payer` (BoletoChargeCreateRequestPayer, required) — Who must pay the boleto.
- `issueDate` (date, optional) — Issue date, YYYY-MM-DD. dueDate cannot be before it.
- `interest` (BoletoChargeFee, optional) — Interest or fine. startDate, when set, must be after dueDate.
- `fine` (BoletoChargeFee, optional) — Interest or fine. startDate, when set, must be after dueDate.
- `discount` (BoletoChargeCreateRequestDiscount, optional) — Early-payment discount. Each groups[].limitDate must be before dueDate.
- `abatement` (BoletoChargeCreateRequestAbatement, optional) — Fixed abatement. Together with discounts it must not reach amount.nominal.
- `allowPartialPayment` (boolean, optional) — Accept a payment below the amount.
- `allowDivergentPayment` (boolean, optional) — Accept an amount other than the face value, within min and max.
- `divergentPaymentMode` (enum, optional) — How a divergent payment is bounded.
  - Allowed values: `anyValue`, `minMax`, `minOnly`
- `minPaymentAmount` (double, optional) — Minimum accepted payment when divergent payment is on. Not greater than maxPaymentAmount.
- `maxPaymentAmount` (double, optional) — Maximum accepted payment when divergent payment is on.
- `expirationPolicy` (BoletoChargeCreateRequestExpirationPolicy, optional) — How long the boleto can be paid. There is no write-off of an open boleto; paymentLimitDate is how you bound validity.

### ErrorResponsePartner

Raw error from the settlement bank, when the failure came from it. Diagnostic only.

- `code` (string, optional)
- `message` (string, optional)
- `field` (string, optional) — Field the partner pointed at, when any.

### BoletoChargeCreateRequestAmount

Face amount of the boleto.

- `nominal` (double, required) — Face amount in BRL, greater than zero. Two decimal places, never cents-as-integer.
- `currency` (enum, optional, default: BRL) — Currency. Always BRL.
  - Allowed values: `BRL`

### BoletoChargeCreateRequestPayer

Who must pay the boleto.

- `name` (string, required) — Payer name.
- `personType` (enum, required) — person for CPF, company for CNPJ.
  - Allowed values: `person`, `company`
- `taxNumber` (string, required) — CPF when personType is person, CNPJ when company. Digits only.
- `email` (string, optional) — Payer email.
- `addressStreet` (string, optional) — Street.
- `addressNumber` (string, optional) — Street number.
- `addressComplement` (string, optional) — Complement.
- `addressDistrict` (string, optional) — District.
- `addressCity` (string, optional) — City.
- `addressState` (string, optional) — State, two letters.
- `addressZipCode` (string, optional) — ZIP code, 8 digits.

### BoletoChargeFee

Interest or fine. startDate, when set, must be after dueDate.

- `calculationModel` (enum, optional) — Which institution computes the amounts before and after dueDate. Optional.
  - Allowed values: `receiver-calculates-all`, `recipient-calculates-overdue`, `recipient-calculates-all`
- `typeId` (integer, optional) — Optional. Filled from typeKey when omitted; when sent, it must match typeKey.
- `typeKey` (string, optional) — Fee type. Interest: `exempt`, `fixed-value-calendar-day`, `fixed-value-business-day`, `percentage-calendar-day`, `percentage-business-day`, `percentage-month-calendar-day`, `percentage-month-business-day`, `percentage-year-calendar-day`, `percentage-year-business-day`. Fine: `exempt`, `fixed-value`, `percentage`. Any other value returns 400 `invalid_payload`.
- `value` (double, optional) — Amount in BRL, or a percent when typeKey says percentage. Required and greater than zero unless typeKey is exempt.
- `startDate` (date, optional) — First day the fee applies, YYYY-MM-DD, after dueDate.

### BoletoChargeCreateRequestDiscount

Early-payment discount. Each groups[].limitDate must be before dueDate.

- `calculationModel` (enum, optional) — Which institution computes the discount. Optional.
  - Allowed values: `receiver-calculates-all`, `recipient-calculates-overdue`, `recipient-calculates-all`
- `groups` (list of BoletoChargeCreateRequestDiscountGroupsItems, optional) — Discount steps.

### BoletoChargeCreateRequestAbatement

Fixed abatement. Together with discounts it must not reach amount.nominal.

- `amount` (double, optional) — Abatement in BRL, not negative.

### BoletoChargeCreateRequestExpirationPolicy

How long the boleto can be paid. There is no write-off of an open boleto; paymentLimitDate is how you bound validity.

- `allowPaymentAfterDueDate` (boolean, optional) — Whether payment is accepted after dueDate.
- `paymentLimitDate` (date, optional) — Last day payment is accepted, YYYY-MM-DD, not before dueDate.
- `blockPaymentAfterLimit` (boolean, optional) — Reject payment after paymentLimitDate.
- `decursoGraceDays` (integer, optional) — Grace days after the payment limit.

### BoletoChargeCreateRequestDiscountGroupsItems

- `sequence` (integer, optional) — Step order, starting at 1.
- `typeId` (integer, optional) — Optional. Filled from typeKey when omitted; when sent, it must match typeKey.
- `typeKey` (string, optional) — Discount type: `exempt`, `fixed-value-until-date`, `percentage-until-date`, `fixed-value-anticipation-calendar-day`, `fixed-value-anticipation-business-day`, `percentage-anticipation-calendar-day`, `percentage-anticipation-business-day`. `-until-date` types require limitDate; anticipation types must not send it.
- `value` (double, optional) — Discount amount in BRL, or a percent when typeKey says percentage.
- `limitDate` (date, optional) — Last day this step applies, YYYY-MM-DD, before dueDate. Only for `-until-date` types.

## Examples

**Response**

```json
{
  "chargeId": "8c1f6a2e-4d3b-4b9a-9f0e-1a2b3c4d5e6f",
  "identifier": "order-12345",
  "status": "OPEN",
  "updatedAt": "2026-09-24T14:08:12Z",
  "barcode": "23793381286000782713695000063305975520000015075",
  "digitableLine": "23793381286000782713695000063305975520000015075",
  "ourNumber": "string",
  "registrationCondition": "REGISTERED",
  "dueDate": "2026-02-20",
  "amount": {
    "nominal": 150.75,
    "updatedAmount": 150.75,
    "currency": "BRL"
  },
  "statusReason": "Pagamento pedido #12345",
  "paymentLimitDate": "2026-02-20",
  "payment": {
    "amount": 150.75,
    "settledAt": "2026-02-20T08:33:39Z"
  },
  "payer": {
    "name": "MARIA DA SILVA",
    "taxNumber": "12345678000190",
    "personType": "person"
  }
}
```

**SDK Code**

```python Boleto Charge_getBoletoCharge_example
import requests

url = "https://client.api.corpx.com/v1/accounts/accountId/boleto/charge/chargeId"

headers = {
    "X-Content-SHA256": "X-Content-SHA256",
    "X-Request-Signature": "X-Request-Signature",
    "X-Request-Timestamp": "X-Request-Timestamp",
    "X-Tenant-Id": "X-Tenant-Id",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Boleto Charge_getBoletoCharge_example
const url = 'https://client.api.corpx.com/v1/accounts/accountId/boleto/charge/chargeId';
const options = {
  method: 'GET',
  headers: {
    'X-Content-SHA256': 'X-Content-SHA256',
    'X-Request-Signature': 'X-Request-Signature',
    'X-Request-Timestamp': 'X-Request-Timestamp',
    'X-Tenant-Id': 'X-Tenant-Id',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Boleto Charge_getBoletoCharge_example
package main

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

func main() {

	url := "https://client.api.corpx.com/v1/accounts/accountId/boleto/charge/chargeId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Content-SHA256", "X-Content-SHA256")
	req.Header.Add("X-Request-Signature", "X-Request-Signature")
	req.Header.Add("X-Request-Timestamp", "X-Request-Timestamp")
	req.Header.Add("X-Tenant-Id", "X-Tenant-Id")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Boleto Charge_getBoletoCharge_example
require 'uri'
require 'net/http'

url = URI("https://client.api.corpx.com/v1/accounts/accountId/boleto/charge/chargeId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Content-SHA256"] = 'X-Content-SHA256'
request["X-Request-Signature"] = 'X-Request-Signature'
request["X-Request-Timestamp"] = 'X-Request-Timestamp'
request["X-Tenant-Id"] = 'X-Tenant-Id'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Boleto Charge_getBoletoCharge_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://client.api.corpx.com/v1/accounts/accountId/boleto/charge/chargeId")
  .header("X-Content-SHA256", "X-Content-SHA256")
  .header("X-Request-Signature", "X-Request-Signature")
  .header("X-Request-Timestamp", "X-Request-Timestamp")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Boleto Charge_getBoletoCharge_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://client.api.corpx.com/v1/accounts/accountId/boleto/charge/chargeId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Content-SHA256' => 'X-Content-SHA256',
    'X-Request-Signature' => 'X-Request-Signature',
    'X-Request-Timestamp' => 'X-Request-Timestamp',
    'X-Tenant-Id' => 'X-Tenant-Id',
  ],
]);

echo $response->getBody();
```

```csharp Boleto Charge_getBoletoCharge_example
using RestSharp;

var client = new RestClient("https://client.api.corpx.com/v1/accounts/accountId/boleto/charge/chargeId");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Content-SHA256", "X-Content-SHA256");
request.AddHeader("X-Request-Signature", "X-Request-Signature");
request.AddHeader("X-Request-Timestamp", "X-Request-Timestamp");
request.AddHeader("X-Tenant-Id", "X-Tenant-Id");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Boleto Charge_getBoletoCharge_example
import Foundation

let headers = [
  "X-Content-SHA256": "X-Content-SHA256",
  "X-Request-Signature": "X-Request-Signature",
  "X-Request-Timestamp": "X-Request-Timestamp",
  "X-Tenant-Id": "X-Tenant-Id",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://client.api.corpx.com/v1/accounts/accountId/boleto/charge/chargeId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```