Skip to main content
GET
/
v1
/
payments
/
search
Search payments
curl --request GET \
  --url https://api.adullam.dev/v1/payments/search \
  --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
    }
  ],
  "total_count": 15,
  "has_more": false
}

Search Payments

Searching for payments enables you to find transactions based on specific criteria such as date range, amount, or status. Use the Search Payments API to filter and locate payments that match your search parameters.

Authorizations

Authorization
string
header
required

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

Query Parameters

customer_phone
string
amount_min
integer
amount_max
integer
reference
string

Response

Search results

data
object[]
total_count
integer
Example:

15

has_more
boolean
Example:

false