There are two options for boarding a Concardis merchant: via the Gateway Manager or via the API.
Boarding via the Gateway Manager
To board a Concardis merchant in the Gateway Manager, you will need the following data:
  • Three VP Numbers, one each for Mastercard, Maestro, and Visa
  • Terminal IDs
  • Concardis needs to activate the terminal IDs before they can be used. Talk to your Payworks account manager to get the terminal IDs activated.
  1. Once you have the above data, open the merchant in the Gateway Manager and select Attach processing path.
  2. Select Concardis as Clearing Institute and enter the data.
  3. To finish the setup, select Attach processing path.
Boarding via the API
Your goal is to use the Platform API to create a merchant that can process payments via Concardis.
Use the following steps to create a merchant based on the "Merchant Information" that Concardis provided to you. Instructions are provided about 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 CONCARDIS as the processing path
Try it out!
{ "processingPaths": [ {
: [ "EUR" ], "schemes": [ "VISA", "MASTER", "MAESTRO", "VISAELECTRON", "UNION_PAY", "JCB", "DINERS", "DISCOVER" ], "details": { "institute": "CONCARDIS",
: [ "71E29108", "71E29109" ],
: [ { "schemes": [ "MASTER" ], "vuNummer": "153442414" }, { "schemes": [ "MAESTRO" ], "vuNummer": "353442412" }, { "schemes": [ "VISA","VISAELECTRON" ], "vuNummer": "143442416" }, { "schemes": [ "DINERS","DISCOVER" ], "vuNummer": "577777776" }, { "schemes": [ "UNION_PAY" ], "vuNummer": "487777776" }, { "schemes": [ "JCB" ], "vuNummer": "537777776" } ] },
: "ConCardis EUR" } ], "readers": [],
: "Test Merchant #42",
:{ "publicName":"Public Merchant Name", "address":"42 Merchant Street", "zip":"123456", "city":"Merchant City", "country":"DE", "contact":"+49 (170) 1234567" } }
Based on the "Merchant Information" from Concardis, provide those parameters:
Provide the
you want to process payments in. Usually
Provide all
Terminal IDs
that you have received from Concardis. You can use as many active readers at the same time as you have specified Terminal IDs here, i.e., each active reader needs one Terminal ID.
Provide the
VP Numbers
for all schemes you have received from Concardis. The VP Number for Visa/Electron/Vpay always starts with 14, the number for MasterCard starts with 15 and the number for Maestro starts with 35.
We recommend to always use
and the currency for this name.
Specify a unique name for each merchant that you create on the platform.
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
after successfully creating the merchant:
{ "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 created in Step 1, you must know its
. Use this API to find the
of a reader based on its serial number (e.g., 999-100001):
Try it out!
You will receive the
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
from Step 1 and the
from Step 2, you can now assign the reader to the merchant:
Try it out!
4. Generate the Merchant Secret Key
You can also generate a Merchant Secret Key for the Merchant via the API:
Try it out!
You will receive the Merchant Secret Key in the response:
{ "status": "ok", "data": { "status": "ACTIVE",
"key": "9pCcTI2mzUbLKoCdezVBowhv0b6gGwoo"
} }