v1

latestOpenAPI 3.1.02026-07-2656258207.2 KB

Charges

List charges

get/charges

Query parameters

status'succeeded' | 'pending' | 'failed' | 'voided'

The status of the charge.

Example:succeeded

referencestring

A custom identifier to track the transaction, This must be unique across all your transactions.

tostring date-time

The end date and time for a period. This parameter is used in conjunction with the 'from' parameter to define a time range. The value should be in ISO 8601 format.

fromstring date-time

The start date and time for a period. This parameter is used in conjunction with the 'to' parameter to define a time range. The value should be in ISO 8601 format.

customer_idstring

The customer ID

virtual_account_idstring

The virtual account ID

payment_method_idstring

ID of the payment method.

order_idstring

ID of the order.

pageinteger

The page of the data to retrieve. The most recent data entry is on page 1.

sizeinteger

Length of data returned. Defaults to 10.

Headers

X-Trace-Idstring

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

Response

status'success' | 'failed'

messagestring

Example response

{
  "data": [
    {
      "id": "chg_nONgeAGY97",
      "amount": 12.34,
      "fees": [
        {
          "type": "vat",
          "amount": 12.3
        }
      ],
      "billing_details": {
        "email": "cornelius@gmail.com",
        "name": {
          "first": "King",
          "middle": "Leo",
          "last": "LeBron"
        },
        "phone": {
          "country_code": "234",
          "number": "08012345678"
        }
      },
      "currency": "NGN",
      "customer_id": "cus_3XarBILKQS",
      "next_action": {
        "redirect_url": {
          "url": "https://developer-sandbox-ui-sit.flutterwave.cloud/redirects?opay&token=eyJhbGciOiJIUzI1NiJ9.eyJjbGllbnRJZCI6ImNiYThhMTkwLTE2OGUtNGNmZS05NmY5LTE2NDZhYjFhOWNkYiIsImNoYXJnZUlkIjoiY2hnX25PTmdlQUdZOTciLCJzdWIiOiJjYmE4YTE5MC0xNjhlLTRjZmUtOTZmOS0xNjQ2YWIxYTljZGIiLCJpYXQiOjE3MzgzMTc3MTAsImV4cCI6MTczODMxODAxMH0.QgLoZYfNhHJOJJvOsLA9eLoxOjGF0qnuehPMgMP4zD4"
        }
      },
      "payment_method_details": {
        "id": "pmd_WRq7L4TM8p",
        "type": "card",
        "customer_id": "cus_3XarBILKQS",
        "device_fingerprint": "62wd23423rq324323qew1",
        "client_ip": "154.123.220.1",
        "created_datetime": "2024-12-03T13:54:21.546559974Z"
      },
      "redirect_url": "https://www.google.com",
      "status": "succeeded"
    }
  ]
}