Skip to main content
O termo “cobrança” é genérico. Ele representa um portal de um fluxo de pagamento onde você pode cobrar seu cliente e ele fazer todo o processo de pagamento sem nenhuma interrupção. Atualmente uma cobrança pode ser de duas formas:
  • ONE_TIME para cobranças que serão pagas uma única vez. preciso enviar os dados do seu cliente. Para cobrançar ONE_TIME é obrigatório informar o cliente ao criar a cobrança por meio dos campos customerId ou customer.
    • Só é necessário fornecer uma das opções de identificador do cliente: customerId OU customer.
  • MULTIPLE_PAYMENTS é uma cobrança que pode ser paga multiplas vezes e por múltiplas pessoas diferentes. Ex: utilização de um único link de pagamento para vender um produto para múltiplas pessoas.
    • Para cobranças MULTIPLE_PAYMENTS o usuário informará informações como CPF, nome e email na página do checkout.

​
Estrutura

Uma cobrança é representada em nossa API pela seguinte estrutura:
json
{
  "id": "bill_uA0M0xwg5R4mSyr0n2PjHQXY",
  "frequency": "ONE_TIME",
  "url": "https://avanttifinance.com/pay/bill_uA0M0xwg5R4mSyr0n2PjHQXY",
  "amount": 4000,
  "status": "PAID",
  "devMode": true,
  "methods": ["PIX"],
  "products": [
    {
      "id": "prod_dNFbdDjfpaegmzBWWdNM2Huw",
      "externalId": "prod-1234",
      "quantity": 1
    }
  ],
  "customer": {
    "id": "cust_aebxkhDZNaMmJeKsy0AHS0FQ",
    "metadata": {
      "name": "Test Customer",
      "cellphone": "11999999999",
      "taxId": "12345678900",
      "email": "test@example.com"
    }
  },
  "metadata": {
    "fee": 100,
    "returnUrl": "https://example.com/billing",
    "completionUrl": "https://example.com/completion"
  },
  "nextBilling": null,
  "allowCoupons": false,
  "coupons": [],
  "createdAt": "2024-12-06T18:56:15.538Z",
  "updatedAt": "2024-12-06T18:56:15.538Z"
}

​
Atributos:

json
{
"id": "bill_uA0M0xwg5R4mSyr0n2PjHQXY",
}
id : string.
Id único da cobrança na Avantti Finance.
json
{
"frequency": "ONE_TIME",
}
frequency : string.
Frequência da cobrança. Pode ser ONE_TIME ou MULTIPLE_PAYMENTS.
ONE_TIMECobrança que aceita um único pagamento. É necessário enviar os dados do cliente
MULTIPLE_PAYMENTSCobrança em modo checkout, aceita vários pagamentos. Não é necessário enviar os dados do cliente.
json
 {
   "url": "https://avanttifinance.com/pay/bill_uA0M0xwg5R4mSyr0n2PjHQXY",
 }
url : string.
URL para seu cliente executar o pagamento da cobrança

​
Amount:

json
{
  "amount": 4000,
}
amount : number.
Valor da cobrança em centavos
json
{
  "amount": 4000,
}
amount : number.
Valor da cobrança em centavos
json
{
  "status": "PAID",
}
status : string.
Status da cobrança. Pode ser PENDING, EXPIRED, CANCELLED, PAID, REFUNDED
PENDINGA cobrança está com o pagamento pendente
EXPIREDO tempo limite de pagamento foi excedido
CANCELLEDA cobrança foi cancelada por você
PAIDA cobrança foi paga com sucesso pelo cliente
REFUNDEDO valor foi devolvido ao cliente
json
 {
   "methods": ["PIX"],
 }
methods : array
Tipos de pagamento. Suportamos somente PIX no momento.
json
 {
 "products":
 [
   {
     "id": "prod_dNFbdDjfpaegmzBWWdNM2Huw",
     "externalId": "prod-1234",
     "quantity": 1
   }
 ],
 }
products : array
Lista de produtos inclusos na cobrança
json
{
  "customer": {
    "id": "cust_aebxkhDZNaMmJeKsy0AHS0FQ",
    "metadata": {
      "name": "Test Customer",
      "cellphone": "11999999999",
      "taxId": "12345678900",
      "email": "test@example.com"
    }
  }
}
customer : object
Cliente que você está cobrando. Veja referência da estrutura aqui
json
{
  "metadata": {
    "fee": 100,
    "returnUrl": "https://example.com/billing",
    "completionUrl": "https://example.com/completion"
  }
}
metadata : object
Objeto com metadados sobre a cobrança
  • fee number Taxa aplicada pela Avantti Finance
  • returnUrl string URL que o cliente será redirecionado ao clicar no botão “voltar”
  • completionUrl string URL que o cliente será redirecionado ao realizar o pagamento
json
{
  "nextBilling": null,
}
nextBilling : date-time | null.
Data e hora da próxima cobrança, ou null para cobranças únicas
json
{
  "allowCoupons": false,
}
allowCoupons : bool | null.
Permite ou não cupons para a cobrança
json
{
  "coupons": [],
}
coupons :array
Cupons permitidos na cobrança. Só são considerados os cupons se allowCoupons é verdadeiro.