Skip to main content

SDKs & Libraries

Accelerate your integration by using official SDKs for TypeScript, Python, Go, PHP, Java, Kotlin, C#, Ruby, and React Native. These libraries simplify API requests, authentication, and error handling, letting you focus on building great payment experiences.

​
Environment URLs

Learn more about Test Mode vs Live Mode.

​
API Key Management and Authentication

1

Access API Keys

Navigate to Developer → API Keys in your dashboard to manage your keys.
2

Generate a New Key

Select Add API Key, provide a descriptive name, and configure write access:
  • Enable write access (checked): Full read and write permissions for all API operations
  • Enable write access (unchecked): Read-only access - can only fetch data (payments, subscriptions, customers, products). Cannot create or modify resources.
Uncheck “Enable write access” for dashboard integrations, analytics tools, and any system that only needs to view data without making changes.
3

Store Your Key Securely

Copy the generated key immediately and ensure it is stored securely.
4

Authenticate Your API Requests

Use your API keys to authenticate all requests. Apply the following authorization format:
Authorization: Bearer YOUR_API_KEY
Never expose your secret API keys in client-side code or public repositories.

​
Response Format

{
  "id": "pay_1234567890",
  "status": "completed",
  "amount": 2999,
  "currency": "USD",
  "created_at": "2024-01-15T10:30:00Z"
}

​
Rate Limits

Our API uses a dual-window rate limiting system with burst protection. Limits are applied based on your authentication method and business tier.

​
Default Limits (Tier 0)

WindowLimit
Per Second (Burst)40 requests
Per Minute (Sustained)240 requests

​
Business Tiers

Higher rate limits are available for businesses with increased API needs:
TierBurst (per second)Sustained (per minute)
Tier 0 (Default)40240
Tier 11001,000
Tier 25005,000
Contact support to upgrade your business to a higher rate limit tier.

​
Unauthenticated Requests

Requests without valid authentication headers are rate limited by IP address:
WindowLimit
Per Second (Burst)20 requests
Per Minute (Sustained)100 requests

​
Rate Limit Headers

Monitor your usage with these response headers:
  • X-RateLimit-Limit - Maximum requests allowed
  • X-RateLimit-Remaining - Requests remaining in current window
  • X-RateLimit-Reset - Time when the rate limit resets
When you exceed rate limits, the API returns a 429 Too Many Requests response. Implement exponential backoff in your retry logic.

​
Error Handling

To effectively manage errors, consult the Error Codes and Transaction Failures sections for detailed guidance.

Error Codes

Delve into comprehensive error details and their resolutions.

Transaction Failures

Gain insights into common transaction issues and their solutions.

​
Webhooks

Receive real-time notifications about payment events. See our Webhook Guide for setup instructions.

Webhook Guide

Set up webhooks for real-time notifications and event handling.