post
https://{domain}/api/provider/notification
Create an API flow session for a user subscription payment.
This section covers the payment flow process. Use this endpoint to confirm payment status (for initial subscription payments and renewals).
To create an API flow session for user subscription payment, follow these steps:
1. Set the Request Details
- URL:
TBD
2. Add the Required Headers
Authorization Header: The authorization header will be automatically generated when you send the request using your dedicated Basic Auth credentials (Username and Password):
Basic bW9uZGlhLXRlc3Q6V3lrcEJrQWtnNlU5ZTRWYnRXWmFMdTdPQWNnY2s4YXU1WWJYZDBBdA==
| Header | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Generated Basic Auth Token |
3. Prepare the Request Body
Replace productId, paymentDateTime, subscriptionTypeId, msisdn,billedAmount, and the payment event in the body with the pre-defined values.
| Request Body | Description | Required |
|---|---|---|
msisdn | Unique user identifier. | Yes |
productId | The product Id is an internal Id associated to the marketplace | Optional |
subscriptionTypeId | The Id of the subscription type (same as typeId returned in the Product endpoint) | Yes |
event | The payment events. The expect values are "PAYMENT_SUCCESS" in case of successful payments and "PAYMENT_FAILED" in case of failed payments | Yes |
billedAmount | The exact amount attempted or charged for the payment event | Yes |
paymentDateTime | The date and time payment was attempted | Yes |
eventId | A unique session or transaction Id for the event triggered | Yes |
4. Make the Request
Once you’ve set the URL, headers, and body, proceed with a POST request.