Retrieve Redemption Intent

GET

/api/v1/redemption-intents/{reference}

Use this endpoint to check the status of a previously initialized redemption intent. This is useful to confirm whether a voucher was redeemed, is pending, or has failed.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Header Params

Responses

🟢200Success example

application/json

Bodyapplication/json

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/redemption-intents/RDM-01K6NXH9CQ6SDHSM5M6PJ9JAH4' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Success example

{
    "status": true,
    "message": "Redemption Intent retrieved",
    "data": {
        "reference": "ORD_1234",
        "amount": 1000,
        "amount_display": "€10.00",
        "status": "pending",
        "authorization_url": "http://127.0.0.1:8000/redemptions/checkout/3pFsCSh2RfGRpvC",
        "access_code": "3pFsCSh2RfGRpvC",
        "metadata": {
            "order_id": 1
        },
        "callback_url": "http://localhost.php",
        "customer": {
            "email": "customer@mail.com",
            "created_at": "2025-07-01T11:32:13.000000Z",
            "updated_at": "2025-07-01T11:32:13.000000Z"
        },
        "partner": {
            "company_name": "Dietrich, Kihn and Senger",
            "email": "hayes.london@strosin.com"
        },
        "partner_payout_amount": 700,
        "partner_payout_amount_display": "€7.00",
        "platform_fee": 300,
        "platform_fee_display": "€3.00",
        "environment": "live",
        "redeemed_at": null,
        "created_at": "2025-07-01T11:32:13.000000Z",
        "updated_at": "2025-07-01T11:32:13.000000Z",
        "timezone": "Africa/Lagos"
    }
}

Modified at 2026-07-21 12:43:36

Create Redemption Intent

Create Subscription