Before you begin

Before you can begin your Instant Bank Transfer integration, you must receive your unique Merchant ID from the Merchant Integration team.

In addition to your merchant ID, you must have the following OAuth credentials, which will allow you to create an access token:

Client ID - A string that uniquely identifies the merchant system generating the token.
Client Secret - The private client secret is a password known only to the merchant and the authorization server.
App ID - The app ID identifies the products and functionality that the client ID is authorized to access.

Configure the staging environment

In addition to your merchant ID and OAuth credentials, you'll need information about the staging environment and you'll need to provide Paramount with details about your merchant system.

Instant Bank Transfer service URLs

IBT uses the following URLs or endpoints to communicate with your system. Depending on how your merchant system is configured, you may need to add these domains to your allow list.

Service	URL
Interactive transactions	https://api-mint.paramountcommerce.com/oebigstari/transaction/v4/interactive
Direct transactions	https://api-mint.paramountcommerce.com/oebigstard/transaction/v4/direct
Notify verification	https://api-mint.paramountcommerce.com/oebigstarnoti/service/servlet/ConfirmTrans
Get transaction status	https://api-mint.paramountcommerce.com/oebigstarnoti/report/v4/transaction-status
OAuth	https://auth-mint.paramountcommerce.com/oauth2/token

Instant Bank Transfer IP addresses

Add the following staging environment IP addresses and fully qualified domain names (FQDN) to your merchant system allow list to allow communication with the Instant Bank Transfer API.

Address type	Domain or IP address
Incoming	api-mint.paramountcommerce.com auth-mint.paramountcommerce.com
Outgoing	3.98.246.170 35.182.33.27 52.60.171.198

Staging test consumer data

Testing in the staging environment requires specific data in the API calls. Use these details to test your integration.

NOTE

Replace the example merchant credentials with your own staging environment merchant credentials.

Use a unique merchantTransactionId for each test request.

Payin

First-time interactive payin

{
  "product": "IBT",
  "countryCode": "CA",
  "transactionRegion": "QC",
  "language": "en-ca",
  "dataPassThrough": "Yes",
  "originatorIp": "184.146.84.81",
  "merchant": {
    "merchantId": "{{merchantId}}",
    "merchantUserId": "{{merchantuserID}}",
    "merchantTransactionType": "CASINO",
    "merchantTransactionId": "merchant_00000000030",
    "merchantSubId": 0
  },
  "consumer": {
    "dob": "2000-05-05",
    "consumerType": "SENDER",
    "contactInfo": {
      "sender": {
        "nameType": "PERSON",
        "name": {
          "firstName": "John",
          "lastName": "Doe",
          "middleName": "string"
        },
        "address": "1275 avenue des Canadiens-de-Montréal",
        "address2": "",
        "region": "QC",
        "city": "Montréal",
        "postalCode": "H3B 5E8",
        "countryCode": "CA"
      }
    },
    "driversLicense": "L123345",
    "driversLicenseState": "ON",
    "phoneNumber": "+14161234567",
    "email": "user@example.com"
  },
  "transactionAmount": 100,
  "currencyCode": "CAD",
  "returnUrl": "https%3A%2F%2Fwww.google.com",
  "transactionType": "DEBIT"
}

Interactive payin with account token

