> ## 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.

# Manage Gateway Adapter Endpoints

Gateway adapter endpoints allow your system to receive and process important information for subscription management.

**Note:** The required endpoints vary depending on your deployment.

For example, in a deployment that includes Commerce Engine and Storefront Experience, the following endpoints are required:

* Notification
* Account Validate
* Subscription Update Validate

In the **Gateway** space, you can:

* Add and configure gateway adapter endpoints
* Edit gateway adapter endpoints

1. Navigate to **Platform Settings** > **Gateway**.

   The **Gateway** page appears.

   <img src="https://mintcdn.com/amdocs-spbu/_Twl74NQXCAg2nPh/marketONE/userGuideForMerchants/images/GatewayAdapterEndpoints.png?fit=max&auto=format&n=_Twl74NQXCAg2nPh&q=85&s=ea1cdbb06d15daae3e603311ca617483" alt="" width="1750" height="401" data-path="marketONE/userGuideForMerchants/images/GatewayAdapterEndpoints.png" />

2. Select what you'd like to do:

   * To add gateway adapter endpoints, select **Click here to define your Gateway Adapter Endpoints**.

     The **New Gateway Adapter Endpoints** box appears.

     Configure the settings as desiredas required (see **About This Task** for more information about the required endpoints). See the table below for more guidance on the fields.

     Select **Save**.

   * To edit gateway adapter endpoints, select the three dot menu and select the **Edit** option.

     The **New Gateway Adapter Endpoints** box appears.

     Configure the settings as desired. See the table below for more guidance on the fields.

     Select **Save**.

