v1

latestOpenAPI 3.1.02026-07-24136043.5 KB

Reporting

The Reporting API supports two types of report: transaction reports and return reports.

post/report/v4/report

Request body

productListstring required

The product type. Allowed value: IBT

Example request

{
  "productList": "IBT",
  "report": {
    "queryType": "TRANSACTION",
    "startDateTime": "2020-02-21T00:00:00.000Z",
    "endDateTime": "2020-03-21T23:59:59.000Z",
    "outputType": "JSON"
  },
  "merchant": {
    "merchantList": [
      "Test_Q_A",
      "AutoMerV"
    ],
    "merchantConsumerId": "user123"
  },
  "transaction": {
    "transactionType": "DEBIT",
    "transactionStatus": "SUCCESSFUL",
    "currencyCode": "CAD"
  }
}

Response

productstring

merchantIdstring

The Paramount-assigned unique merchant ID.

merchantUserIdstring

The Merchant-assigned unique consumer ID.

merchantTransactionIdstring

The merchant-assigned transaction ID.

transactionIdstring

The Paramount-assigned unique product transaction ID.

transactionNotifyStatusstring

The notification status of the transaction. C is completed, S is sent, I is not sent.

transactionRegionstring

The consumer's 2-letter province or other applicable geographic region. (ISO 3166-2:CA)

transactionAmountinteger

The transaction amount, expressed in cents.

currencyCodestring

The 3-letter currency code (ISO 4217).

countryCodestring

The 2-letter country code (ISO 3166-1 Alpha 2 Code).

transactionTypestring

DEBIT is a consumer payin. CREDIT is a payout from merchant to consumer.

transactionStatusstring

The transaction status. Allowed values: SUCCESSFUL, PENDING, REJECTED

transactionFeeinteger

The transaction fee amount, expressed in cents, payable by the merchant, if applicable.

transactionDateTimestring

The date and time the transaction was received by Instant Bank Transfer (ISO 8601).

externalReferencestring

External reference number.

errorCodestring

The relevant error code, if applicable.

errorMessagestring

The error message associated with the error code.

transactionPaymentMethodstring

The payment processing method.

Example response

{
  "product": "IBT",
  "merchantId": "ABC12345",
  "merchantUserId": "Suneesh132",
  "merchantTransactionId": "1623075288364",
  "transactionId": "20210512184646190729000000",
  "transactionNotifyStatus": "C",
  "transactionRegion": "ON",
  "transactionAmount": 241,
  "currencyCode": "CAD",
  "countryCode": "CA",
  "transactionType": "DEBIT",
  "transactionStatus": "SUCCESSFUL",
  "transactionFee": 300,
  "transactionDateTime": "2021-06-07T14:15:06.401093Z",
  "externalReference": "AH75WMHO3UQ1UNF",
  "transactionPaymentMethod": "EFT"
}