{
  "product": "IBT",
  "countryCode": "CA",
  "transactionRegion": "QC",
  "language": "en-ca",
  "dataPassThrough": "Yes",
  "originatorIp": "184.146.84.81",
  "merchant": {
   "merchantId": "{{merchantId}}",
    "merchantUserId": "{{merchantUserId}}",
    "merchantTransactionType": "CASINO",
    "merchantTransactionId": "merchant_00000000036",
    "merchantSubId": 0
  },
  "consumer": {
    "dob": "2000-05-05",
    "consumerType": "SENDER",
    "contactInfo": {
      "sender": {
        "nameType": "PERSON",
        "name": {
          "firstName": "John",
          "lastName": "Doe",
          "middleName": "string",
          "fullName": "John Doe"
        },
        "address": "1275 avenue des Canadiens-de-Montréal",
        "address2": "",
        "region": "QC",
        "city": "Montréal",
        "postalCode": "H3B 5E8",
        "countryCode": "CA"
      }
    },
    "driversLicense": "L123345",
    "driversLicenseState": "ON",
    "phoneNumber": "+14161234567",
    "email": "user@example.com"
  },
 "bank": {
    "bankInformationType": "TOKEN",
    "accountToken": "COVf9830a7998c64bd98b42802518ef8c0a"
  },
  "transactionAmount": 100,
  "currencyCode": "CAD",
  "returnUrl": "https%3A%2F%2Fwww.merchant.com%2Fpay%2Fcompleted.html",
  "transactionType": "DEBIT"
}

Direct payin

{
  "product": "IBT",
  "countryCode": "CA",
  "transactionRegion": "QC",
  "language": "en-ca",
  "dataPassThrough": "Yes",
  "originatorIp": "184.146.84.81",
  "merchant": {
   "merchantId": "{{merchantId}}",
    "merchantUserId": "{{merchantUserId}}",
    "merchantTransactionType": "CASINO",
    "merchantTransactionId": "merchant_00000000031",
    "merchantSubId": 0
  },
  "consumer": {
    "dob": "2000-05-05",
    "consumerType": "SENDER",
    "contactInfo": {
      "sender": {
        "nameType": "PERSON",
        "name": {
          "firstName": "John",
          "lastName": "Doe",
          "middleName": "string"
        },
        "address": "1275 avenue des Canadiens-de-Montréal",
        "address2": "",
        "region": "QC",
        "city": "Montréal",
        "postalCode": "H3B 5E8",
        "countryCode": "CA"
      }
    },
    "driversLicense": "L123345",
    "driversLicenseState": "ON",
    "phoneNumber": "+14161234567",
    "email": "user@example.com"
  },
 "bank": {
    "bankInformationType": "TOKEN",
    "accountToken": "COVf9830a7998c64bd98b42802518ef8c0a"
  },
  "transactionAmount": 100,
  "currencyCode": "CAD",
  "transactionType": "DEBIT"
}

Payout

Interactive payout (Alternate verified payout)

{
  "product": "IBT",
  "countryCode": "CA",
  "transactionRegion": "ON",
  "language": "en-ca",
  "dataPassThrough": "Yes",
  "originatorIp": "184.146.84.81",
  "merchant": {
    "merchantId": "{{merchantId}}",
    "merchantUserId": "{{merchantUserId}}",
    "merchantTransactionType": "CASINO",
    "merchantTransactionId": "merchant_00000000033",
    "merchantSubId": 0
  },
  "consumer": {
    "dob": "2000-05-15",
    "consumerType": "RECEIVER",
    "contactInfo": {
      "receiver": {
        "nameType": "PERSON",
        "name": {
          "firstName": "John",
          "lastName": "Doe",
          "middleName": ""
        },
        "address": "1275 avenue des Canadiens-de-Montréal",
        "address2": "",
        "region": "QC",
        "city": "Montréal",
        "postalCode": "H3B 5E8",
        "countryCode": "CA"
      }
    },
    "driversLicense": "L123345",
    "driversLicenseState": "ON",
    "email":"user@example.com",
    "phoneNumber": "+14161234567"
  },
  "transactionAmount": 350,
  "currencyCode": "CAD",
  "returnUrl": "https%3A%2F%2Fwww.merchant.com%2Fpay%2Fcompleted.html",
  "transactionType": "CREDIT"
}

Interactive payout with account token

