New API Endpoint & Header

In order to enhance the security of our API, we have introduced a new header called "Ocp-Apim-Subscription-Key" for authentication purposes.

This header will be required for every API calls, in addition to the existing authentication method using the ShopID and SecretKey (Basic Auth).

The "Ocp-Apim-Subscription-Key" header will be merchant-specific and can only be used from the whitelisted IPs associated with that merchant.

From July 2023 onwards, new integrations must utilize the following endpoint: https://api.payretailers.com/payments/v2
For previous integrations, please keep using the original endpoint until further notice: https://api.gateway.payretailers.com/v2

Each merchant will have two unique keys, primary and backup, being the primary the one that must be used.

Changes Made

• From now on, new Integrations will have to include the "Ocp-Apim-Subscription-Key" header in every API call requests.
• The "Ocp-Apim-Subscription-Key" header is merchant-specific and will be provided individually for each merchant.
• Each merchant will have a primary and a backup "Ocp-Apim-Subscription-Key," both of which will be provided prior to the change.
• Merchants with multiple shops need to use the same "Ocp-Apim-Subscription-Key" for all their shops.

At this moment, API Reference calls are not available due to these updates. We are working to have the API Reference sandbox enviroment available as soon as possible.

If you have any further questions or concerns regarding this update, please don't hesitate to reach out to us at [email protected].