- Create an API key
- Configure SFTP settings
- Add a health check endpoint
- Add gateway adapter endpoints.
- Subscribe to webhook events
- Define their own private allowlisted attribute names
- Configure activation settings, which includes the ability to:
- Add activation reminder schedules
- Configure a warning and a final activation reminder
- Automatically cancel unactivated subscriptions after a specified number of days from the provisioning date
- Shorten product redemption URLs and tokens
- Manage Reseller policies for Merchant integrations, including:
- Timing of subscription changes (upgrades, downgrades, cancellations)
- Auto-approval of Merchant-initiated product changes
- Enabling or turning off the eligibility service
- Obfuscating customer fields to protect PII (Personally Identifiable Information)
API Key
API keys allow Resellers (Service Providers) to connect to the Partner Ecosystem Management APIs and manage the services from their agreements with Merchants. Resellers can generate an API key in Platform Settings. After the Reseller authenticates with the API key, the Reseller can communicate on the back end with connected Merchants via Partner Ecosystem Management.SFTP Settings
Configuring SFTP settings generates SFTP credentials for the Reseller (Service Provider) and sets up a SFTP location where reports can be generated. After connecting with their credentials via a SFTP program, Resellers can register for reports and download reports via SFTP or the UI.Health Check Endpoints
Health check endpoints allow Partner Ecosystem Management Operations to monitor the health of Resellers’ (Service Providers’) integration and troubleshoot any incidents if they arise. After the Reseller provides a health check endpoint, the Platform Health Status page shows the status of partnered organizations’ integrations with Partner Ecosystem Management as well as the general status of Partner Ecosystem Management.Gateway Adapter Endpoints
Resellers (Service Providers) can easily add gateway adapter endpoints to receive API requests and notifications from Partner Ecosystem Management. Gateway adapter endpoints allow your system to receive and process key information for subscription management. Within Platform Settings > Gateway, Resellers can add the following endpoints:- Notification Partner Ecosystem Management uses this endpoint to send notifications that are intended for the end customer to the Reseller’s notification system. Notifications can contain Partner subscription redemption information or a one-time password, for example. The Reseller can enhance the notification and send it to the end customer if desired.
- Transaction This endpoint allows the Reseller to receive payment requests from the Merchant for statement billing. The Reseller can also use this endpoint to send requests from their billing system at the end of every billing cycle. The payment requests made can be new payments or refunds.
- Account Validate The purpose of this endpoint is for the Reseller (Service Provider) to provide customer account details and confirm the customer’s eligibility to subscribe to the Partner subscription. Customer account details can include the account type, status, and account ID. This can be requested using a customer identifier, such as MSISDN, email, or device ESN.
- Subscription Update Validate Note: This endpoint is for deployments that leverage Partner Ecosystem Management with Commerce Engine. This endpoint is used to approve or decline Merchant-initiated changes in subscriptions, such as plan upgrades or downgrades. When a customer wants to upgrade or downgrade their subscription, the Merchant sends a subscription update approval request to Partner Ecosystem Management. Partner Ecosystem Management then sends the subscription update approval request to the Reseller. The Reseller approves or declines the subscription update. Partner Ecosystem Management then sends the response to the Merchant. If the update is approved, the Merchant makes the change to the subscription.
- Entitlement Update Validate Note: This endpoint is for Resellers that leverage external billing and catalog systems. This endpoint is used to approve or decline Merchant-initiated changes in subscriptions, such as plan upgrades or downgrades. When a customer wants to upgrade or downgrade their subscription, the Merchant sends a subscription update approval request to Partner Ecosystem Management. Partner Ecosystem Management then sends the subscription update approval request to the Reseller. The Reseller approves or declines the subscription update. Partner Ecosystem Management then sends the response to the Merchant. If the update is approved, the Merchant makes the change to the subscription.
Webhooks
Partner Ecosystem Management enables Resellers (Service Providers) using the Platform-Managed product lifecycle to receive real-time updates through webhooks. These updates are triggered by events related to subscriptions, Partner subscriptions, and external catalog changes. Subscribing to webhooks is required when using the Platform-managed product lifecycle. For Resellers using Commerce Engine and Storefront Gateway, it is mandatory to subscribe to all Partner subscription and subscription events to ensure proper integration and real-time updates. What Are Webhooks? A webhook (or web callback) is a way for Partner Ecosystem Management to send real-time event notifications to Resellers. Instead of polling for updates, Resellers can configure a webhook endpoint to automatically receive event data as it happens. Why Use Webhooks? Webhooks provide:- Real-time updates on subscription, Partner subscription, and catalog changes.
- Improved efficiency over polling APIs.
- Custom routing of specific event types to different URLs, enabling more targeted processing.
Allowlist Settings
Resellers (Service Providers) can define their own allowlisted provisioning attribute names to apply to provisioning with all Merchants. This can be useful for various purposes, such as organizing and retrieving data. During provisioning, Resellers can submit values for the linked private names. Partner Ecosystem Management saves the names and values they’ve created for their own purposes and won’t share them with the Merchant.Activation
Resellers can configure settings that support the customer subscription activation process. These include options to:- Set up schedules for sending activation reminders to customers, which can help Resellers retain revenue by encouraging subscription activation and usage
- Configure a warning and a final reminder for customers Note: Partner Ecosystem Management generates the activation reminders and sends them to Resellers. Resellers will need to send the reminders to customers from their own systems.
- Automatically cancel unactivated subscriptions after a specified number of days from the provisioning date Note: Alternatively, the manual cancellation process can be performed via the MarketONE OpenAPI. For more information, see the Cancel Subscription Use Case in the Partner Ecosystem Management Onboarding Guide for Resellers.
- Shorten product redemption URLs and tokens through the short provisioning service, making it possible for Resellers to generate and scan QR codes
Reseller Policies
Resellers (Service Providers) have the ability to manage key operational and compliance settings that apply to their integrations with Merchants. Resellers can enforce policies that promote consistency, operational efficiency, and regulatory compliance. Resellers can configure the following:- Define when changes take effect for subscription upgrades, downgrades, and cancellations, including proration behavior
- Enable automatic approval of Merchant-initiated requests, allowing immediate processing of product upgrades and downgrades
- Turn the eligibility service on or off
- Choose whether to obfuscate specific customer fields to protect Personally Identifiable Information (PII).