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.

Poderíamos chamar uma cobrança de portal, checkout, link de pagamento e por aí vai. Mas como você está cobrando seu cliente, nada mais justo que que chamar esse fluxo de cobrança.

Estrutura

Uma cobrança é representada em nossa API pela seguinte estrutura:

{
  "id": "bill_uA0M0xwg5R4mSyr0n2PjHQXY",
  "frequency": "ONE_TIME",
  "url": "https://abacatepay.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,
  "createdAt": "2024-12-06T18:56:15.538Z",
  "updatedAt": "2024-12-06T18:56:15.538Z"
}

Atributos

id string
Id único da cobrança na AbacatePay

frequency string
Frequência da cobrança. Suportamos somente ONE_TIME

url string
URL para seu cliente executar o pagamento da cobrança

amount number
Valor da cobrança em centavos

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

Status	Descrição
`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

devMode boolean
Indica se a cobrança foi criada em dev mode ou não

methods array
Tipos de pagamento. Suportamos somente PIX

products array
Lista de produtos inclusos na cobrança

customer object
Cliente que você está cobrando. Veja referência da estrutura aqui

metadata object
Objeto com os dados do cliente

fee number
Taxa aplicada pela AbacatePay
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 date-time | null
Data e hora da próxima cobrança, ou null para cobranças únicas