EVRY
There are two options for boarding an EVRY merchant
boarding: via the Gateway Manager or via the API.
Your goal is to use the Platform API to
create a merchant that can process payments via EVRY.
Boarding via the
Gateway Manager
To board an EVRY merchant in the Gateway Manager, you will need the following data:
- Retailer Data (Merchant ID)
- Merchant Category Code (see here for details)
- Merchant Name
- Merchant Street
- Merchant Zip Code
- Merchant City
- Merchant Country
- After you have the above data, open the merchant in the Gateway Manager and select Attach processing path.
- Select EVRY as Clearing Institute and enter the data.
- To finish the setup, select Attach processing path.
Boarding via the API
Use the following instructions to
create a merchant based on the "Merchant Information" that EVRY has provided to
you. The instructions also explain
how to assign a reader to the merchant and how to generate a merchant secret key for the
new merchant.
1. Create a Merchant with EVRY as the processing path
{ "processingPaths":[ { "name":"Default", "schemes":[ "VISA", "MASTER", "VISAELECTRON", "MAESTRO" ], "currencies":[ "SEK" ], "details":{ "institute":"EVRY", "merchantCity" : "Merchant City", "merchantCountry" : "SE", "merchantName" : "Merchant Name", "merchantStreet" : "Merchant Street", "merchantZipCode" : "12345", "merchantType" : "5999", "retailerData" : "1234567" } } ], "name":"Test Merchant #42", "details":{ "publicName":"Public Merchant Name", "address":"42 Merchant Street", "zip":"12345", "city":"Merchant City", "country":"SE", "contact":"+46 1234567" }, "readers":[ ] }
Based on the "Merchant Information" from EVRY, please provide those parameters:
- $.processingPaths.currencies
- Provide theCurrencyyou want to process payments in. Usually itsSEK.
- $.processingPaths.details.retailerData
- Provide theRetailer Datayou have received from your EVRY acquirer. It's sometimes also just calledMerchant ID
- $.processingPaths.details.merchantType
- Provide the four digitMerchant Category Codeyou have received from your EVRY acquirer, e.g. 5999 (Miscellaneous)
- $.processingPaths.details.merchantName
- Provide theMerchant Name
- $.processingPaths.details.merchantStreet
- Provide theMerchant Street
- $.processingPaths.details.merchantZipCode
- Provide theMerchant Zip Code
- $.processingPaths.details.merchantCity
- Provide theMerchant City
- $.processingPaths.details.country
- Provide theMerchant Country, which is usually SE.
- $.processingPaths.name
- We recommend to always use "Default" for this name.
- $.name
- Make sure to specify a unique name for each merchant that you create on the platform.
- $.details
- Finally, for the payment receipts, you need to provide some information about the merchant, includingPublic Name, Address and a Contact Phone Number/Email Address.
merchantIdentifier
after successfully creating
the merchant: Response
{ "status": "ok", "data": { /*...*/"identifier": "74b47dcd-45b0-4c65-a4d1-afd4aae32708", "name": "Test Merchant #42" /*...*/ } }
2. Find the reader you want to assign to the merchant
The platform keeps track of all the readers that you have purchased. In order to assign
a reader to the new merchant you have created in Step 1, you must know its
readerIdentifier
. Use this API to find the
readerIdentifier
of a reader based on its serial number (e.g.
999-100001):You will receive the
readerIdentifier
in the response: Response
{ "status": "ok", "data": [{ /*...*/"identifier": "0665ede3-3990-4c9b-beac-77abfeda5858", "model": "MIURA_SHUTTLE", "details": { "serialNo": "999100001" /*...*/ } }] }
3. Assign the reader to new merchant
Based on the
merchantIdentifier
from Step 1 and the
readerIdentifier
from Step 2, you can now assign the reader to the
merchant:4. Generate the Merchant Secret Key
You can also generate a Merchant Secret Key for the Merchant via the API:
{ "permissions": ["READER_MANAGEMENT","TRANSACTIONS"] }
You will receive the Merchant Secret Key in the response:
Response
{ "status": "ok", "data": { "status": "ACTIVE","key": "9pCcTI2mzUbLKoCdezVBowhv0b6gGwoo"} }