API Reference/Payouts
GET

Retrieve a payout

Retrieve a payout. See the request, response and integration notes.

GET/v1/payouts/{public_id}
https://integrate.api.kyvopay.com.br
cURL
curl -X GET https://api.kyvopay.com.br/v1/payouts/PUBLIC_ID \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN" \
  -H "X-Business-Id: UUID_DA_EMPRESA"
Resposta200 OK
{
  "data": {
    "id": "po_...",
    "status": "paid",
    "amount_centavos": 50000,
    "fee_centavos": 100,
    "net_centavos": 49900,
    "bank_account": {
      "holder_name": "Empresa",
      "pix_key_masked": "***",
      "pix_key_type": "cnpj"
    }
  },
  "error": null,
  "request_id": "req_..."
}

Authentication

X-API-Keystring · headerrequired

Use the ky_... key created under Integrations → API Keys in the KyvoPay dashboard.

Use this endpoint to retrieve a payout.

Request

Note

Private endpoints require the X-API-Key header. Keep credentials on your backend and log the response request_id for diagnostics.

Response

Implementation notes

  • Validate required input before sending the request.
  • Store returned public identifiers without assuming their format.
  • Treat 4xx validation errors as non-retryable until the request is corrected.
  • Retry timeouts, 429 and temporary 5xx responses with exponential backoff.
Need help? Contact support
© 2026 KyvoPay