Getting Started with Yugo API
Welcome to the Yugo Finance API documentation. This guide will help you integrate Yugo's payment solutions into your application.
Overview
Yugo Finance provides two main payment integration options:
| Integration | Use Case | Description |
|---|---|---|
| A2A Payments | Bank-to-bank transfers | Accept payments directly from customer bank accounts using Open Banking |
| Merchant On-ramp | Fiat-to-crypto | Accept fiat payments and receive cryptocurrency payouts |
Quick Start
1. Get Your API Key
Contact Yugo Finance to obtain your API credentials:
- Test API Key - For development and testing
- Live API Key - For production transactions
2. Choose Your Integration
- A2A Payments - Best for direct bank transfers within Europe
- Merchant Hosted - Best for crypto payouts with hosted checkout
3. Make Your First API Call
Test your API key with a simple request:
bash
curl https://api.yugo.finance/transaction/?transactionId=test \
-H "x-api-key: YOUR_API_KEY"Base URL
All API requests should be made to:
https://api.yugo.finance
Authentication
All API requests require authentication via the x-api-key header:
bash
curl https://api.yugo.finance/endpoint \
-H "x-api-key: YOUR_API_KEY"Security Note: Keep your API keys secure. Never expose them in client-side code or public repositories.
Request Format
- Content-Type:
application/json - Method: Varies by endpoint (GET, POST)
- Authentication:
x-api-keyheader
Response Format
All responses are returned as JSON:
json
{
"transactionId": "5d141fb0-dea0-4499-8361-0915807d1151",
"paymentStatus": "AUTHORIZED"
}Error Handling
When an error occurs, the API returns an appropriate HTTP status code with error details. See the Error Handling Guide for more information.
Next Steps
Support
Need help? Contact the Yugo integration team for assistance.