API Documentation
Complete guide to integrate OctaPay into your application. Simple, powerful, and developer-friendly.
Getting Started
Libraries
Quick Start
Get started with OctaPay API in minutes. Our RESTful API is designed to be simple, predictable, and easy to use.
https://api.octapay.org/v1
Authentication
All API requests require authentication using your API key. Include your key in the Authorization header:
Authorization: Bearer YOUR_API_KEYSecurity Warning
Keep your API keys secure! Never expose them in client-side code or public repositories. Rotate your keys immediately if you suspect a compromise.
Payments
/payments
Create a new payment session for your customer.
Request Body
{
"amount": 5000,
"currency": "EUR",
"description": "Order #12345",
"customer": {
"email": "customer@example.com",
"name": "John Doe"
},
"success_url": "https://yoursite.com/success",
"cancel_url": "https://yoursite.com/cancel"
}Response
{
"id": "pay_1234567890",
"status": "pending",
"amount": 5000,
"currency": "EUR",
"checkout_url": "https://checkout.octapay.org/...",
"created_at": "2024-01-15T10:30:00Z"
}/payments/{id}
Retrieve details of a specific payment.
Webhooks
Receive real-time notifications about payment events.
| Event Type | Description |
|---|---|
payment.succeeded |
Payment completed successfully |
payment.failed |
Payment failed or was declined |
refund.created |
Refund has been issued |
Official SDKs
Need Integration Help?
Our developer support team is here to help you integrate successfully. We can review your code and help debug issues.
Contact Developer Support