Pular para o conteúdo principal
GET
/
v1
/
boleto-payments
Listar boletos pagos
curl --request GET \
  --url https://conta-public-api.kiwify.com/v1/boleto-payments \
  --header 'X-PoP-Challenge: <api-key>' \
  --header 'X-PoP-Format: <api-key>' \
  --header 'X-PoP-Signature: <api-key>' \
  --header 'x-access-id: <api-key>'
{
  "payments": [
    {
      "barcode_line": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "id": 123,
      "status": "awaiting_approval",
      "tax_id": "<string>",
      "amount_in_cents": 123,
      "description": "<string>",
      "external_reference_id": "<string>",
      "scheduled_date": "2023-12-25"
    }
  ],
  "next_cursor": "<string>"
}

Autorizações

​
x-access-id
string
header
obrigatório

UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)

​
X-PoP-Challenge
string
header
obrigatório

Unix timestamp in milliseconds (e.g., 1704636800000). Must be within 5 minutes of server time.

​
X-PoP-Format
string
header
obrigatório

Must be 'service-account' for service account authentication

​
X-PoP-Signature
string
header
obrigatório

EdDSA signature of the request in base64 format. Signs: uri:method:body:timestamp

Parâmetros de consulta

​
external_reference_id
string | null
​
limit
integer<int32> | null
Intervalo obrigatório: x >= 0
​
cursor
string | null

Resposta

Boleto payments retrieved successfully

​
payments
object[]
obrigatório
​
next_cursor
string | null