Skip to main content
Easily add gateway adapter endpoints to receive MarketONE 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, you can add the following endpoints:
  • Notification (required for Resellers using Commerce Engine and Storefront Experience)
  • Transaction
  • Account Validate (required for Resellers using Commerce Engine and Storefront Experience)
  • Subscription Update Validate (required for Resellers using Commerce Engine and Storefront Experience)
  • Entitlement Update Validate (recommended if you use external billing and catalog systems)
You can provide a global URL or individual URLs for the endpoint(s) you choose.

Notification Endpoint

A notification is an essential message that informs a Reseller (Service Provider) when an action is required in relation to a Partner subscription. The message contains key subscription details that the Reseller can use to construct their own branded notification to send to the end user. 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. For example: an end user purchases a Platform-managed Partner subscription through the Reseller’s website. The Reseller uses the MarketONE API (e.g., POST /submgmt/v2/subscriptions) to provision the new Partner subscription in the Partner Ecosystem Management data store. However, the end user forgets or neglects to redeem their purchase and fully activate that subscription. After a set period of time, Partner Ecosystem Management sends the notification to the Reseller as a reminder, and the Reseller passes that reminder along to the customer. Notification Types

Transaction Endpoint

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 Endpoint

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 Endpoint

Note: This endpoint is intended for use by Resellers (Service Providers) that also have 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 Endpoint

Note: This endpoint is intended for use by Resellers that use 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.

Enable Credentials

Partner Ecosystem Management supports various methods to secure your gateway adapter endpoints. Enabling credentials is optional but recommended to increase the security of the gateway adapter endpoint data. It ensures the communication is only between partnered the Merchant, Partner Ecosystem Management, and the Reseller (Service Provider). You can select one of the following credential types to provide for each endpoint or all endpoint(s):
  • Username and password
  • API key
  • OAuth2 (client credential flow)
For more information, see Manage Gateway Adapter Endpoints. Parent topic:Front-End Setup