PRIVATE API KEYS
Before interacting with our API, you will need a Private API Key.
Your production Private API Key can be either requested from your account manager, or you can find it in your Merchant Portal under the Account Settings section.
To obtain a sandbox Private API Key to test your integration before going live, please contact:
- For HeidiPay (Switzerland): [email protected]
- For Pagolight & Pagolight Pro (Italy): [email protected]
PUBLIC API KEYS
For displaying a promotional message on your webshop (on product or cart page for example), you may need a Public API Key so that we can recognise your webshop and return the correct offer for your customer to be displayed in your store.
The Public API Key is only required if your offer Pagolight Pro or HeidiPay (for credit product with interest only).
See section on Promotional Message integration for more details.
URLs
In order to interact with our REST API, please use the following associated URLs:
- Sandbox:
https://sbx-origination.heidipay.io - Production:
https://origination.heidipay.com
AUTHENTICATION
Before making any requests via our APIs, you will need to generate an authentication token using your Private Key. Note that an authentification token expires after 24 hours. The detailed documentation and code builder can be found here.
In order to make a request to generate a Merchant Token you need to provide your Merchant API key in the request body:
Example request body to fetch a token (private key included for illustrative purpose only, please ask for a valid one for testing the API):
url = "https://sbx-origination.heidipay.io/auth/v1/generate/"
payload = {"merchant_key": "e66ac64603979dbb8dddf29224b456785c0fa52b"}
headers = {"accept": "application/json","content-type": "application/json"}
Example of response:{"status": "success","data": {"token": "f5f3dc0a23077b77b5eb4c02811d0626941e06e0"}}
Or in case of failure:{"status": "failure"}
If you want to get started, try out the code sample below to get a merchant token.
curl --location --request POST 'https://sbx-origination.heidipay.io/auth/generate/' \
--header 'Content-Type: application/json' \
--data-raw '{"merchant_key": "YOUR_MERCHANT_KEY_HERE"}'
Need a hand?
Our development team are ready and waiting to support your integration. For any questions please contact:
- For HeidiPay (Switzerland): [email protected]
- For Pagolight & Pagolight Pro (Italy): [email protected]