Credorax Merchant Setup

You can board a Credorax merchant via the Gateway Manager or via an API.
There are two options for boarding a Credorax merchant: via the Gateway Manager or via the API.
Boarding a Merchant via the Gateway Manager
Before boarding a Credorax merchant in the Gateway Manager, you must have this information available:
  • Gateway merchant ID
  • Signature Key
  • Terminal IDs:
  • Credorax must activate the terminal IDs before you can use them. Talk to your account manager to get the terminal IDs.
  • Merchant ID Name (applies to Payment facilitators only)
When you have the required information available, follow these steps to board a merchant:
  1. Open the merchant in the Gateway Manager.
  2. Select
    Attach processing path
    .
  3. For the Clearing Institute, select
    Credorax
     and enter the required data.
  4. If you are a payment facilitator, specify the MID Name in this format: XYZ-MerchantName. In this example,
    XYZ
     is the three-digit abbreviation for the payment facilitator that you received from Credorax. The
    MerchantName
     is the name of your merchant (with no spaces and up to 21 characters in length).
  5. To finish the setup, select
    Attach processing path
    .
Boarding a Merchant via the API
Use these steps to create a merchant based on the
Merchant Connectivity Details
 document that Credorax provided to you. 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.
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"
        ],
        
"gatewayMid"
:"ABC123",
        
"midName"
:"PWM-Flower Shop",
        
"signatureKey"
: "321tax74h9vs403e"
      },
      
"name": "Credorax EUR"

    }
  ],
  "readers": [],
  
"name"
: "Test Merchant #42"
}
Based on the information Credorax provided in the
Merchant Connectivity Details
 document, enter these parameters:
$.processingPaths.currencies
Provide the
Currency
 as stated in the "MID Setup Details" section of the
Merchant Connectivity Details
 document.
Important:
 If your
Merchant Connectivity Details
 document contain multiple currencies in the "MID Setup Details" section, note that the platform currently only supports one currency per merchant. In order to support multiple currencies, you must create one merchant for each currency.
$.processingPaths.details.terminalIds
Provide all Terminal IDs from the "TID" section of the
Merchant Connectivity Details
 document. Credorax usually provides 10 TIDs, which means that you can use up to 10 active readers at the same time.
$.processingPaths.details.gatewayMid
Provide the
Gateway MID
 as stated in the "MID Setup Details" section of the
Merchant Connectivity Details
 document. It is 6 characters long.
$.processingPaths.details.midName
Provide the
MID Name
 as stated in the "MID Setup Details" section of the
Merchant Connectivity Details
 document.
Important:
 If you are a
Payment Facilitator
 and you are using one of your super-merchant
Gateway MIDs
, specify the
$.processingPaths.details.midName
 in this format: <PaymentFacilitatorAbbreviation>-<SubMerchantName>, e.g., "PWM-Flower Shop".Talk to your account manager if you are unsure about what information you need to provide for this parameter.
$.processingPaths.details.signatureKey
Provide the
Signature Key
 as stated in the "Connectivity Details" section of the
Merchant Connectivity Details
 document.
$.name
Specify a unique name for each merchant that you create on the platform.
$.processingPaths.name
We recommend always using "Credorax" and the currency for this name.
After successfully creating the merchant, you will receive a
merchantIdentifier
 in the reponse:
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 track all of the readers that you 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):
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 (
key
) in the response:
Response
{
    "status": "ok",
    "data": {
        "status": "ACTIVE",
        
"key": "9pCcTI2mzUbLKoCdezVBowhv0b6gGwoo"

    }
}

Related information

Can we help you?

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