> ## Documentation Index
> Fetch the complete documentation index at: https://docs.m1amdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Gateway

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 Gateway)
* Transaction
* Account Validate (required for Resellers using Commerce Engine and Storefront Gateway)
* Subscription Update Validate (required for Resellers using Commerce Engine and Storefront Gateway)
* 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](g_platformManagedFlow) 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**

| Notification Type Name | Description |
| - | - |
| msisdnVerificationRequired | Partner Ecosystem Management sends this when verification of the MSISDN is needed from the customer. |
| accountVerificationRequired | Partner Ecosystem Management sends this when account verification is needed from the customer. |
| partnerSubscriptionAdded | Partner Ecosystem Management sends this when a new Partner subscription is created on the platform. The notification includes Partner subscription details, including a Merchant URL and redemption code, so that the customer can activate their subscription. |
| partnerSubscriptionActivationReminder | Partner Ecosystem Management sends this after a set period of time where an end user has purchased a Partner subscription, but they have yet to redeem/activate it. On the back end, the following can be configured: - Whether or not to enable or disable the notification per Merchant. - Frequency: the total number of times to (re)send a reminder - Interval: the length of time between each reminder |
| partnerSubscriptionActivationMissed | Partner Ecosystem Management sends this when the customer hasn't activated their Partner subscription within the time frame. |
| partnerSubscriptionActivationMissedWarning | Partner Ecosystem Management sends this to give the customer a final opportunity to activate their subscription before it could be canceled by the Reseller (Service Provider). |
| partnerSubscriptionUpdated | Partner Ecosystem Management sends this when the details of a Partner Subscription have been changed. |
| partnerSubscriptionCancelled | Partner Ecosystem Management sends this when a Partner subscription has been canceled. |
| pinVerificationRequired | Partner Ecosystem Management sends this when PIN verification is required from the customer. |
| validationSuspendedNonPayment | Partner Ecosystem Management sends this when the Partner subscription has been suspended due to non-payment. The Partner subscription needs to go through validation. |
| validationSuspendedLostStolen | Partner Ecosystem Management sends this when the Partner subscription has been suspended because it appears that the account has been stolen or lost. |
| validationEligibilityFailed | Partner Ecosystem Management sends this when the customer hasn't passed the Reseller's eligibility check. |
| validationServerError | Partner Ecosystem Management sends this when validation is unsuccessful due to a server error. |
| transactionSuspendedNonPayment | Partner Ecosystem Management sends this when the transaction has been suspended due to non-payment. |
| transactionSuspendedLostStolen | Partner Ecosystem Management sends this when the transaction has been suspended because it seems the account is stolen or lost. |
| transactionInsufficientBalance | Partner Ecosystem Management sends this when the transaction is unsuccessful due to an insufficient account balance. |
| transactionExceedsDailyLimit | Partner Ecosystem Management sends this when the transaction exceeds the daily limit. |
| transactionExceedsMonthlyLimit | Partner Ecosystem Management sends this when the transaction exceeds the monthly limit. |
| transactionServerError | Partner Ecosystem Management sends this when the transaction is unsuccessful due a server error. |
| transactionSuccess | Partner Ecosystem Management sends this when the transaction was successful. |
| refundSuccess | Partner Ecosystem Management sends this when the customer refund was successful. |
| oneTimePinRequest | Partner Ecosystem Management sends this when a one-time PIN is required for user verification in the Merchant-managed product lifecycle. Partner Ecosystem Management generates and sends the one-time PIN to the Reseller so the Reseller can then notify the customer. |
| userNotification | Partner Ecosystem Management sends this when a notification for the user exists. |
| subscriptionCancelled | Partner Ecosystem Management sends this when the subscription has been canceled. |
| accountAssociated | |
| partnerSubscriptionAddedForUpdate | Partner Ecosystem Management sends this when a Partner subscription has been added for an update. |
| partnerSubscriptionModified | Partner Ecosystem Management sends this when a Partner subscription has been changed. |
| subscriptionCreated **Note:** This notification type is intended for use by Resellers (Service Providers) that also have Commerce Engine. | Partner Ecosystem Management sends this when a subscription has been created. |
| subscriptionRenewal **Note:** This notification type is intended for use by Resellers (Service Providers) that also have Commerce Engine. | Partner Ecosystem Management sends this when a subscription has been successfully renewed. |
| subscriptionRenewalFailed **Note:** This notification type is intended for use by Resellers (Service Providers) that also have Commerce Engine. | Partner Ecosystem Management sends this when a subscription renewal attempt has been unsuccessful. |
| prerenewalNotification **Note:** This notification type is intended for use by Resellers (Service Providers) that also have Commerce Engine. | Partner Ecosystem Management sends this for a pre-renewal notification. Resellers (Service Providers) can configure the number of days before renewal when the renewal reminder is sent. The pre-renewal notification needs to be sent with price details, the renewal date, and the product name. |

## 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](gatewayManage).

* **[Manage Gateway Adapter Endpoints](gatewayManage)**

**Parent topic:**[Front-End Setup](setupInMarketONE)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.