Sign in

v1

latestOpenAPI 3.1.02026-07-24136043.5 KB

Direct transaction

Direct transaction endpoint.

post/transaction/v4/direct

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) length: 2. Allowed values: CA

languagestring

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

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).

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",
  "countryCode": "CA",
  "language": "en-ca",
  "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": 2015,
  "currencyCode": "CAD",
  "transactionType": "CREDIT"
}

Response

200 OK

transactionIdstring

The Paramount-assigned unique product transaction ID. If the transactionStatus is not PROCESSING, this is null.

transactionStatusstring

A FAILED status typically indicates an error related to transaction processing, such as a validation or internal error. A REJECTED status typically indicates that a service, such as risk management, stopped the request from proceeding. Allowed values: PROCESSING | REJECTED | FAILED

errorCodestring

The relevant error code, if applicable.

errorMessagestring

The error message associated with the error code. This is included only if the transactionStatus is FAILED or REJECTED. We recommend that merchant systems have a minimum Payout API timeout setting of 120 seconds.

Example response

{
  "transactionId": "20210512184646190729000000",
  "transactionStatus": "PROCESSING"
}