Sign in

v1

latestOpenAPI 3.1.02026-07-24136043.5 KB

Interactive transaction

Interactive transaction endpoint.

post/transaction/v4/interactive

Request body

productstring required

The product type. Allowed value: IBT

transactionRegionstring required

The 2-letter province or other applicable geographic region where the transaction funds will be used. (ISO 3166-2:CA)

countryCodestring required

The consumer's 2-letter (non-numeric) country code. (ISO 3166-1 alpha-2). Allowed values: CA

languagestring required

The consumer's language code. (ISO 639-1).

dataPassThroughstring

A pass-through field that can be used as an extra parameter to identify the transaction or consumer.

originatorIpstring required

The consumer's IP address used to initiate the transaction

transactionAmountinteger required

The transaction amount expressed in cents. Instant Bank Transfer limits the maximum amount to 9999900 cents

currencyCodestring required

The 3-letter currency code (ISO 4217).

returnUrlstring required

The merchant system URL where the consumer’s browser is redirected at the end of the transaction process. The URL must be URL-encoded and in canonical format.

transactionType'DEBIT' | 'CREDIT' required

A DEBIT transaction is a consumer payin. A CREDIT transaction is a payout from merchant to consumer. Allowed values: DEBIT | CREDIT

Example request

{
  "product": "IBT",
  "transactionRegion": "ON",
  "language": "en-ca",
  "dataPassThrough": "sub-",
  "originatorIp": "198.51.100.1",
  "merchant": {
    "merchantId": "Paramount",
    "merchantUserId": "user"
  },
  "consumer": {
    "firstName": "Alberta",
    "lastName": "Charleson",
    "dob": "1971-01-01",
    "postalCode": "H3B-5E8",
    "emailAddress": "frodo@bagend.com",
    "emailAddressVerifiedTime": "2021-06-04T16:39:57-08:00",
    "phoneNumberVerifiedTime": "2021-06-04T16:39:57-08:00",
    "originatorIp": "174.26.150.77"
  },
  "bank": {
    "accountToken": "250c069f-b9af-460c-98f8-79c2511f4e46",
    "bankInformationType": "TOKEN"
  },
  "transactionAmount": 100,
  "currencyCode": "CAD",
  "returnUrl": "https%3A%2F%2Fwww.mysite.com",
  "transactionType": "DEBIT"
}

Response

200 OK

requestIdstring

The Paramount-assigned transaction request ID.

requestStatusstring

A REJECTED status typically indicates that a service, such as risk management, stopped the request from proceeding. Allowed values: PROCESSING | REJECTED

transactionUrlstring

The URL to open for consumers in a webview / same browser for an interactive session where the consumer will select and log in to their online banking.

errorCodestring

The relevant error code, if applicable.

errorMessagestring

The error message associated with the error code.

Example response

{
  "requestId": "1323445",
  "requestStatus": "SUCCESS",
  "transactionUrl": "https://ibt-mint.pay-direct.ca/verification?code=91e8d15f-c0f1-40c3-88a0-50fb4838cf06"
}