Referência

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:

id:

json

{
"id": "bill_uA0M0xwg5R4mSyr0n2PjHQXY",
} 

id : string.
Id único da cobrança na Avantti Finance.

frequency:

json

{
"frequency": "ONE_TIME",
}

frequency : string.
Frequência da cobrança. Pode ser ONE_TIME ou MULTIPLE_PAYMENTS.


`ONE_TIME`	Cobrança que aceita um único pagamento. É necessário enviar os dados do cliente
`MULTIPLE_PAYMENTS`	Cobrança em modo checkout, aceita vários pagamentos. Não é necessário enviar os dados do cliente.

url:

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

amount:

json

{
  "amount": 4000,
}

amount : number.
Valor da cobrança em centavos

status:

json

{
  "status": "PAID",
}

status : string.
Status da cobrança. Pode ser PENDING, EXPIRED, CANCELLED, PAID, REFUNDED


`PENDING`	A cobrança está com o pagamento pendente
`EXPIRED`	O tempo limite de pagamento foi excedido
`CANCELLED`	A cobrança foi cancelada por você
`PAID`	A cobrança foi paga com sucesso pelo cliente
`REFUNDED`	O valor foi devolvido ao cliente

methods:

json

 {
   "methods": ["PIX"],
 }

methods : array
Tipos de pagamento. Suportamos somente PIX no momento.

products:

json

 {
 "products":
 [
   {
     "id": "prod_dNFbdDjfpaegmzBWWdNM2Huw",
     "externalId": "prod-1234",
     "quantity": 1
   }
 ],
 }

products : array
Lista de produtos inclusos na cobrança

customer:

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

metadata:

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

nextBilling:

json

{
  "nextBilling": null,
}

nextBilling : date-time | null.
Data e hora da próxima cobrança, ou null para cobranças únicas

allowCoupons:

json

{
  "allowCoupons": false,
}

allowCoupons : bool | null.
Permite ou não cupons para a cobrança

coupons:

json

{
  "coupons": [],
}

coupons :array
Cupons permitidos na cobrança. Só são considerados os cupons se allowCoupons é verdadeiro.

Comece Aqui

Autenticação

Pix In

Cartão de Crédito

Boleto

Pix Out

Link de Pagamento

Transações e Reembolsos

Assinaturas

Gestão de Conta

Webhooks

Desenvolvedores

Estrutura

Atributos:

Amount:

​ Estrutura

​Atributos:

​Amount:

Estrutura

Atributos:

Amount: