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

Use the Payments API to **collect money** from your customers via mobile money (Orange, MTN, Moov, Wave) in West Africa. You can create a payment, retrieve a single payment, list payments with filters and pagination, and refund completed payments.

## Core operations

<Columns cols={2}>
  <Card title="Create Payment" icon="circle-plus" href="/api-reference/payments/create-payment">
    Initiate a payment to charge a customer's mobile money account (amount in XOF, channel required).
  </Card>

  <Card title="Get Payment" icon="credit-card" href="/api-reference/payments/get-payment">
    Retrieve a single payment by ID.
  </Card>

  <Card title="List Payments" icon="rectangle-list" href="/api-reference/payments/list-payments">
    List payments with optional filters: status, channel, customer\_phone, amount range, date range, and pagination.
  </Card>

  <Card title="Refund Payment" icon="money-bill-transfer" href="/api-reference/payments/refund-payment">
    Refund a completed payment (full or partial) with reason and optional description.
  </Card>
</Columns>

## Payment flow

1. **Create** a payment with amount (XOF), currency (`XOF`), `customer_phone`, and `channel` (`orangeCI`, `mtnCI`, `moovCI`, `waveCI`). Include `Idempotency-Key` header for safe retries.
2. The customer approves the debit on their mobile. Status moves from `pending` to `processing` then `completed` or `failed`.
3. Use **List payments** or **Get payment** to poll status, or rely on **webhooks** for event notifications.
4. For completed payments, use **Refund payment** when needed (with idempotency key).

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