Skip to main content
GET
/
v1
/
payments
List payments
curl --request GET \
  --url https://api.adullam.dev/v1/payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "pay_abc123",
      "status": "pending",
      "amount": 5000,
      "currency": "XOF",
      "customer_phone": "+22507987654",
      "customer_name": "KONE ADAMA",
      "channel": "orangeCI",
      "description": "Order #12345",
      "reference": "REF_ABC123",
      "ussd_reference": "MP240115.1030.A12345",
      "fees": 25,
      "net_amount": 4975,
      "metadata": {
        "order_id": "12345"
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "completed_at": "2024-01-15T10:32:00Z",
      "failure_reason": null
    }
  ],
  "has_more": true,
  "next_cursor": "def456"
}

​
List Payments

Retrieving a list of all payments provides an overview of all transactions made through your Adullam account. Use the List Payments API to access a comprehensive list of payments, allowing you to monitor and manage your financial activities.

Authorizations

​
Authorization
string
header
required

Use the access token obtained from /v1/auth/token

Query Parameters

​
status
enum<string>

Filter by payment status

Available options:
created,
pending,
processing,
completed,
failed,
expired,
cancelled
​
limit
integer
default:50

Number of results to return

Required range: 1 <= x <= 100
​
cursor
string

Cursor for pagination

​
customer_phone
string

Filter by customer phone number

​
channel
enum<string>

Filter by payment channel

Available options:
orangeCI,
mtnCI,
moovCI,
waveCI
​
amount_min
integer

Minimum amount filter (in XOF)

​
amount_max
integer

Maximum amount filter (in XOF)

​
created_after
string<date-time>

Filter payments created after this date

​
created_before
string<date-time>

Filter payments created before this date

Response

List of payments

​
data
object[]
​
has_more
boolean
Example:

true

​
next_cursor
string | null
Example:

"def456"