User-Agent header must be supplied with all Merchant API requests prior to placing any live transactions.
For example:
MyClearpayModule/1.0.0 (E-Commerce Platform Name/1.0.0; PHP/7.0.0; Merchantname/60032000) https://merchant.example.com
| Description | Example Data Above | Other Merchant Examples |
|---|---|---|
| Clearpay Plugin | MyClearpayModule/1.0.0 | • Custom Plugin/1.0 • Shopify Plugin/3.5.1 • ClearpayCartridge/1.0 • ClearpayExtension/2.9 |
| Platform | E-Commerce Platform Name/1.0.0 | • Websphere Commerce/8.1 • Commerce Cloud/1.1 • Adobe Commerce (Magento)/2.3.0 |
| System Information | PHP/7.0.0 | • PHP/7.2.18 • Ruby/2.5.3 • Java/8.3 |
| Merchant ID | Merchantname/60032000 | • Merchantname/101113200 • Merchantname/101931210 |
| Merchant Website URL | https://merchant.example.com | http://www.merchantwebsite.com |
Note:
In this case the Merchant ID is your company name or organisation name followed by an eight-digit number.