Boarding a FirstData Rapid Connect Merchant
Boarding a FirstData Rapid Connect Merchant
There are two options for FirstData Rapid Connect merchant boarding:
Boarding via the Gateway Manager
To board a merchant processing via FirstData Rapid Connect in the Gateway Manager, you will need the following data:
- Check this box, if your merchant wants to accept signature debit transactions via the STAR network
- Terminal and Datawire ID(s)
- You need to enter the Terminal and Datawire ID separated by a colon, e.g. 12345678:d6as5d6as5d6a5d
- If you don't have a Datawire ID yet, use this form to request one based on the Group ID, Merchant ID and Terminal ID
Once you have the above data, open the merchant in the Gateway Manager and select Attach processing path.
Select First Data Rapid Connect 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 FirstData Rapid Connect.
This guide shows you how to create a merchant based on the "Merchant Information" that you have received as part of a Merchant Information or VAR sheet.
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 FirstData Rapid Connect as the processing path
POST
/signingKeys/public
Request
{ "processingPaths":[ { "name":"Default", "schemes":[ "VISA", "VISAELECTRON", "MASTER", "JCB", "DINERS", "DISCOVER", "AMEX", "VISA_INTERLINK", "MAESTRO", "VISA_COMMON_DEBIT", "MASTER_COMMON_DEBIT", "DISCOVER_COMMON_DEBIT" ], "currencies":[ "USD" ], "details":{ "institute":"FIRSTDATA_RAPIDCONNECT", "groupId": "10001", "merchantId": "1234567", "merchantCategoryCode": "5999", "magstripeSignatureDebitSupported": true, "terminalIds": [ "01234567:00000000000123456789" ] } } ], "name":"Test Merchant #42", "details":{ "publicName":"Public Merchant Name", "address":"42 Merchant Street", "zip":"80000", "city":"Merchant City", "country":"US", "contact":"+1 415 555 2671" }, "readers":[ ] }
Based on the "Merchant Information", please provide those parameters:
$.processingPaths.currencies
Provide the
Currency
you want to process payments in. Usually its USD.processingPaths.details.groupId
Provide the
Group ID
$.processingPaths.details.merchantId
Provide
Merchant ID
$.processingPaths.details.merchantCategoryCode
Provide
Merchant Category Code
you have received, e.g. 5999 (Miscellaneous)$.processingPaths.details.magstripeSignatureDebitSupported
Set to true if your merchant wants to accept signature debit transactions via the STAR network
$.processingPaths.details.terminalIds
Provide the
Terminal ID
and Datawire ID separated by a colon, e.g. 12345678:d6as5d6as5d6a5d. If you don't have a Datawire ID yet, use this form to request one based on the Group ID, Merchant ID and Terminal ID.$.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:/v2/transactions/{transactionIdentifier}
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):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}
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 in the response:
Response
{ "status": "ok", "data": { "status": "ACTIVE", "key": "9pCcTI2mzUbLKoCdezVBowhv0b6gGwoo" } }