Create boleto charge

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

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

POST

gateway

boleto

receive

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

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

Creates a boleto charge.

Body parameters

string

required

Unique identifier for this transaction in your application.

number

required

Transaction amount in BRL.

object

required

Customer information.

string

required

Customer full name.

string

required

Customer email address.

string

required

Customer phone number.

string

required

Customer document, such as CPF or CNPJ for Brazilian customers.

string

Boleto due date in YYYY-MM-DD format.

string

URL that will receive payment status webhook notifications.

array

Products included in the transaction.

string

required

Product identifier in your application.

string

required

Product name.

number

Product quantity.

number

required

Product unit price in BRL.

number

Shipping fee in BRL.

number

Additional fee in BRL.

number

Discount amount in BRL.

array

Payment split configuration.

object

Free-form metadata associated with the transaction.

Request example

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

Payload example

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

string

required

Transaction ID generated by the Gateway API.

string

required

Initial transaction status.

number

required

Transaction fee amount.

object

required

Order information and hosted order URL.

object

required

Boleto payment information.

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

⌘I

Getting started

Endpoints

Webhooks

FAQ

Create boleto charge

Body parameters

Request example

Payload example

Response

​Body parameters

​Request example

​Payload example

​Response

Body parameters

Request example

Payload example

Response