You can board an EVRY merchant via the Gateway Manager or via an API.
Boarding a Merchant via the Gateway Manager
Before boarding a EVRY merchant in the Gateway Manager, you must have this information available:
Retailer Data (Merchant ID)
Merchant Category Code (For a list of Merchant Category codes, click this
link.)
Merchant Name
Merchant Street
Merchant Zip Code
Merchant City
Merchant Country
When you have the required information available, follow these steps to board a merchant:
Open the merchant in the Gateway Manager.
Select
Attach processing path
.
For the Clearing Institute, select
EVRY
and enter the required data.
To finish the setup, select
Attach processing path
.
Boarding a Merchant via the API
Follow these steps to use the
Platform
API to create a merchant and board that can process payments using EVRY. These steps also provide instructions about how to assign a card reader to the merchant and how to generate a merchant secret key for the new merchant. You will use the merchant information that EVRY provides to you to create a new merchant.
1. Create a merchant with EVRY as the processing path.
post
/v2/merchants/
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 provided by EVRY, enter these parameters:
$.processingPaths.currencies
Provide the
Currency
you want to process payments in. Usually its
SEK
.
$.processingPaths.details.retailerData
Provide the
Retailer Data
you received from your EVRY acquirer. It is also called
Merchant ID
$.processingPaths.details.merchantType
Provide the four digit
Merchant Category Code
you 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
.
After successfully creating the merchant, you will receive a
merchantIdentifier
in the response:
{
"status": "ok",
"data": {
/*...*/
"identifier": "74b47dcd-45b0-4c65-a4d1-afd4aae32708"
,
"name": "Test Merchant #42"
/*...*/
}
}
2. Find the reader that you want to assign to the merchant.
The platform track all of the readers that you have purchased. In order to assign a reader to the new merchant you 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:
{
"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
Request
{
"permissions": ["READER_MANAGEMENT","TRANSACTIONS"]
}
You will receive the merchant secret key (
key
) in the response:
{
"status": "ok",
"data": {
"status": "ACTIVE",
"key": "9pCcTI2mzUbLKoCdezVBowhv0b6gGwoo"
}
}