* **[Gateway Adapter Endpoint Details](m_gatewayManage#gateway-adapter-endpoint-details)**

**Parent topic:**

## Gateway Adapter Endpoint Details

### Global Settings

| Field Name | Guidance | Required or Optional | |
| - | - | - | - |
| **Set a global gateway endpoint URL** | Enable this option if you'd like to set a single gateway endpoint URL for all of the gateway settings.**Note:** If you enable this option, you must also set global gateway credentials to apply to the global gateway endpoint URL. | Endpoint setup is required when using Partner Ecosystem Management with Commerce Engine and Storefront Experience (via **Global Settings** or **Gateway Settings**) Optional | |
| **Global gateway endpoint URL (will apply to all gateway settings)** (this appears if you selected **Set a global gateway endpoint URL**) | Provide a valid URL for the global gateway endpoint. An example of a valid URL is [https://www.example.com/endpoint](https://www.example.com/endpoint). | Required if you enabled **Set a global gateway endpoint URL** | |
| **Select the adapter endpoints that will use the global URL** (this appears if you selected **Set a global gateway endpoint URL**) | From the following list, select the adapter endpoints that will use the global gateway endpoint URL:- Notification - Transaction - Account Validate - Subscription Update Validate - Merchant Subscription Create Validate - Entitlement Update Validate | Required if you enabled **Set a global gateway endpoint URL** | |
| **Set global gateway credentials** | Enable this option if you want the same credentials to be required every time each of the endpoints are called. | Optional | |
| **Select global gateway credentials** (this appears if you selected **Set global gateway credentials**) | Select one of the following credential types to be required for all endpoints:- **Username and password**: Provide the username, the password, and then confirm the password. Passwords should meet the following requirements: - Be at least 8 characters in length - Contain at least one uppercase character (A-Z) - Contain at least one lowercase character (a-z) - Contain at least one number (0-9) - Contain at least one special character (^\$\*.\[]\&#123;\&#125;()?"!@#%&/\\,>\<':;\\ | \_\~\`=+-) - **API key**: Provide the API key header name and value from your API management platform. - **OAuth2** (client credential flow only supported): Provide the access token URI, client ID, and client secret. **Note:** The OAuth2 client credential flow supports the access token URI, client ID, and client secret during the registration of the client. For API implementation, see the [OAuth2 request and response example](gatewayOAuthExample_r). **Note:** mTLS is another option to secure credentials that can be added by contacting Client Technical Support. | Optional |
| **Select the adapter endpoints that will use the global gateway credentials** (this appears if you selected **Set global gateway credentials**) | From the following list, select the adapter endpoints that will use the global gateway credentials:- Notification - Transaction - Account Validate - Subscription Update Validate - Merchant Subscription Create Validate - Entitlement Update Validate | Optional | |

### Gateway Settings

| Field Name | Guidance | Required or Optional | |
| - | - | - | - |
| **Notification** | Enable this option to receive notifications from Partner Ecosystem Management. When this option is enabled, the settings become available to configure. | Required when using Partner Ecosystem Management with Commerce Engine and Storefront Experience (via **Global Settings** or **Gateway Settings**) Optional | |
| **Endpoint URL** (this appears if you enabled **Notification**) | Provide a valid URL for the Notification endpoint. This is where you'll receive notifications. An example of a valid URL is [https://www.example.com/endpoint](https://www.example.com/endpoint). | Required if you enabled **Notification** | |
| **Select Notifications** (this appears if you enabled **Notification**) | Select the notifications to receive from the list of available notifications. | All notifications are required when using Partner Ecosystem Management with Commerce Engine and Storefront Experience (via **Global Settings** or **Gateway Settings**) Optional | |
| **Select Credentials** (this appears if you enabled **Notification**) | Select the credential type that will be required whenever the Notification endpoint is called. The following credential types are available:- **Username and password**: Provide the username, the password, and then confirm the password. Passwords should meet the following requirements: - Be at least 8 characters in length - Contain at least one uppercase character (A-Z) - Contain at least one lowercase character (a-z) - Contain at least one number (0-9) - Contain at least one special character (^\$\*.\[]\&#123;\&#125;()?"!@#%&/\\,>\<':;\\ | \_\~\`=+-) - **API key**: Provide the API key header name and value from your API management platform. - **OAuth2** (client credential flow only supported): Provide the access token URI, client ID, and client secret. **Note:** The OAuth2 client credential flow supports the access token URI, client ID, and client secret during the registration of the client. For API implementation, see the [OAuth2 request and response example](gatewayOAuthExample_r). **Note:** mTLS is another option to secure credentials that can be added by contacting Client Technical Support. | Optional |
| **Transaction** | Enable this option to receive Transaction API requests from Partner Ecosystem Management. By enabling this option, the settings for this option become available to configure. | Optional | |
| **Endpoint URL** (this appears if you enabled **Transaction**) | Provide a valid URL for the Transaction endpoint. This is where you'll receive Transaction API requests. An example of a valid URL is [https://www.example.com/endpoint](https://www.example.com/endpoint). | Required if you enabled **Transaction** | |
| **Select Credentials** (this appears if you enabled **Transaction**) | Select the credential type that will be required whenever the Transaction endpoint is called. The following credential types are available:- **Username and password**: Provide the username, the password, and then confirm the password. Passwords should meet the following requirements: - Be at least 8 characters in length - Contain at least one uppercase character (A-Z) - Contain at least one lowercase character (a-z) - Contain at least one number (0-9) - Contain at least one special character (^\$\*.\[]\&#123;\&#125;()?"!@#%&/\\,>\<':;\\ | \_\~\`=+-) - **API key**: Provide the API key header name and value from your API management platform. - **OAuth2** (client credential flow only supported): Provide the access token URI, client ID, and client secret. **Note:** The OAuth2 client credential flow supports the access token URI, client ID, and client secret during the registration of the client. For API implementation, see the [OAuth2 request and response example](gatewayOAuthExample_r). **Note:** mTLS is another option to secure credentials that can be added by contacting Client Technical Support. | Optional |
| **Account Validate** | Enable this option to receive Account Validate API requests from Partner Ecosystem Management. By enabling this option, the settings for this option become available to configure. | Required when using Partner Ecosystem Management with Commerce Engine and Storefront Experience (via **Global Settings** or **Gateway Settings**) Optional | |
| **Endpoint URL** (this appears if you enabled **Account Validate**) | Provide a valid URL for the Account Validate endpoint. This is where you'll receive Account Validate API requests. An example of a valid URL is [https://www.example.com/endpoint](https://www.example.com/endpoint). | Required if you enabled **Account Validate** | |
| **Select Credentials** (this appears if you enabled **Account Validate**) | Select the credential type that will be required whenever the Account Validate endpoint is called. The following credential types are available:- **Username and password**: Provide the username, the password, and then confirm the password. Passwords should meet the following requirements: - Be at least 8 characters in length - Contain at least one uppercase character (A-Z) - Contain at least one lowercase character (a-z) - Contain at least one number (0-9) - Contain at least one special character (^\$\*.\[]\&#123;\&#125;()?"!@#%&/\\,>\<':;\\ | \_\~\`=+-) - **API key**: Provide the API key header name and value from your API management platform. - **OAuth2** (client credential flow only supported): Provide the access token URI, client ID, and client secret. **Note:** The OAuth2 client credential flow supports the access token URI, client ID, and client secret during the registration of the client. For API implementation, see the [OAuth2 request and response example](gatewayOAuthExample_r). **Note:** mTLS is another option to secure credentials that can be added by contacting Client Technical Support. | Optional |
| **Subscription Update Validate** | Enable this option to receive Subscription Update Validate API requests from Partner Ecosystem Management. By enabling this option, the settings for this option become available to configure. | Required when using Partner Ecosystem Management with Commerce Engine and Storefront Experience (via **Global Settings** or **Gateway Settings**) Optional | |
| **Endpoint URL** (this appears if you enabled **Subscription Update Validate**) | Provide a valid URL for the Subscription Update Validate endpoint. This is where you'll receive Subscription Update Validate API requests. An example of a valid URL is [https://www.example.com/endpoint](https://www.example.com/endpoint). | Required if you enabled **Subscription Update Validate** | |
| **Select Credentials** (this appears if you enabled **Subscription Update Validate**) | Select the credential type that will be required whenever the Subscription Update Validate endpoint is called. The following credential types are available:- **Username and password**: Provide the username, the password, and then confirm the password. Passwords should meet the following requirements: - Be at least 8 characters in length - Contain at least one uppercase character (A-Z) - Contain at least one lowercase character (a-z) - Contain at least one number (0-9) - Contain at least one special character (^\$\*.\[]\&#123;\&#125;()?"!@#%&/\\,>\<':;\\ | \_\~\`=+-) - **API key**: Provide the API key header name and value from your API management platform. - **OAuth2** (client credential flow only supported): Provide the access token URI, client ID, and client secret. **Note:** The OAuth2 client credential flow supports the access token URI, client ID, and client secret during the registration of the client. For API implementation, see the [OAuth2 request and response example](gatewayOAuthExample_r). **Note:** mTLS is another option to secure credentials that can be added by contacting Client Technical Support. | Optional |
| **Entitlement Update Validate** | Enable this option to receive Entitlement Update Validate API requests from Partner Ecosystem Management. This endpoint is for Resellers (Service Providers) that leverage external billing and catalog systems. By enabling this option, the settings for this option become available to configure. | Optional | |
| **Endpoint URL** (this appears if you enabled **Entitlement Update Validate**) | Provide a valid URL for the Entitlement Update Validate endpoint. This is where you'll receive Entitlement Update Validate API requests. An example of a valid URL is [https://www.example.com/endpoint](https://www.example.com/endpoint). | Required if you enabled **Entitlement Update Validate** | |
| **Select Credentials** (this appears if you enabled **Entitlement Update Validate**) | Select the credential type that will be required whenever the Entitlement Update Validate endpoint is called. The following credential types are available:- **Username and password**: Provide the username, the password, and then confirm the password. Passwords should meet the following requirements: - Be at least 8 characters in length - Contain at least one uppercase character (A-Z) - Contain at least one lowercase character (a-z) - Contain at least one number (0-9) - Contain at least one special character (^\$\*.\[]\&#123;\&#125;()?"!@#%&/\\,>\<':;\\ | \_\~\`=+-) - **API key**: Provide the API key header name and value from your API management platform. - **OAuth2** (client credential flow only supported): Provide the access token URI, client ID, and client secret. **Note:** The OAuth2 client credential flow supports the access token URI, client ID, and client secret during the registration of the client. For API implementation, see the [OAuth2 request and response example](gatewayOAuthExample_r). **Note:** mTLS is another option to secure credentials that can be added by contacting Client Technical Support. | Optional |
| **Parent topic:**[Manage Gateway Adapter Endpoints](m_gatewayManage) | | | |


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