API Reference/Payouts
POST

Sync payout status

Sync payout status. See the request, response and integration notes.

POST/v1/payouts/{payoutId}/sync
https://integrate.api.kyvopay.com.br
cURL
curl -X POST https://integrate.api.kyvopay.com.br/v1/payouts/{payoutId}/sync \
  -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX"
Resposta200 OK
{
  "data": {
    "amount_centavos": "4990",
    "end_to_end_id": "E12345678202601011200abcdef123456",
    "failure_reason": "string",
    "fee_centavos": "4990",
    "id": "01HZ8K3M5N",
    "net_centavos": "4990",
    "pix_key": "cliente@example.com",
    "pix_key_type": "email",
    "public_id": "01HZ8K3M5N",
    "status": "pending"
  },
  "error": {
    "code": "string",
    "details": {},
    "message": "string"
  },
  "request_id": "req_01HZ8K3M5N"
}

Authentication

X-API-Keystring · headerrequired

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

Use this endpoint to sync payout status. For safe retries, reuse the same idempotency key for the same business operation.

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.
  • Keep the idempotency key stable across retries.
Need help? Contact support
© 2026 KyvoPay