Referência

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:

{
  "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,
  "allowCoupons": false,
  "coupons": [],
  "createdAt": "2024-12-06T18:56:15.538Z",
  "updatedAt": "2024-12-06T18:56:15.538Z"
}

​

Atributos: