Search Transactions

Retrieve list of one or more transactions based on search criteria.

Request
Security:
Bearer
path Parameters
version
required
string
Request Body schema: application/json
limit
integer <int32>

Limit number of transactions to retrieve (Will be defaulted to 100 if none specified)

start_index
integer <int32>

Index used for pagination of the result.

person_guid
string <uuid>

Unique Person identifier on Qolo Platform.

account_guid
string <uuid>

Unique Account identifier on Qolo Platform.

wallet_guid
string <uuid>

Unique Wallet identifier on Qolo Platform.

wallet_id
string or null

Corresponding Wallet ID on Qolo Platform.

company_guid
string <uuid>

company unique Id

card_proxy
string or null

Unique identifier for the card.

card_number
string or null

16 digit Card number.

start_date
string <date-time>

Start Date in the format yyyy-MM-dd HH:mm:ss. Please use the format yyyy-MM-dd 00:00:00 to fetch data from start of the day.

end_date
string <date-time>

End Date in the format yyyy-MM-dd HH:mm:ss. Please use the format yyyy-MM-dd 23:59:59 to fetch data to end of the day.

txn_description
string or null

Transaction Description.

txn_amount_from
number <double>

Minimum transaction amount.

txn_amount_to
number <double>

Maximum transaction amount.

request_code
string or null

Request Code to identify the request type.

txn_days
integer <int32>

Number of days from start date or to end date, if either of the start date or end date is null. If both start date and end date are provided, this field is ignored.

mask_account_number
string or null

Masked account number.

reference_number
string or null

Transaction Reference Number provided by the network.

txn_amount
number <double>

Exact Transaction Amount.

txn_type
string or null

Transaction type. Possible values are 'C' for Credit only or 'D' for Debit only transactions.

acceptor_id
string or null

Unique reference identifying the merchant location.

txn_status
Array of strings or null

Transaction status. Possible values are 'pending', posted' and 'decline'.

program_guid
string <uuid>

Unique Program Identifier on Qolo Platform.

txn_currency
string or null

Transaction Currency in ISO-3digit format.

account_currency
string or null

Account Currency in ISO-3digit format.

txn_guid
string <uuid>

Unique Transaction Identifier on Qolo Platform.

Array of objects or null (TxnLedgerSettlementOrderSettingsDTO)

order by setting for transaction history

txn_category
Array of strings or null

Transaction category

Responses
200

Returns the transactions

400

Bad request

401

Unauthorized

404

Transaction not found

500

Server Error

post/api/{version}/transactions/search
Request samples
application/json
{
  • "limit": 0,
  • "start_index": 0,
  • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
  • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
  • "wallet_id": "string",
  • "company_guid": "e7c8755b-aece-46c7-a1c9-897cfb55ba0c",
  • "card_proxy": "string",
  • "card_number": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "txn_description": "string",
  • "txn_amount_from": 0,
  • "txn_amount_to": 0,
  • "request_code": "string",
  • "txn_days": 0,
  • "mask_account_number": "string",
  • "reference_number": "string",
  • "txn_amount": 0,
  • "txn_type": "string",
  • "acceptor_id": "string",
  • "txn_status": [
    • "string"
    ],
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "txn_currency": "string",
  • "account_currency": "string",
  • "txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
  • "order": [
    • {
      • "fieldName": "string",
      • "desc": true
      }
    ],
  • "txn_category": [
    • "string"
    ]
}
Response samples
application/json
{
  • "count": 0,
  • "start_index": 0,
  • "end_index": 0,
  • "has_more": true,
  • "data": [
    • {
      • "txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
      • "post_date": "2019-08-24T14:15:22Z",
      • "settle_date": "2019-08-24T14:15:22Z",
      • "txn_date": "2019-08-24T14:15:22Z",
      • "channel_name": "string",
      • "request_code": "string",
      • "response_code": "string",
      • "reason_code": "string",
      • "account_type": "string",
      • "instrument_type": "string",
      • "mask_account_number": "string",
      • "amount": 0,
      • "original_amount": 0,
      • "variance_amount": 0,
      • "variance_code": "string",
      • "cashback_amount": 0,
      • "txn_amount": 0,
      • "txn_currency": "str",
      • "account_currency": "str",
      • "currency_conv_rate": 0,
      • "currency_trade_markup": 0,
      • "available_balance": 0,
      • "ledger_balance": 0,
      • "suspense_balance": 0,
      • "reference_number": "string",
      • "mcc": "string",
      • "acceptor_id": "string",
      • "txn_location": "string",
      • "txn_location_mcc": "string",
      • "txn_city": "string",
      • "txn_country": "str",
      • "txn_lat": 0,
      • "txn_lon": 0,
      • "txn_description": "string",
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "base_txn_guid": "6b6e15ef-fbf2-4e4a-83d1-3a209d49c340",
      • "polar_txn_guid": "d4c4256e-d86f-401a-b603-fbe834eedd11",
      • "card_txn_guid": "ede15e23-cea1-446b-a539-eeb14a1ba828",
      • "card_settle_txn_guid": "19bbb32a-0322-4adf-863d-39df3d79c99c",
      • "acquire_txn_guid": "d7d3be8b-38db-4a5a-ad49-b7302e3bef7c",
      • "bank_eft_guid": "b91916c2-ae47-47fc-87e2-5a0a340e4c0b",
      • "journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
      • "source_code": "string",
      • "source_user_guid": "0aaedba8-146e-40a6-ad5f-54c512699647",
      • "settle_amount": 0,
      • "settle_currency_code": "string",
      • "txn_status": "string",
      • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
      • "source_username": "string",
      • "auth_available_balance": 0,
      • "card_proxy": "string",
      • "account_name": "string",
      • "journal_entry": "string",
      • "reason_code_description": "string",
      • "disputed_txn_guid": "0bc0f6a6-50c6-47f3-aad2-84ded8a79a00",
      • "related_reversal": true,
      • "related_refund": true,
      • "request_code_description": "string",
      • "request_code_txn_category": "string",
      • "dispute_status": "string",
      • "dispute_item_status": "string",
      • "sys_utcinserted": "2019-08-24T14:15:22Z",
      • "request_code_txn_type": "string",
      • "memo_code": "string",
      • "account_holder_first_name": "string",
      • "account_holder_last_name": "string",
      • "auth_supplement_data": {
        • "card_auth_txn_guid": "f0cb5c93-2e51-4afc-ac13-68fa4ac87119",
        • "sys_utcinserted": "2019-08-24T14:15:22Z",
        • "sys_utcupdated": "2019-08-24T14:15:22Z",
        • "payment_sender": "string",
        • "payment_receiver": "string",
        • "raw_token_data": "string",
        • "fraud_score_data": "string",
        • "token_data": "string",
        • "ecomm_data": "string",
        • "fleet_data": "string",
        • "account_name_data": "string",
        • "fraud_vector_data": "string",
        • "fraud_vector_data_test": "string"
        }
      }
    ],
  • "check_statuses": [
    • "string"
    ]
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.