Skip to main content
POST
/
v1
/
boleto
Cria uma cobrança via boleto
curl --request POST \
  --url https://api.avanttifinance.com/v1/boleto \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amountInCents": 10000,
  "description": "Descrição opcional",
  "postbackUrl": "https://seu-dominio.com/webhook",
  "customer": {
    "name": "Nome do Cliente",
    "email": "cliente@email.com",
    "documentType": "cpf",
    "document": "12345678909",
    "phone": "+5511999999999"
  },
  "items": [
    {
      "title": "Produto",
      "tangible": true,
      "quantity": 1,
      "amountInCents": 10000
    }
  ],
  "seller": {
    "name": "Vendedor",
    "documentType": "cpf",
    "document": "12345678909"
  }
}
'
{
  "success": true,
  "message": "Transação criada com sucesso",
  "data": {
    "id": "<string>",
    "boleto": {
      "url": "<string>",
      "barcode": "<string>",
      "digitableLine": "<string>",
      "dueAt": "<string>"
    },
    "status": "pending",
    "fees": 300
  }
}

Authorizations

​
Authorization
string
header
required

Token JWT obtido em POST /auth.

Body

application/json
​
amountInCents
integer
required

Valor total da cobrança em centavos.

Required range: x >= 1
​
customer
object
required
​
description
string
​
postbackUrl
string<uri>

URL que receberá as notificações (webhook) de mudança de status.

​
seller
object
​
items
object[]

Response

Transação criada.

​
success
boolean
Example:

true

​
message
string
Example:

"Transação criada com sucesso"

​
data
object