Listar PIX
curl --request GET \
--url https://api.abacatepay.com/v2/pix/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.abacatepay.com/v2/pix/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/pix/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/pix/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/pix/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/pix/list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/pix/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": "txn_abc123xyz",
"status": "PENDING",
"devMode": false,
"receiptUrl": "https://app.abacatepay.com/receipt/txn_abc123xyz",
"amount": 10000,
"platformFee": 100,
"createdAt": "2024-11-04T18:38:28.573Z",
"updatedAt": "2024-11-04T18:38:28.573Z",
"externalId": "pix-123"
}
],
"success": true,
"error": null,
"pagination": {
"hasMore": true,
"next": "<string>",
"before": "<string>"
}
}{
"error": "Token de autenticação inválido ou ausente."
}PIX
Listar PIX
Consulta um envio de PIX pelo id. Apesar do nome, esta rota não pagina nem aceita filtros: id é obrigatório e o contrato é o mesmo de /pix/get.
GET
/
pix
/
list
Listar PIX
curl --request GET \
--url https://api.abacatepay.com/v2/pix/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.abacatepay.com/v2/pix/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/pix/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/pix/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/pix/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/pix/list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/pix/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": "txn_abc123xyz",
"status": "PENDING",
"devMode": false,
"receiptUrl": "https://app.abacatepay.com/receipt/txn_abc123xyz",
"amount": 10000,
"platformFee": 100,
"createdAt": "2024-11-04T18:38:28.573Z",
"updatedAt": "2024-11-04T18:38:28.573Z",
"externalId": "pix-123"
}
],
"success": true,
"error": null,
"pagination": {
"hasMore": true,
"next": "<string>",
"before": "<string>"
}
}{
"error": "Token de autenticação inválido ou ausente."
}Retorna todas as transações PIX enviadas pela sua conta.
Use
Requer a permissão
WITHDRAW: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 Enviar PIX, incluindo status, amount, platformFee e receiptUrl.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
Identificador único do PIX enviado
Example:
"pix_out_abc123xyz"
Identificador do PIX no seu sistema
Example:
"pix-123"
Was this page helpful?