{
  "product": "IBT",
  "countryCode": "CA",
  "transactionRegion": "QC",
  "language": "en-ca",
  "dataPassThrough": "Yes",
  "originatorIp": "184.146.84.81",
  "merchant": {
    "merchantId": "{{merchantId}}",
    "merchantUserId": "{{merchantUserId}}",
    "merchantTransactionType": "CASINO",
    "merchantTransactionId": "merchant_00000000035",
    "merchantSubId": 0
  },
  "consumer": {
    "dob": "2000-05-05",
    "consumerType": "RECEIVER",
    "contactInfo": {
      "receiver": {
        "nameType": "PERSON",
        "name": {
          "firstName": "John",
          "lastName": "Doe",
          "middleName": ""
        },
        "address": "1275 avenue des Canadiens-de-Montréal",
        "address2": "",
        "region": "QC",
        "city": "Montréal",
        "postalCode": "H3B 5E8",
        "countryCode": "CA"
      }
    },
    "driversLicense": "L123345",
    "driversLicenseState": "ON",
    "phoneNumber": "+14161234567",
    "email": "user@example.com"
  },
 "bank": {
    "bankInformationType": "TOKEN",
    "accountToken": "COVf9830a7998c64bd98b42802518ef8c0a"
  },
  "transactionAmount": 100,
  "currencyCode": "CAD",
  "returnUrl": "https%3A%2F%2Fwww.merchant.com%2Fpay%2Fcompleted.html",
  "transactionType": "CREDIT"
}

Direct payout with token

{
  "product": "IBT",
  "countryCode": "CA",
  "transactionRegion": "ON",
  "language": "en-ca",
  "dataPassThrough": "Yes",
  "originatorIp": "24.50.160.0",
  "merchant": {
   "merchantId": "{{merchantId}}",
    "merchantUserId": "{{merchantUserId}}",
    "merchantTransactionType": "CASINO",
    "merchantTransactionId": "merchant_00000000037",
    "merchantSubId": 0
  },
  "consumer": {
    "dob": "2000-05-05",
    "consumerType": "RECEIVER",
    "contactInfo": {
      "receiver": {
        "nameType": "PERSON",
        "name": {
          "firstName": "John",
          "lastName": "Doe",
          "middleName": ""
        },
        "address": "1275 avenue des Canadiens-de-Montréal",
        "address2": "",
        "region": "QC",
        "city": "Montréal",
        "postalCode": "H3B 5E8",
        "countryCode": "CA"
      }
    },
    "driversLicense": "L123345",
    "driversLicenseState": "ON",
    "phoneNumber": "+14161234567",
    "email": "user@example.com"
  },
  "bank": {
    "bankInformationType": "TOKEN",
    "accountToken": "COVf9830a7998c64bd98b42802518ef8c0a"
  },
  "transactionAmount": 350,
  "currencyCode": "CAD",
  "transactionType": "CREDIT"
}

Provide your merchant system information

You must provide the following URL and IP address information to Paramount for each of your merchant test systems, including sub ID sites.

Server IP address - The public IP address of the merchant server that will send requests and queries to Instant Bank Transfer. If multiple IP addresses are bound to the server, provide the primary IP address. Merchant server IP addresses are added to the Instant Bank Transfer server access control list (ACL) to validate each server request from the merchant.
Transaction notification URL - The URL of the merchant server application where Instant Bank Transfer will send transaction notifications. For secure URLs using HTTPS, ensure that the server certificate is issued from a known public certificate authority (CA), such as VeriSign. This URL can include up to 128 characters.
Event notification URL - The URL of the merchant server application where Instant Bank Transfer will send event notifications, such as bank returns. This URL can include up to 128 characters.

Transaction terminology

Throughout the Instant Bank Transfer product documentation, you'll frequently see the terms debit, credit, payin, and payout referring to types of transaction. In general, we use these terms as described in the following table:

Term	Meaning
Payin or Debit	A payment made by a consumer to a merchant.
Payout or Credit	A payment made by a merchant to a consumer.

Getting help

Paramount Commerce support is happy to answer any questions you have and help with technical issues including:

Obtaining test and production environment authentication credentials
Merchant system implementation
Post-implementation best practices

You can contact us at integrations@paramountcommerce.com.