Repasses
Listar repasses feitos pela Koku
GET
https://api.kokupay.com/v1/payouts/by-koku Lista os repasses que a Koku fez para a sua conta bancária sem pedido de saque, conforme o contrato, com a referência da transferência. Cada repasse já foi descontado do saldo disponível. Os saques que você pede pelo painel aparecem no extrato (payout.reserved e payout.paid) e nos eventos payout.*.
GET/v1/payouts/by-koku
curl -X GET 'https://api.kokupay.com/v1/payouts/by-koku' \
-H "Authorization: Bearer $KOKU_API_KEY"const response = await fetch('https://api.kokupay.com/v1/payouts/by-koku', {
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/payouts/by-koku",
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/payouts/by-koku');
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": "4b8f2c6e-1a9d-4e37-8c05-6f3a9d2e7b14",
"amount_cents": "10670",
"external_reference": "E98765432202610081000Zx9Yw8Vu7Ts",
"paid_at": "2026-10-08T10:00:00.000Z"
}
]
}Autenticação
Authorization: Bearer <sua chave de API>
Escopo exigido: payouts:read. Veja Chaves de API.
Resposta 200
itemslista de objetosRepasses feitos pela Koku, do mais recente para o mais antigo.
items[].idstringIdentificador do repasse.
items[].amount_centsstringValor repassado, em centavos.
items[].external_referencestringReferência da transferência (por exemplo, o identificador fim a fim do Pix).
items[].paid_atstringData da transferência.
Erros
| Status | Código | Quando |
|---|---|---|
| 401 | unauthorized | Chave ausente, inválida, revogada ou expirada. |
| 403 | forbidden | A chave não tem o escopo exigido (details.reason = "missing_scope"). |
| 429 | rate_limited | Limite de requisições excedido. Aguarde o tempo de Retry-After. |
| 500 | internal_error | Falha inesperada. Repita com a mesma Idempotency-Key; persistindo, envie o correlation_id à Koku (veja Suporte). |
Formato do corpo de erro em Erros.