> ## Documentation Index
> Fetch the complete documentation index at: https://docs.en.amplopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create boleto charge

> Create a boleto charge

Creates a boleto charge.

## Body parameters

<ParamField body="identifier" type="string" required>
  Unique identifier for this transaction in your application.
</ParamField>

<ParamField body="amount" type="number" required>
  Transaction amount in BRL.
</ParamField>

<ParamField body="client" type="object" required>
  Customer information.
</ParamField>

<ParamField body="client.name" type="string" required>
  Customer full name.
</ParamField>

<ParamField body="client.email" type="string" required>
  Customer email address.
</ParamField>

<ParamField body="client.phone" type="string" required>
  Customer phone number.
</ParamField>

<ParamField body="client.document" type="string" required>
  Customer document, such as CPF or CNPJ for Brazilian customers.
</ParamField>

<ParamField body="dueDate" type="string">
  Boleto due date in `YYYY-MM-DD` format.
</ParamField>

<ParamField body="callbackUrl" type="string">
  URL that will receive payment status webhook notifications.
</ParamField>

<ParamField body="products" type="array">
  Products included in the transaction.
</ParamField>

<ParamField body="products[].id" type="string" required>
  Product identifier in your application.
</ParamField>

<ParamField body="products[].name" type="string" required>
  Product name.
</ParamField>

<ParamField body="products[].quantity" type="number">
  Product quantity.
</ParamField>

<ParamField body="products[].price" type="number" required>
  Product unit price in BRL.
</ParamField>

<ParamField body="shippingFee" type="number">
  Shipping fee in BRL.
</ParamField>

<ParamField body="extraFee" type="number">
  Additional fee in BRL.
</ParamField>

<ParamField body="discount" type="number">
  Discount amount in BRL.
</ParamField>

<ParamField body="splits" type="array">
  Payment split configuration.
</ParamField>

<ParamField body="metadata" type="object">
  Free-form metadata associated with the transaction.
</ParamField>

## Request example

<RequestExample>
  ```bash theme={null}
  curl --request POST \
    --url https://app.amplopay.com/api/v1/gateway/boleto/receive \
    --header 'Content-Type: application/json' \
    --header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
    --header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI' \
    --data '{
      "identifier": "boleto-123",
      "amount": 150,
      "client": {
        "name": "João da Silva",
        "email": "joao@email.com",
        "phone": "(11) 99999-9999",
        "document": "123.456.789-00"
      },
      "dueDate": "2026-08-25",
      "callbackUrl": "https://example.com/webhooks/payment"
    }'
  ```
</RequestExample>

## Payload example

```json theme={null}
{
  "identifier": "boleto-123",
  "amount": 150,
  "client": {
    "name": "João da Silva",
    "email": "joao@email.com",
    "phone": "(11) 99999-9999",
    "document": "123.456.789-00"
  },
  "dueDate": "2026-08-25",
  "callbackUrl": "https://example.com/webhooks/payment"
}
```

## Response

<ResponseField name="transactionId" type="string" required>
  Transaction ID generated by the Gateway API.
</ResponseField>

<ResponseField name="status" type="string" required>
  Initial transaction status.
</ResponseField>

<ResponseField name="fee" type="number" required>
  Transaction fee amount.
</ResponseField>

<ResponseField name="order" type="object" required>
  Order information and hosted order URL.
</ResponseField>

<ResponseField name="boleto" type="object" required>
  Boleto payment information.
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "transactionId": "transaction_id",
    "status": "PENDING",
    "fee": 2.5,
    "order": {
      "id": "order_id",
      "url": "https://app.amplopay.com/order/order_id"
    },
    "boleto": {
      "barcode": "34191.79001 01043.510047 91020.150008 1 93370000015000",
      "digitableLine": "34191790010104351004791020150008193370000015000",
      "pdfUrl": "https://app.amplopay.com/boleto/transaction_id.pdf"
    }
  }
  ```
</ResponseExample>