Skip to main content

Base URL

All API requests should be made to:

Authentication

All API requests require authentication using your API key in the Authorization header:
See Authentication for details.

API Keys

Get your API keys from the Dashboard. API keys follow this format:
Never expose your API keys in client-side code, public repositories, or logs.

Request Format

All POST requests must include:
  • Content-Type: application/json header
  • Valid JSON body

Response Format

Success Response

All successful responses return JSON with a data field:

Error Response

Error responses include an error message and appropriate HTTP status code:
HTTP status codes indicate the type of error:
  • 400 - Bad Request (invalid parameters)
  • 401 - Unauthorized (invalid or missing API key)
  • 404 - Not Found (resource doesn’t exist)
  • 429 - Too Many Requests (rate limit exceeded)
  • 500 - Internal Server Error

Pagination

List endpoints support pagination using query parameters:
Parameters:
  • page - Page number (default: 1)
  • limit - Items per page (default: 10, max: 100)
Response includes pagination metadata:

Rate Limits

API requests are rate limited to prevent abuse:
  • Production: 100 requests per minute per API key
  • Rate limit headers are included in responses:
When rate limited, you’ll receive a 429 Too Many Requests response:
See Rate Limits for details.

Idempotency

To prevent duplicate payments from network issues or retries, include an idempotency key:
Requests with the same idempotency key within 24 hours will return the same result without creating a duplicate payment.

Versioning

The API version is included in the URL path:
We maintain backwards compatibility within major versions. Breaking changes will be released as new versions (v2, v3, etc.) with migration guides.

Available Endpoints

Payments

Create and manage payments:

Create Payment

POST /api/v1/payments

Retrieve Payment

GET /api/v1/payments/:id

SDK Libraries

Official SDKs coming soon. For now, use the REST API directly with your preferred HTTP client.

Node.js

PHP

Python

Testing

See Testing Guide for information on testing your integration.

Support

Need help? Check these resources:

Integration Guides

Step-by-step integration tutorials

FAQ

Frequently asked questions

Error Reference

Complete list of error codes

Webhook Documentation

Learn how to handle payment notifications

Changelog

Subscribe to API updates: Dashboard > API Settings Major changes will be announced at least 30 days in advance with migration guides provided.