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 the main API sections for managing accounts, authentication, payments, transfers, and webhooks. Each section includes endpoint details, request parameters, examples, and response formats to help you integrate reliably with Adullam.

Start with Authentication

Learn how to obtain access tokens, rotate credentials, and onboard partners.

​
Available Features

Authentication

Obtain and manage access tokens and partner credentials.

Account

Retrieve account information and balances for your Adullam account.

Payments

Create, confirm, list, search, and refund payments.

Transfers

Initiate single or batch transfers, retrieve and reverse transfers.

Webhooks

Register, retrieve, update, list, and delete webhook endpoints.

​
Authentication

All API requests must be authenticated. See the Authentication section for supported flows (tokens, partner onboarding) and examples on including credentials in the Authorization header, for example: 
Authorization: Bearer YOUR_ACCESS_TOKEN

​
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 [email protected].