Initialize Redemption Intent

POST

/api/v1/redemption-intents

Initialize a new redemption request. This returns an authorization_url where the customer can complete the redemption. You can optionally pass your unique reference as reference in the request body.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Body Params application/json

Examples

Responses

🟢201Success example

application/json

Body

🟠422Validation error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/redemption-intents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "customer@mail.com",
    "amount": 1500,
    "country_code": "FR",
    "callback_url": "http://localhost.php",
    "ip_address": "195.244.228.89",
    "metadata": {
        "order_id": 1
    }
}'

Response Example

201 - Success

{
    "status": true,
    "message": "Redemption Intent Created",
    "data": {
        "authorization_url": "https://app.ciao.cx/redemptions/checkout/HrDE6QIL28Tkwpe",
        "reference": "RDM-01K2F8ZC0QTFS938ZXN017YY4A"
    }
}

Modified at 2025-10-24 13:32:36

Redemption Intent (Partners)

Fetch/Verify Redemption Intent