v2

latestOpenAPI 3.1.02026-07-314524165.2 KB

Buscar um link de pagamento

Retorna os dados de um link de pagamento específico (checkout com frequency MULTIPLE_PAYMENTS) usando o ID.

get/payment-links/get

Query parameters

idstring required

Example:bill_abc123xyz

Identificador único do link de pagamento

Response

Link de pagamento encontrado com sucesso.

errorstring nullable

successboolean

Se a requisição obteve sucesso ou não.

Example response

{
  "data": {
    "id": "bill_abc123xyz",
    "externalId": "pedido-123",
    "url": "https://app.abacatepay.com/pay/bill_abc123xyz",
    "amount": 10000,
    "items": [
      {
        "id": "prod_456",
        "quantity": 2
      }
    ],
    "status": "PENDING",
    "coupons": [],
    "upSellProductId": "prod_bump456xyz",
    "installmentsCount": 3,
    "dueDate": "2026-08-15",
    "interest": {
      "value": 100
    },
    "fine": {
      "value": 200,
      "type": "PERCENTAGE"
    },
    "metadata": {},
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "success": true
}