API Reference/Introduction

API overview

Conventions, authentication and response formats for the public KyvoPay API.

The API reference describes the public integration contract exposed under /v1.

Base address

https://integrate.api.kyvopay.com.br/v1

Authentication

All private routes require X-API-Key. Public checkout routes under /v1/public/* are the exception. The company is inferred from the credential; never send a business_id supplied by a client.

Request conventions

  • Send and receive JSON unless an endpoint states otherwise.
  • Monetary values are integer cents.
  • Use stable idempotency keys for write operations.
  • Store returned public ids without interpreting their format.

Response envelope

Responses consistently include data, error and request_id. Log the request id for diagnostics.

Security

If an endpoint is not listed in this reference, do not treat it as a supported public integration contract.

Need help? Contact support
© 2026 KyvoPay