Saques
Consultar as condições de saque
https://api.kokupay.com/v1/payouts/policy Mostra a taxa de saque do seu contrato, o menor valor que pode ser pedido, o limite por saque e quanto já foi pedido hoje e no mês. manual_approval é sempre true para a chave de API: cada pedido feito pela API é analisado por uma pessoa da Koku antes da transferência.
curl -X GET 'https://api.kokupay.com/v1/payouts/policy' \
-H "Authorization: Bearer $KOKU_API_KEY"const response = await fetch('https://api.kokupay.com/v1/payouts/policy', {
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/policy",
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/policy');
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);{
"payout_fee_cents": "500",
"minimum_request_cents": "501",
"execution_channel": "manual_transfer",
"manual_approval": true,
"usage": {
"today_cents": "0",
"month_cents": "0"
},
"per_payout_max_cents": "1500000",
"koku_per_payout_max_cents": "1500000"
}Autenticação
Authorization: Bearer <sua chave de API>
Escopo exigido: payouts:read. Veja Chaves de API.
Resposta 200
payout_fee_centsstring (centavos) ou nullTaxa de saque do seu contrato, em centavos, descontada do valor pedido. null enquanto não há tarifa contratada.
minimum_request_centsstring (centavos) ou nullMenor valor que pode ser pedido, em centavos (a taxa de saque mais um centavo).
execution_channelstringComo o saque é pago: manual_transfer (transferência feita pela Koku depois da aprovação) ou partner (envio automático pela rede de processamento, depois da aprovação).
manual_approvalbooleanotrue quando cada pedido aguarda a análise de uma pessoa da Koku. Para a chave de API é sempre true.
usageobjetoQuanto já foi pedido hoje e no mês (sem os saques recusados, cancelados ou falhos).
usage.today_centsstring (centavos)Valor pedido hoje, em centavos.
usage.month_centsstring (centavos)Valor pedido no mês, em centavos.
per_payout_max_centsstringLimite por saque em vigor para a sua conta, em centavos (o menor entre o teto da Koku e o limite do seu contrato).
koku_per_payout_max_centsstringTeto da Koku por saque, em centavos (R$ 15.000,00). Você pode fazer quantos saques quiser conforme o saldo.
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.