| 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 Gateway (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. | 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 Gateway (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 (^$*.[]{}()?”!@#%&/\,><’:;\ | _~`=+-) - 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. 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. | 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 (^$*.[]{}()?”!@#%&/\,><’:;\ | _~`=+-) - 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. 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 Gateway (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. | 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 (^$*.[]{}()?”!@#%&/\,><’:;\ | _~`=+-) - 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. 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 Gateway (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. | 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 (^$*.[]{}()?”!@#%&/\,><’:;\ | _~`=+-) - 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. 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. | 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 (^$*.[]{}()?”!@#%&/\,><’:;\ | _~`=+-) - 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. Note: mTLS is another option to secure credentials that can be added by contacting Client Technical Support. | Optional |
| Parent topic:Manage Gateway Adapter Endpoints | | | |
