Unsubscribe

POST

/partner-dcb/v1/subscriptions/unsubscribe

Request

Authorization

API Key

Add parameter in header

X-Signature

Example:

X-Signature: ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Accepted / processed

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/partner-dcb/v1/subscriptions/unsubscribe' \
--header 'X-Partner-Id;' \
--header 'X-Api-Key;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Signature: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "msisdn": "6287000000000",
  "product_id": "XL_SUBS_MIA1K",
  "partner_ref_id": "9b5fd712-e940-4fcb-9252-7f5a51219781",
  "payment_method": "XL"
}'

Response Example

{
    "success": true,
    "correlation_id": "80047e82-0000-f900-b63f-84710c7967bb",
    "code": "UNSUBSCRIBED",
    "message": "Unsubscribe request accepted",
    "data": {
        "transaction_id": "a2a35280-0add-47c9-8383-bfe68cb64e0d",
        "partner_ref_id": "5ff21c13-5638-4ce1-9fd8-04664b5e2e45"
    }
}

Modified at 2026-05-13 03:00:44

Confirm OTP

Create one-time charge (OTP flow)