Before You Begin

Getting the ID of your payment terminal

To allow your POS to communicate with your payment terminal, send its device ID in the header of each request.

Getting the ID of a Semi-Integrated device

1. From the home screen of the Semi-Integrated device, use the keypad to press 000.
2. Type the password and then tap OK. The default password is 9416557.
3. Get the device ID from the Cloud Device ID field.

Getting the ID of a Tetra Lane 3000 device

1. From the system tray of the POS screen, right-click on the RCM icon.
2. Get the device ID from the device ID field.

For information about how to send the device ID, see Authenticating Your Request.

Confirm you have your API key and API secret 

We provide you with a set of credentials for the test endpoints and a set of credentials for the production endpoints. Each set of credentials includes the following:

• API key
• API secret
• Account credentials

Send an AuthToken in the request header to authenticate your request. For more information about authenticating your requests, see Authenticating Your Request.

Use your account credentials and the API secret to create an AuthToken for each request. For more information about creating an AuthToken, see AuthToken V2.

If you haven’t received your credentials, contact our Integrations Services team.

Important: Do not share your credentials with anyone. If you need to send us code examples, mask your credential details. 

Integration flexibility

We regularly update our API, so make sure that your integration is flexible enough to handle new response fields from our gateway. When building your integration, do not hard-code the sequence of fields that you expect us to return in the response.

Running follow-on transactions

To run follow-on transactions, include either the reference_id or one of the following unique identifiers in your request:

• creditsale_id - we assign this to credit sales.
• debitsale_id - we assign this to debit sales.
• creditreturn_id - we assign this to credit refunds.
• debitreturn_id - we assign this to debit refunds.