Quick Reference

Step by step set-up guide

The Exact Payments Onboarding API is designed to enable partner companies to automate boarding of merchant accounts to our payment gateway.

The following steps allow for set-up of your Partner account in our Admin portal and integration to the Onboarding API.

Step 1: Set-up Partner Administrator User

Using the credentials provided in the new Partner email from Exact Payments, login at https://admin.exactpaysandbox.com/

Complete the password change process and login into the Gateway admin portal.

Create an API key for the Onboarding API--- go to Administration >> API Keys. Click ‘Generate Initial API key’.

The Partner Admin user is responsible for managing API keys. It is important to copy the actual key value before clicking Save. After selecting Save, the key value will no longer be displayed. The API key is required for submitting Onboarding API requests.

Step 2: Onboard & Activate Exact Payments Gateway Accounts

You are now ready to onboard and activate new gateway accounts using the Onboarding API. In this process, you will be passing merchant account information including Merchant ID values provided by the Acquiring Bank and/or Processor. The API action ties the merchant account to the newly created Exact Payments gateway ID and completes activation.

Use the following sandbox API URL: https://api.exactpaysandbox.com/

The following data is required for submission in the Onboarding API request:

  • merchant admin email address (must be unique)
  • Merchant ID provided by Acquiring Bank or Processor. For Fiserv merchants, a DIV ID is also required. Both MID and DIV ID must be unique.
  • Properly formatted address including country and state codes.

Onboarding API Sample Request

Here’s a sample request for the Onboarding API. Just replace the XXXXXXXX placeholders with the appropriate values for the account you want to board. You will need to POST it to the “/accounts” endpoint, with the appropriate Authorization header.

{
"business_entity": {
"name": "XXXXXXXX",
"phone":"XXXXXXXX",
"website":"https://exactpayments.com",
"address": {
"line1": "4665 Kerry Way",
"line2": "Suite 302",
"city": "Burbank",
"state": "CA",
"postal_code": "91505",
"country_code": "USA"
}
},
"admin_user": {
"first_name": "XXXXXXXX",
"last_name": "XXXXXXXX",
"email": "XXXXXXXX",
"phone": "555 123 456778",
"phone_type": "W"
},
"terminal": {
"settlement_entity": {
"name": "Settlement Name",
"address": {
"line1": "34665 Kerry Way",
"line2": "",
"city": "Burbank",
"state": "CA",
"postal_code": "91505",
"country_code": "USA"
}
},
"time_zone": "PST",
"processor_details": {
"first_data": {
"mid": "XXXXXXXX",
"division_id": "XXXXXXXX",
"card_brands": [
{
"brand": "visa",
"mcc": "7300"
},
{
"brand": "mastercard",
"mcc": "7300"
},
{
"brand": "discover",
"mcc": "7300"
},
{
"brand": "amex",
"mcc": "7300"
},
{
"brand": "jcb",
"mcc": "2222"
},
{
"brand": "diners",
"mcc": "7300"
}
]
}
}
}
}

If there is a problem with the request, you will receive an appropriate error response such as validation error, authentication error, account already exists etc.

Valid requests will generate a response which includes the details of the account created.

The following elements in the response will need to be provided to the merchant you have just onboarded:

  • The “username” in the “admin_user” element
  • The “activation_link” from the “admin_user” element
  • The “gateway_id” from the ”terminal” element
  • The MID you sent in the API request

Step 3: Other Functions

As Partner Admin, you are able to login to Exact Gateway Administration portal in order to access a list of accounts onboarded under your Partner account.

Partner Admins are not permitted to change settings for the accounts listed under your Partner ID. Only the Merchant Administrator has the ability to change settings and permissions or add users to the gateway account.

Partner Admins are not permitted to process transactions (even for testing purposes) from the Virtual Terminal within the Administration portal. This function is reserved for the Merchant.

Step 4: New Merchant account details

As the Partner/Reseller, you are responsible for providing your merchant with the new gateway account credentials. This is typically sent in an email communication to the customer’s designated Merchant Administrator. The Merchant Admin is responsible for managing all aspects of the newly created merchant account.

From the Onboarding response, you should provide your merchant with the following credentials in order to access the new gateway account:

  • “activation_link”
  • “username”
  • MID
  • “gateway_id”

Your merchant will use the activation link to initiate account set-up. The link will prompt for MID. Once entered, the merchant will be prompted to change password and set-up security questions. Now, the Merchant Admin has full access to our Gateway Administration and is ready to proceed with integration and user set-up.

If your merchant intends to use the Payments API, you should point them to our developer portal at https://developer.exactpay.com for integration details.

If requested, you may want to provide your merchant with a sample Payments API request to get started with integration and testing.

Payments API Sample Request

Here’s a sample request for the Payments API. Just replace the XXXXXXXX placeholders with the appropriate values for the terminal you are processing on. You will need to POST it to the “/payments” endpoint, with the appropriate Authorization header.

{
"amount": 100,
"terminal": {
"gateway_id": "XXXXXXXX",
},
"customer": {
"name": "Bob Jones",
},
"payment_method": {
"credit_card": {
"cardholder": "Bob Jones",
"number": "4111111111111111",
"expiry_month": "10",
"expiry_year": "2024"
}
}
}