Listar Cobranças - Liquerapay

Listar cobranças

curl --request GET \
  --url https://api.liquerapay.com/transparents/list \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.liquerapay.com/transparents/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.liquerapay.com/transparents/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.liquerapay.com/transparents/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.liquerapay.com/transparents/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": "chg_018f8e2d9a5f7b10c3d4",
      "amount": 5000,
      "status": "PAID",
      "txid": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f",
      "brCode": "00020126580014BR.GOV.BCB.PIX0136abc...6304ABCD",
      "createdAt": "2026-04-19T18:32:11.420Z",
      "expiresAt": "2026-04-19T19:02:11.420Z",
      "paidAt": "2026-04-19T18:34:55.000Z",
      "customer": {
        "id": "cust_018f3a2b7c4d7c40a1b2",
        "name": "João Silva",
        "taxId": "12345678900",
        "email": "joao@exemplo.com",
        "phone": "+5511999999999"
      }
    }
  ],
  "pagination": {
    "hasMore": true,
    "next": "eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTE5In0",
    "before": null
  },
  "error": null,
  "success": true
}

{
  "error": "UNAUTHORIZED",
  "message": "Token inválido ou ausente",
  "success": false
}

{
  "error": "FORBIDDEN",
  "message": "Saques estão temporariamente bloqueados para este merchant",
  "success": false
}

GET

transparents

list

Listar cobranças

curl --request GET \
  --url https://api.liquerapay.com/transparents/list \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.liquerapay.com/transparents/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.liquerapay.com/transparents/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.liquerapay.com/transparents/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.liquerapay.com/transparents/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": "chg_018f8e2d9a5f7b10c3d4",
      "amount": 5000,
      "status": "PAID",
      "txid": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f",
      "brCode": "00020126580014BR.GOV.BCB.PIX0136abc...6304ABCD",
      "createdAt": "2026-04-19T18:32:11.420Z",
      "expiresAt": "2026-04-19T19:02:11.420Z",
      "paidAt": "2026-04-19T18:34:55.000Z",
      "customer": {
        "id": "cust_018f3a2b7c4d7c40a1b2",
        "name": "João Silva",
        "taxId": "12345678900",
        "email": "joao@exemplo.com",
        "phone": "+5511999999999"
      }
    }
  ],
  "pagination": {
    "hasMore": true,
    "next": "eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTE5In0",
    "before": null
  },
  "error": null,
  "success": true
}

{
  "error": "UNAUTHORIZED",
  "message": "Token inválido ou ausente",
  "success": false
}

{
  "error": "FORBIDDEN",
  "message": "Saques estão temporariamente bloqueados para este merchant",
  "success": false
}

Lista as cobranças do merchant com paginação por cursor e filtros opcionais.

Filtros

Filtro	Aceita	Exemplo
`id`	ID de uma cobrança específica	`?id=chg_018f8e2d9a5f7b10c3d4`
`email`	E-mail do customer associado	`?email=joao@exemplo.com`
`status`	`PENDING`, `PAID`, `EXPIRED`, `REFUNDED`	`?status=PAID`
`after` / `before`	Cursor opaco retornado em `pagination`	`?after=eyJjcmVhdGVkQXQiOi4uLn0`
`limit`	1 a 100 (padrão 20)	`?limit=50`

Exemplos

# Cobranças pagas
GET /transparents/list?status=PAID&limit=50

# Cobranças de um cliente pelo e-mail
GET /transparents/list?email=joao@exemplo.com

# Próxima página
GET /transparents/list?after=eyJjcmVhdGVkQXQiOi4uLn0

Resposta:

{
  "data": [
    {
      "id": "chg_018f8e2d9a5f7b10c3d4",
      "amount": 5000,
      "status": "PAID",
      "txid": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f",
      "brCode": "00020126580014BR.GOV.BCB.PIX0136abc...6304ABCD",
      "expiresAt": "2026-04-19T19:02:11.420Z",
      "paidAt": "2026-04-19T18:34:55.000Z",
      "customer": {
        "id": "cust_018f3a2b7c4d7c40a1b2",
        "name": "João Silva",
        "taxId": "12345678900",
        "email": "joao@exemplo.com"
      },
      "createdAt": "2026-04-19T18:32:11.420Z"
    }
  ],
  "pagination": {
    "hasMore": false,
    "next": null,
    "before": null
  },
  "error": null,
  "success": true
}

A listagem não retorna o imageBase64 — esse campo só aparece em GET /transparents/check ou na resposta do POST /transparents/create.

Authorizations

Authorization

string

header

required

Autentique suas requisições enviando o token no header Authorization: Bearer <token>.

O token pode ser:

Uma API key com prefixo liq_, gerada em Dashboard Liquerapay → Configurações → API Keys.
Um JWT retornado pelo login do dashboard (uso interno).

Não há distinção de ambiente — toda chave vale para o único ambiente disponível (produção).

Query Parameters

after

string

Cursor opaco (do campo pagination.next da resposta anterior) para buscar a página seguinte.

before

string

Cursor opaco (do campo pagination.before da resposta anterior) para buscar a página anterior.

limit

integer

default:20

Quantidade máxima de itens por página (1 a 100).

Required range: 1 <= x <= 100

string

Filtra por ID exato da cobrança.

Example:

"chg_018f8e2d9a5f7b10c3d4"

string

Filtra por e-mail do customer associado.

Example:

"joao@exemplo.com"

status

enum<string>

Filtra por status da cobrança.

PENDING: QR Code emitido, aguardando pagamento
PAID: pagamento confirmado
EXPIRED: passou do tempo limite sem pagamento
REFUNDED: cobrança paga foi devolvida integralmente
DISPUTED: há uma infração/MED aberta contra o pagamento

Available options:

PENDING,

PAID,

EXPIRED,

REFUNDED,

DISPUTED

Example:

"PAID"

Response

Lista paginada de cobranças.

data

object[]

required

Show child attributes

pagination

object

required

Metadados de paginação bidirecional (usado por Checkout Transparente e Webhooks). next/before são cursores opacos — passe-os de volta em after/before para navegar.

Show child attributes

error

null

required

Example:

null

success

enum<boolean>

required

Available options:

true

Example:

true

⌘I

​Filtros

​Exemplos

Authorizations

Query Parameters

Response

Filtros

Exemplos