API Reference/Transfers
GET
Look up a Pix key
Look up a Pix key. See the request, response and integration notes.
GET
/v1/transfers/pix/lookuphttps://integrate.api.kyvopay.com.br
Authentication
X-API-Keystring · headerrequiredUse the ky_... key created under Integrations → API Keys in the KyvoPay dashboard.
Use this endpoint to look up a pix key.
Request
Send an authenticated GET request to /v1/transfers/pix/lookup.
Note
Private endpoints require the X-API-Key header. Keep credentials on your backend and log the response request_id for diagnostics.
Response
The response uses the standard data, error and request_id envelope.
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.