Boarding a Credorax merchant

There are two options for Credorax merchant boarding:

Boarding via the Gateway Manager

To board a Credorax merchant in the Gateway Manager, you will need the following data:

  • Gateway MID
  • Signature Key
  • Terminal ID(s)
    • Credorax needs to activate the terminal ID(s), before they can be used. Talk to your Payworks account manager to get the terminal ID(s) activated.
  • Sub-Merchant ID

Once you have the above data, open the merchant in the Gateway Manager and select Attach processing path.

Select Credorax as Clearing Institute and enter the data.

If you are a payment facilitator, enter the Merchant ID of the sub-merchant, format: 0-9, min 1, max 15 numbers.

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

Boarding via the API

This guide shows you how to create a merchant based on the "Merchant Connectivity Details" document that Credorax 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 CREDORAX as the processing path

post /v2/merchants/ Try it out! Request
{
  "processingPaths": [
    {
      "currencies": [
        "EUR"
      ],
      "schemes": [
        "VISA",
        "MASTER",
        "MAESTRO",
        "VISAELECTRON"
      ],
      "details": {
        "institute": "CREDORAX",
        "terminalIds": [
          "T0001222", "T0001333", "T0001334"
        ],
        "subMid":"12345",
        "gatewayMid":"ABC123", 
        "signatureKey": "321tax74h9vs403e"
      },
      "name": "Credorax EUR"
    }
  ],
  "readers": [],
  "name": "Test Merchant #42"
}

Based on the "Merchant Connectivity Details" document from Credorax, please provide those parameters:

$.processingPaths.currencies
Provide the Currency as stated in the "MID Setup Details" section of the "Merchant Connectivity Details" document.
Important: Should your "Merchant Connectivity Details" document contain multiple currencies in the "MID Setup Details" section, please understand that the platform currently only supports one currency per merchant on the platform. This means you need to create one merchant for each currency.
$.processingPaths.details.terminalIds
Provide all Terminal IDs from the "TID" section. Credorax usually provides 10 TIDs, which means that you can use up to ten active readers at the same time.
$.processingPaths.details.gatewayMid
Provide the Gateway MID as stated in the "MID Setup Details" section. Its six characters long.
$.processingPaths.details.subMid
Provide the Sub-Merchant ID.
Important: If you are a Payment Facilitator enter the Merchant ID of the sub-merchant..
Talk to your account manager if you are unsure what you need to provide here!
$.processingPaths.details.signatureKey
Provide the Signature Key as stated in the "Connectivity Details" section.
$.name
Make sure to specify a unique name for each merchant that you create on the platform.
$.processingPaths.name
We recommend to always use "Credorax" and the currency for this name.

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=999-100001 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.