1. Getting Started
XL DCB API for Partner
  • Getting Started
    • Introduction
    • Authentication
    • Headers
    • Recurring (Subscription)
    • On-Demand (One-Time Charge)
    • Callbacks (Webhooks)
    • Errors & Response Codes
    • Notes (Partner Guidance)
  • Subscriptions
    • Create Subscription (Initiate)
      POST
    • Confirm OTP
      POST
    • Unsubscribe
      POST
  • OnDemand
    • Create one-time charge (OTP flow)
      POST
    • Confirm OTP (execute charge)
      POST
    • Check transaction status
      GET
  1. Getting Started

Recurring (Subscription)

10 - Recurring (Subscription)#

Subscription Flow Overview
AdobeExpressPhotos_1c36a039dd234500b368e098252c2851_CopyEdited.png
The subscription flow is used to activate Digital Content Billing (DCB) subscription services through the partner. The process begins when the partner sends a subscription creation request to the API. The XL DCB system will then process the charging and activate the subscription. Once the subscription is successfully created, the system sends a callback notification to the partner confirming that the user is now subscribed. During the active subscription period, the system automatically performs recurring renewal charges based on the product cycle and sends renewal callbacks to the partner each time a renewal is successfully completed.

10.1 Create Subscription#

AdobeExpressPhotos_c8a0c1c5cb4a47689e58101554e00669_CopyEdited.png
POST /partner-dcb/v1/subscriptions

Request Body#

{
  "msisdn": "6287800000000",
  "product_id": "XL_SUBS_MIA1K",
  "partner_ref_id": "84909a1e-3b8d-4214-877a-cd2c09e218ad",
  "amount": 1110,
  "payment_method": "XL"
}

Response (202)#

{
  "success": true,
  "correlation_id": "80030735-0005-2700-b63f-84710c7967bb",
  "code": "REQUEST_INITIATED",
  "message": "Request initiated",
  "data": {
    "transaction_id": "4c2821dc-61be-42a8-b211-baa65b845380",
    "partner_ref_id": "84909a1e-3b8d-4214-877a-cd2c09e218ad"
  }
}

10.2 Confirm OTP (Subscription)#

AdobeExpressPhotos_e405d32d238c408cbad4fea731f3c688_CopyEdited.png
POST /partner-dcb/v1/subscriptions/{transaction_id}/otp/confirm

Request Body#

{
  "payment_method": "XL",
  "transaction_details": {
    "otp": "809278"
  }
}

Response (200)#

{
  "success": true,
  "correlation_id": "8006f1ea-0000-d000-b63f-84710c7967bb",
  "code": "OTP_CONFIRMED",
  "message": "OTP confirmed. Awaiting final processing from operator.",
  "data": {
    "transaction_id": "4c2821dc-61be-42a8-b211-baa65b845380",
    "partner_ref_id": "84909a1e-3b8d-4214-877a-cd2c09e218ad"
  }
}
note :
fix partner_ref_id di response confirm OTP

10.3 Unsubscribe#

AdobeExpressPhotos_22815c5cdc4f4466aed46ce99a8531be_CopyEdited.png
POST /partner-dcb/v1/subscriptions/unsubscribe

Request Body#

{
  "msisdn": "6287800000000",
  "product_id": "XL_SUBS_MIA1K",
  "partner_ref_id": "9b5fd712-e940-4fcb-9252-7f5a51219781",
  "payment_method": "XL"
}

Response (200)#

{
  "success": true,
  "correlation_id": "80047e82-0000-f900-b63f-84710c7967bb",
  "code": "UNSUBSCRIBED",
  "message": "Unsubscribe request accepted",
  "data": {
    "transaction_id": "TYK-UNS-20260508-5B2A53",
    "partner_ref_id": "5ff21c13-5638-4ce1-9fd8-04664b5e2e45"
  }
}
Modified at 2026-05-13 04:47:16
Previous
Headers
Next
On-Demand (One-Time Charge)
Built with