Skip to main content
GET
/
payment-links
/
get
Buscar um link de pagamento
curl --request GET \
  --url https://api.abacatepay.com/v2/payment-links/get \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "bill_abc123xyz",
    "externalId": "pedido-123",
    "url": "https://app.abacatepay.com/pay/bill_abc123xyz",
    "amount": 10000,
    "paidAmount": null,
    "items": [
      {
        "id": "prod_456",
        "quantity": 2
      }
    ],
    "status": "PENDING",
    "coupons": [],
    "devMode": false,
    "customerId": null,
    "returnUrl": null,
    "completionUrl": null,
    "receiptUrl": null,
    "upSellProductId": "prod_bump456xyz",
    "installmentsCount": 3,
    "interest": {
      "value": 100
    },
    "fine": {
      "value": 200,
      "type": "PERCENTAGE"
    },
    "metadata": {},
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "error": null,
  "success": true
}
Retorna os dados de um link de pagamento pelo seu id.

Requer a permissão CHECKOUT:READ.
O campo frequency virá como MULTIPLE_PAYMENTS. Use paidAmount para acompanhar o total arrecadado via esse link ao longo do tempo.

Authorizations

​
Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

​
id
string
required

Identificador único do link de pagamento

Example:

"bill_abc123xyz"

Response

Link de pagamento encontrado com sucesso.

​
data
object
​
error
string | null
Example:

null

​
success
boolean

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

Example:

true