Skip to main content
The YuvexPay API is organized around REST. It accepts JSON request bodies, returns JSON responses, and uses standard HTTP status codes and verbs.

​
Base URL

https://api.yuvexpay.com
All API requests must be made over HTTPS. The same URL serves both sandbox and production environments — the environment is determined by your API credentials.

​
Authentication

All /v1/* endpoints require a Bearer token obtained from the OAuth token endpoint: 
Authorization: Bearer ypt_abc123...
See the authentication guide for the full OAuth 2.0 client credentials flow.

​
Request headers

HeaderRequiredDescription
AuthorizationYesBearer {access_token}
Content-TypeYes (POST/PATCH)application/json
X-Idempotency-KeyYes (some POST)Unique key for safe retries. See idempotency.

​
Resources

Payments

Create and manage payments via PIX, direct card charges, hosted card checkout, or boleto.

Withdrawals

Transfer BRL funds from your balance via PIX.

Products

Manage your product catalog.

Customers

Store and manage customer records.

Documents

Generate receipts and account statements.

Authentication

Generate and manage API access tokens.