List payment intents

GET

/payment-intents

Retrieves a paginated list of payment intents belonging to the authenticated entity, newest first. Supports filtering by account, payment page, invoice, status (single or multiple), a created-date range, and a free-text search across the counterparty's name/email and the intent's client reference. Excludes intents in the internal ongoing state (reserved for rolling intents such as virtual cards) — these never appear in list results regardless of the filters supplied.

Each returned intent includes its counterparty (if one is attached) and its most recent intent_action (if one exists), but never the underlying payment_instrument on that action — fetch a single intent action directly if you need instrument details.

Use cursor-based pagination via cursor and limit to page through results; do not rely on offsets.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Payment intents matching the given filters were retrieved successfully.

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location '/payment-intents?account_id=01HXYZ1234567890ABCDEFGHIJ&payment_page_id=01HPPG1111222233334444EEEE&invoice_id=01HINV5555666677778888FFFF&status=paid&statuses=pending%2Cpaid&search=jane.doe%40example.com&created_from=1754000000000&created_to=1754999999999&include_total=true&cursor=01HXYZ9876543210ZYXWVUTSRQ&limit=20' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Default page with no filters

{
    "message": "Payment intents retrieved successfully",
    "status": "success",
    "data": [
        {
            "id": "01HXYZ9876543210ZYXWVUTSRQ",
            "account_id": "01HXYZ1234567890ABCDEFGHIJ",
            "entity_id": "01HABC9999888877776666ZZZZZ",
            "amount": 50000,
            "currency": "NGN",
            "status": "pending",
            "client_reference": "order_88abc123",
            "created": 1754393520000,
            "updated": 1754393520000
        }
    ],
    "meta": {
        "pagination": {
            "cursor": null,
            "has_more": false,
            "total": null
        }
    }
}

Modified at 2026-09-30 00:29:45

Cancel a payment intent

Retrieve a payment intent