Listar cobranças · Documentação Koku

GET /v1/pix/charges lista as cobranças da conta, das mais recentes para as mais antigas. Escopo: charges:read. Referência: Listar cobranças.

GET/v1/pix/charges

curl -X GET 'https://api.kokupay.com/v1/pix/charges?status=paid&limit=50' \
  -H "Authorization: Bearer $KOKU_API_KEY"

const response = await fetch('https://api.kokupay.com/v1/pix/charges?status=paid&limit=50', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KOKU_API_KEY}`,
  },
});

const data = await response.json();
console.log(response.status, data);

import os

import requests

response = requests.request(
    "GET",
    "https://api.kokupay.com/v1/pix/charges?status=paid&limit=50",
    headers={
        "Authorization": f"Bearer {os.environ['KOKU_API_KEY']}",
    },
    timeout=30,
)

print(response.status_code, response.json())

<?php

$ch = curl_init('https://api.kokupay.com/v1/pix/charges?status=paid&limit=50');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('KOKU_API_KEY'),
    ],
]);

$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
echo $status, PHP_EOL;
print_r($data);

200Resposta

{
  "items": [
    {
      "id": "8d3f6a12-4b9e-4c71-a2d5-6e0f1b3c9a47",
      "gateway_id": "5f0c2a9e-1b7d-4c3e-9a51-2d8e6f4b7c10",
      "environment": "production",
      "order_reference": "PEDIDO-1001",
      "amount_cents": "15990",
      "currency": "BRL",
      "description": "Pedido 1001 - Loja Exemplo",
      "status": "paid",
      "fee_percent_bps": 200,
      "fee_fixed_cents": "0",
      "fee_cents": "320",
      "net_cents": "15670",
      "reserve_cents": "0",
      "refunded_cents": "0",
      "expires_at": "2026-10-07T16:00:00.000Z",
      "paid_at": "2026-10-07T15:32:10.000Z",
      "late_payment": false,
      "is_simulated": false,
      "created_at": "2026-10-07T15:30:00.000Z",
      "updated_at": "2026-10-07T15:32:11.000Z",
      "pix": {
        "qr_code_payload": "00020101021226850014br.gov.bcb.pix2563qr.exemplo.com.br/pix/v2/8d3f6a124b9e4c71a2d56e0f1b3c9a475204000053039865406159.905802BR5913LOJA EXEMPLO6009SAO PAULO62070503***6304A1B2",
        "txid": "8d3f6a124b9e4c71a2d56e0f1b3c9a47",
        "expires_at": "2026-10-07T16:00:00.000Z"
      },
      "end_to_end_id": "E12345678202610071532a1B2c3D4e5F",
      "payments_count": 1,
      "failure_message": null
    }
  ],
  "next_cursor": null
}

Filtros

Parâmetro	Descrição
`status`	Estado: `created`, `pending`, `paid`, `partially_refunded`, `refunded`, `expired`, `cancelled` ou `failed`.
`order_reference`	Seu identificador do pedido (valor exato).
`created_from`	Criadas a partir deste instante (inclusivo, ISO-8601).
`created_to`	Criadas antes deste instante (exclusivo, ISO-8601).
`q`	Busca por referência do pedido, id da cobrança, txid, E2E, nome ou documento do pagador.
`limit`	Itens por página, de 1 a 200.
`cursor`	Valor de `next_cursor` da página anterior.

Paginação por cursor

A resposta traz next_cursor. Enquanto ele não for null, há mais itens: repita a chamada com cursor=<next_cursor> e os mesmos filtros. Veja Paginação.

Para achar a cobrança de um pedido específico, filtre por order_reference.

#Filtros

#Paginação por cursor

Filtros

Paginação por cursor