Skip to main content

​
Adullam REST API Overview

The Adullam REST API provides a comprehensive set of endpoints to interact with the Adullam platform. This documentation covers various APIs available for managing payments, payouts, checkout sessions, and more. Each API section includes details about the endpoints, request parameters, and response formats.

​
Available APIs

  • Payout API: Manage and automate payouts to users or vendors.
  • Payment API: Handle payment processing, refunds, and transaction management.
  • Checkout Sessions API: Create and manage checkout sessions for processing payments.
  • Subscription API: Manage subscriptions, billing cycles, and customer plans.

​
Authentication

All API requests require authentication using an API key. Include the API key in the request headers as follows: 
Authorization: Bearer YOUR_API_KEY

​
Error Handling

The Adullam REST API uses standard HTTP status codes to indicate the success or failure of an API request. Common status codes include:
  • 200 OK: The request was successful.
  • 400 Bad Request: The request was invalid or malformed.
  • 401 Unauthorized: Authentication failed or was not provided.
  • 404 Not Found: The requested resource was not found.
  • 500 Internal Server Error: An error occurred on the server.

​
Rate Limiting

To ensure fair usage, the Adullam REST API enforces rate limits on the number of requests that can be made within a specific time frame. If you exceed the rate limit, you will receive a 429 Too Many Requests response.

​
Support

For assistance with the Adullam REST API, please refer to the support documentation or contact our support team at