> ## Documentation Index
> Fetch the complete documentation index at: https://docs.adullam.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

# Adullam REST API Overview

The Adullam REST API lets you integrate with the Adullam payment platform over HTTP. Use it to collect mobile money payments, send transfers, and manage your account. All endpoints use JSON and Bearer token authentication (except get token).

<Card title="Start with Authentication" icon="rocket" horizontal href="/api-reference/authentication/overview">
  Get an access token with phone and password, then use it in the `Authorization` header for all other requests.
</Card>

## Available sections

<Columns cols={2}>
  <Card title="Authentication" icon="key" href="/api-reference/authentication/overview">
    Get token and rotate token.
  </Card>

  <Card title="Account" icon="user" href="/api-reference/account/overview">
    Get account info and balance (XOF).
  </Card>

  <Card title="Payments" icon="credit-card" href="/api-reference/payments/overview">
    Create payments, get or list with filters, and refund.
  </Card>

  <Card title="Transfers" icon="arrow-right-arrow-left" href="/api-reference/transfers/overview">
    Create transfers, get or list with filters, and reverse.
  </Card>
</Columns>

## Authentication

All endpoints except `POST /v1/auth/token` require a Bearer token. Obtain a token with phone and password via `POST /v1/auth/token`, then send it in every request:

```http theme={null}
Authorization: Bearer YOUR_ACCESS_TOKEN
```

You can also use the `x-auth` header with the same token value.

## 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

<Note>
  Need help? Contact us by **email** ([support@adullam.dev](mailto:support@adullam.dev)), **WhatsApp** ([chat](https://wa.me/0103961828)), or **Telegram** ([@adullam\_official](https://t.me/adullam_official)).
</Note>