curl --request GET \
--url https://api.abacatepay.com/v2/payment-links/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.abacatepay.com/v2/payment-links/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.abacatepay.com/v2/payment-links/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.abacatepay.com/v2/payment-links/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.abacatepay.com/v2/payment-links/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.abacatepay.com/v2/payment-links/list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/payment-links/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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,
"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,
"error": null,
"pagination": {
"hasMore": true,
"next": "<string>",
"before": "<string>"
}
}{
"error": "Token de autenticação inválido ou ausente."
}Listar links de pagamento
Lista apenas links de pagamento (checkouts com frequency MULTIPLE_PAYMENTS).
curl --request GET \
--url https://api.abacatepay.com/v2/payment-links/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.abacatepay.com/v2/payment-links/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.abacatepay.com/v2/payment-links/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.abacatepay.com/v2/payment-links/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.abacatepay.com/v2/payment-links/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.abacatepay.com/v2/payment-links/list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/payment-links/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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,
"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,
"error": null,
"pagination": {
"hasMore": true,
"next": "<string>",
"before": "<string>"
}
}{
"error": "Token de autenticação inválido ou ausente."
}frequency: MULTIPLE_PAYMENTS) da sua loja.
CHECKOUT:READ.limit, after e before para paginar e startDate/endDate (YYYY-MM-DD) para filtrar por data de criação. Consulte Paginação e filtro por data. Cada item segue o mesmo formato da resposta do Criar link de pagamento.Authorizations
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
Cursor para buscar itens após este ponto (use o publicId retornado em pagination.next).
Cursor para buscar itens antes deste ponto (use o publicId retornado em pagination.before).
Quantidade de itens por página (1-100).
1 <= x <= 100100
Filtra registros criados a partir desta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (00:00 do dia inicial).
"2026-01-01"
Filtra registros criados até esta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (23:59:59.999 do dia final).
"2026-01-31"
Filtrar por identificador único do link de pagamento
"bill_abc123xyz"
Filtrar por identificador do link no seu sistema
"pedido-123"
Filtrar por status do link de pagamento
PENDING, EXPIRED, CANCELLED, PAID, REFUNDED Busca textual livre
Filtrar pelo identificador do cliente associado
"cust_abc123xyz"
Filtrar por método de pagamento
PIX, CARD, BOLETO Was this page helpful?