Retrieve a payment intent

GET

/payment-intents/{id}

Fetch a single payment intent by its unique identifier, scoped to the authenticated entity. The response includes the intent's current state, the counterparty (if one was attached), the primary intent action (the action referenced by the intent, if any), and the full ordered history of every intent action ever taken against this intent — newest first. Use this to check on the status of a payment, inspect why it failed, or read back the customer and instrument details captured during authorization.

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 ********************

Path Params

Responses

🟢200

application/json

The payment intent was found and returned successfully.

Bodyapplication/json

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/payment-intents/01J3KQZM0000000000000000AB' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "message": "Payment intent retrieved successfully",
    "status": "success",
    "data": {
        "id": "01J3KQZM0000000000000000AB",
        "account_id": "01J3KQABC0000000000000000X",
        "entity_id": "01J3KQ0000000000000000ENTT",
        "amount": 50000,
        "currency": "NGN",
        "status": "successful",
        "client_reference": "order_88abc123",
        "description": "Subscription renewal – Pro Plan",
        "client_meta": {
            "plan": "pro",
            "user_id": "usr_abc"
        },
        "created": 1754388720000,
        "updated": 1754392100000,
        "counterparty": {
            "id": "01HCPT0000111122223333AAAA",
            "email": "jane.doe@example.com",
            "first_name": "Jane",
            "last_name": "Doe",
            "phonenumber": "+2348012345678"
        },
        "intent_action": {
            "id": "01HACT1111222233334444BBBBB",
            "action": "authorize",
            "payment_type": "card",
            "amount": 50000,
            "charged_amount": 51000,
            "source_amount": 50000,
            "source_currency": "NGN",
            "exchange_rate": 1,
            "currency": "NGN",
            "applicable_fee": 1000,
            "net_amount": 50000,
            "status": "successful",
            "client_reference": "order_88abc123",
            "created": 1754388900000,
            "updated": 1754389200000,
            "payment_instrument": {
                "id": "01HINS5555666677778888CCCCC",
                "card": {
                    "issuer_name": "First Bank of Nigeria",
                    "masked_pan": "458382xxxxxx1234",
                    "iin_v1": "458382",
                    "iin_v2": "45838200",
                    "last_four": "1234",
                    "expiry_month": "09",
                    "expiry_year": "27",
                    "type": "VISA",
                    "billing_address": null
                }
            }
        },
        "actions": [
            {
                "id": "01HACT1111222233334444BBBBB",
                "action": "authorize",
                "payment_type": "card",
                "amount": 50000,
                "charged_amount": 51000,
                "source_amount": 50000,
                "source_currency": "NGN",
                "exchange_rate": 1,
                "currency": "NGN",
                "applicable_fee": 1000,
                "net_amount": 50000,
                "status": "successful",
                "client_reference": "order_88abc123",
                "created": 1754388900000,
                "updated": 1754389200000,
                "payment_instrument": {
                    "id": "01HINS5555666677778888CCCCC",
                    "card": {
                        "issuer_name": "First Bank of Nigeria",
                        "masked_pan": "458382xxxxxx1234",
                        "iin_v1": "458382",
                        "iin_v2": "45838200",
                        "last_four": "1234",
                        "expiry_month": "09",
                        "expiry_year": "27",
                        "type": "VISA",
                        "billing_address": null
                    }
                }
            }
        ]
    }
}

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

List payment intents

Create an intent action