List Payments

Fetch all the initiated payments.

Initialization

GET /payments

The following snippet outlines the parameters to fetch initiated payments.

Name	Description	Type
Status	Payment session status. Available values: pending, captured, settled, failed.	String

Responses

Code	Description
200	Payment details

{
  "data": [
  {
    "auth_type": "3ds",
    "expires_at": "2024-03-01T08:43:08.110470Z",
    "links": {},
    "message": "Successful",
    "payment": {
      "amount": 50000,
      "cancellation_reason": null,
      "correlation_id": "2549dcf4-d743-11ee-9d95-c6d49632367b",
      "currency": "NGN",
      "customer": {
        "billing_address": {
          "city": "Awolowo Road",
          "country": "NG",
          "line1": "Opposite Sasa Estate",
          "line2": "null",
          "state": "Kwara",
          "zip_code": "23401"
        },
        "email": "[e-mail]",
        "first_name": "Enitan",
        "id": "d05e51df-809e-498a-ac3f-7acfc0b5d35d",
        "last_name": "Michael",
        "phone_number": "[phone]"
      },
      "date": "2024-02-29T20:43:08.344264Z",
      "description": "Deposit",
      "id": "2549c96c-d743-11ee-aa4d-c6d49632367b",
      "metadata": {
        "order": {
          "identifier": "dbf99bd0-262a-46bd-8339-3c741d040dbb",
          "items": [
            {
              "name": "Deposit",
              "type": "digital"
            }
          ]
        }
      },
      "mode": "live",
      "payment_method": {
        "card_number": "417396******9621",
        "expiry_month": 6,
        "expiry_year": 2024,
        "id": "5e21efda-c526-4057-92f6-1b94ee210b47",
        "type": "card"
      },
      "reference": "85d53ab5-92b8-4151-9f8f-a4f12863a911",
      "status": "settled"
    },
    "status": "settled"
  },
  ]
  "pagination": {
    "after": "string",
    "before": "string",
    "limit": 0
  }
}