Referência - AbacatePay

Um Link de pagamento é um Checkout que pode ser pago mais de uma vez. Isso facilita quando existe a necessidade de vários clientes pagarem o mesmo valor mas sem que você crie novos checkouts.

Criar link de pagamento

Exemplo:

POST /payment-links/create
{
  "items": [
    {
      "id": "prod_pro",
      "quantity": 1
    }
  ],
  "externalId": "link-promo-123",
  "returnUrl": "https://seusite.com/voltar",
  "completionUrl": "https://seusite.com/sucesso",
  "methods": ["PIX", "CARD"],
  "metadata": {
    "customField": "value"
  }
}

Resposta:

{
  "data": {
    "id": "bill_abc123xyz",
    "externalId": "link-promo-123",
    "url": "https://app.abacatepay.com/pay/bill_abc123xyz",
    "amount": 10000,
    "paidAmount": null,
    "items": [
      {
        "id": "prod_pro",
        "quantity": 1
      }
    ],
    "status": "ACTIVE",
    "frequency": "MULTIPLE_PAYMENTS",
    "coupons": [],
    "devMode": false,
    "customerId": null,
    "returnUrl": "https://seusite.com/voltar",
    "completionUrl": "https://seusite.com/sucesso",
    "receiptUrl": null,
    "metadata": {
      "customField": "value"
    },
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "success": true,
  "error": null
}

Use a url retornada para levar o cliente ao checkout e concluir o pagamento.

Buscar e listar

Use GET /payment-links/get (por ID) e GET /payment-links/list para buscar e listar. O GET /checkouts/list lista só checkouts de pagamento único e não traz links de pagamento.