Boarding an EVRY merchant

There are two options for EVRY merchant boarding:

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
  • Merchant Name
  • Merchant Street
  • Merchant Zip Code
  • Merchant City
  • Merchant Country

Once 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.

Once you are done, select Attach processing path to finish the setup.

Boarding via the API

Your goal is to use the Platform API to create a merchant that can process payments via EVRY.

This guide shows you how to create a merchant based on the "Merchant Information" that EVRY has provided to you.
It further explains 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

post /v2/merchants/ Try it out! Request
{  
   "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 the Currency you want to process payments in. Usually its SEK.
$.processingPaths.details.retailerData
Provide the Retailer Data you have received from your EVRY acquirer. It's sometimes also just called Merchant ID
$.processingPaths.details.merchantType
Provide the four digit Merchant Category Code you have received from your EVRY acquirer, e.g. 5999 (Miscellaneous)
$.processingPaths.details.merchantName
Provide the Merchant Name
$.processingPaths.details.merchantStreet
Provide the Merchant Street
$.processingPaths.details.merchantZipCode
Provide the Merchant Zip Code
$.processingPaths.details.merchantCity
Provide the Merchant City
$.processingPaths.details.country
Provide the Merchant 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, including Public Name, Address and a Contact Phone Number/Email Address.

You will receive a 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):

get /v2/readers/?search=999100001 Try it out! Request

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:

put /v2/merchants/{merchantIdentifier}/readers/{readerIdentifier} Try it out! Request

4. Generate the Merchant Secret Key

You can also generate a Merchant Secret Key for the Merchant via the API:

post /v2/merchants/{merchantIdentifier}/secretKey Try it out! Request
{
	"permissions": ["READER_MANAGEMENT","TRANSACTIONS"]
}

You will receive the Merchant Secret Key in the response:

Response
{
    "status": "ok",
    "data": {
        "status": "ACTIVE",
        "key": "9pCcTI2mzUbLKoCdezVBowhv0b6gGwoo"
    }
}

Can we help you?

If you cannot find your answer, contact us and we'll get in touch with you soon.

© Copyright 2017 Payworks GmbH. Legal.