---
title: "Get transaction status"
method: POST
path: "/report/v4/transaction-status"
---

# Get transaction status

`POST /report/v4/transaction-status`

Get transaction status endpoint.

## Request body

- TransactionStatusRequest
  - `transactionId` string, required — The Paramount-assigned unique product transaction ID.

## Response `200`

OK

- TransactionStatusResponse
  - `merchant` Merchant
    - `merchantId` string, required — Merchant's assigned Paramount Commerce ID
    - `merchantSubId` string, required — "Merchant Sub ID. This parameter is used to separate reporting and notifications by Merchants who process transactions for multiple websites or need to separate their traffic for other reasons."
    - `merchantUserId` string, required — Merchant's user ID
    - `merchantTransactionId` string, required
  - `transaction` StatusTransaction
    - `transactionType` 'DEBIT' | 'CREDIT' — DEBIT is a consumer payin. CREDIT is a payout from merchant to consumer. Allowed values: DEBIT | CREDIT
    - `transactionFee` integer — The transaction fee amount payable by the merchant, if applicable.
    - `transactionStatus` 'SUCCESS' | 'REJECTED' | 'FAILED' — 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: SUCCESS | REJECTED | FAILED
    - `currencyCode` string — The 3-letter currency code (ISO 4217).
    - `transactionId` string — The Paramount-assigned unique product transaction ID.
    - `paymentMethod` string — The payment processing method. Allowed value: EFT
    - `errorCode` string — The relevant error code, if applicable.
    - `returnCode` string — The applicable EFT return code. This is included only if the transactionStatus is RETURNED or RETURNED_WITH_REPRESENTMENT.
    - `nextActionDate` string — The representment date. This is included only if the transactionStatus is RETURNED or RETURNED_WITH_REPRESENTMENT.(ISO 8601) yyyy-MM-dd
  - `account` StatusAccount
    - `accountMask` string — The masked account number that will be displayed by the merchant to the consumer in subsequent transactions. This is in the format ****1234.
    - `bankName` string — The name of the consumer’s bank.
    - `obvToken` string — A token that uniquely identifies the consumer’s bank account in the Instant Bank Transfer system.
    - `accountType` string — The consumer’s bank account type, either personal checking (PC) or personal savings (PS)

## Other responses

- `400` — Invalid request
- `401` — Not authorized
- `500` — Internal system error

---

[API](https://skmtc.dev/paramountcommerce/apis/interac-api.md) · [All operations](https://skmtc.dev/paramountcommerce/apis/interac-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/paramountcommerce/interac-api/revisions/18be16246225/schema)