Transaction Queries API Guide

Overview

The Transaction Queries topic focuses on the various APIs available for retrieving transaction details within the Closed Loop system. These APIs are essential for users who need to query and manage transactions based on different parameters such as transaction identifiers, dates, types, and merchants. The goal of these APIs is to allow users to access transaction data in a flexible and efficient manner.

The following APIs are available for querying transaction details:

GetClosedloopTransactionList
Retrieves a list of transactions for a specific Business Unit (BU) or merchant, with optional filters such as transaction type, start and end date, and merchant account key. This API supports pagination and enables users to filter transaction data based on various criteria.
GetClosedloopTransactionById
Retrieves detailed information for a specific transaction using its unique TransactionIdentifier. This API allows users to get comprehensive details about a transaction, such as status, value, and settlement date.

Key Features

Flexible Filtering: Users can filter transactions by TransactionIdentifier, MerchantAccountKey, TransactionType, and Date Range.
Pagination Support: Both GetClosedloopTransactionList and GetClosedloopTransactionById support pagination for large data sets.
Idempotency: APIs ensure that the requests are idempotent, meaning that duplicate transactions will not be created if the same request is sent multiple times.
Transaction Type Support: You can query by specific types of transactions such as Purchase, Withdrawal, and Deposit.

Supported Filters

TransactionIdentifier: Retrieve data for a specific transaction.
MerchantAccountKey: Filter transactions for a particular merchant.
TransactionType: Filter transactions by type (Purchase, Withdrawal, Deposit).
StartDate & EndDate: Filter transactions based on a date range.

Available APIs for Transaction Queries

GetClosedloopTransactionList
- Provides a list of transactions for a Business Unit or merchant.
- Filters can be applied for transaction type, date range, and merchant key.
GetClosedloopTransactionById
- Retrieves a single transaction's details using its unique identifier.
- Returns detailed information such as transaction status, value, and related accounts.

Usage

GetClosedloopTransactionList is useful for retrieving large sets of transaction data and supports pagination. It is ideal for filtering multiple transactions based on transaction types, dates, or merchant accounts.
GetClosedloopTransactionById is ideal for retrieving detailed information on a specific transaction. It requires the TransactionIdentifier and provides a complete snapshot of the transaction's details, including status and settlement information.

By using these APIs, users can gain comprehensive insights into transaction activity, ensuring that all relevant data can be retrieved efficiently for analysis and reporting.

Transaction Statuses in Transaction Queries API

Overview

The Transaction Statuses represent the current state of a transaction within the Closed Loop system. These statuses are returned when querying transactions using the APIs, such as GetClosedloopTransactionList and GetClosedloopTransactionById. Understanding these statuses is essential for interpreting the results of transaction queries.

Available Transaction Statuses

Created (0)
Indicates that the transaction has been created but has not yet been processed or authorized.
Canceled (1)
Indicates that the transaction was canceled either by the user or the system before completion.
Settled (2)
Indicates that the transaction has been completed and the funds have been successfully transferred.
PreSettled (3)
Indicates that the transaction is in a pre-settlement state and is awaiting final processing or confirmation.
PreCanceled (4)
Indicates that the transaction is in a pre-cancellation state and has not been fully canceled yet.
CanBePreAuthorized (5)
Indicates that the transaction can be pre-authorized, meaning it is eligible for the initial authorization process.
CanBeAuthorized (6)
Indicates that the transaction is ready and can be fully authorized.
Authorized (7)
Indicates that the transaction has been successfully authorized and is awaiting settlement or completion.
Registered (8)
Indicates that the transaction has been registered in the system, but further processing is required.
CanBePreCanceled (9)
Indicates that the transaction can be pre-canceled, allowing for an initial cancellation process.
PreAuthorized (10)
Indicates that the transaction has been pre-authorized and is awaiting further processing before full authorization.
CanBeSettled (11)
Indicates that the transaction can be settled and finalized.
CanBeCanceled (12)
Indicates that the transaction is eligible for cancellation at any point before it is completed.
ErrorBalance (13)
Indicates that there was an error with the balance, preventing the transaction from being processed successfully.

Usage

When querying transaction details, the status field provides crucial information about the transaction's state. By filtering or interpreting transaction statuses, users can better understand the outcome of their transactions, enabling improved tracking and reporting.

Each of these statuses will be returned as part of the response for any transaction query made through the Transaction Queries APIs.