List Transactions
Returns a paginated list of transactions for the authenticated merchant.
Filtering and Sorting
You can filter and sort the results using query parameters:
Available Filter/Sort Fields:
id
- Transaction IDtimestamp
- Transaction timestamp (UTC)referenceId
- Reference IDorderNumber
- Order numberinvoiceNumber
- Invoice numbertype
- Transaction type (Sale, Refund, Void, Auth, Capture)amount
- Transaction amountstatus
- Transaction status (Created, Completed, Pending)
Transaction Status Definitions:
Created: Initial transaction state when created but not yet processed. This includes hosted payment form sessions that haven't been completed by the customer (the customer hasn't yet submitted payment) or hosted payment form sessions that were initiated but never finalized.
Completed: Final transaction state with definitive outcome. This includes successfully approved, declined, refunded, etc. transactions.
Pending: Transaction submitted and awaiting final processing results. This status is primarily used for ACH transactions (coming soon) where settlement takes several business days.
Note: Most card transactions move directly from Created
to Completed
status within seconds. The Pending
status is primarily reserved for ACH transactions (coming soon) and other payment methods that require extended processing time.
Deleted Token Behavior
When a token has been removed from the system, transactions that used that token will show:
dateDeleted
timestamp in the paymentMethod object- Sensitive fields (maskedCardNumber, cardExpDate) will be removed for security
- All other transaction data (amounts, authorization codes, card type) remains intact
Filter Operators:
Operator | Meaning |
---|---|
== |
Equals |
!= |
Not equals |
> |
Greater than |
< |
Less than |
>= |
Greater than or equal to |
<= |
Less than or equal to |
@= |
Contains |
_= |
Starts with |
_-= |
Ends with |
!@= |
Does not Contains |
!_= |
Does not Starts with |
!_-= |
Does not Ends with |
@=* |
Case-insensitive string Contains |
_=* |
Case-insensitive string Starts with |
_-=* |
Case-insensitive string Ends with |
==* |
Case-insensitive string Equals |
!=* |
Case-insensitive string Not equals |
!@=* |
Case-insensitive string does not Contains |
!_=* |
Case-insensitive string does not Starts with |
Special Filter Syntax:
- Use
|
(pipe) for OR conditions:type==Sale|Capture
- Use
-
prefix for descending sort:sorts=-timestamp
Examples:
- Filter by timestamp range:
?filters=timestamp>=2025-05-21T01:00:00,timestamp<2025-05-22T01:00:00
- Filter by type with OR:
?filters=type==Sale|Capture
- Filter by status:
?filters=status==Completed
- Sort by timestamp descending:
?sorts=-timestamp
- Combined:
?filters=timestamp>=2025-05-27T04:00:00.000Z,type==Sale|Capture&sorts=-timestamp
Note: All transaction timestamps are in UTC.
Query parameters
-
Filter criteria in the format: field==value,field!=value Multiple filters can be separated by commas. Use | for OR conditions within a field. Available fields: id, timestamp, referenceId, orderNumber, invoiceNumber, type, amount
-
Sort criteria as comma-separated field names. Use - prefix for descending order. Available fields: id, timestamp, referenceId, orderNumber, invoiceNumber, type, amount
-
Page number to retrieve (starts at 1). For example, if you have 100 records with 10 per page, page 2 gives you records 11 to 20.
Minimum value is
1
. Default value is1
. -
Number of records per page. For example, if you have 100 records with 10 per page, page 2 gives you records 11 to 20.
Minimum value is
1
, maximum value is100
. Default value is10
.
curl \
--request GET 'https://api.omni.integratedcommerce.io/v1/transactions' \
--header "x-api-key: $API_KEY"
{
"page": 1,
"items": [
{
"id": "trx_01JWBPE27KHY2K4J7A13ATQ786",
"type": "Sale",
"status": "Completed",
"timestamp": "2025-05-22T17:00:50Z",
"resultCode": 0,
"resultText": "APPROVED",
"orderNumber": "order_number_1234",
"referenceId": "ref_s192i49i",
"balanceAmount": 0,
"invoiceNumber": "inv_1234567890123456789012354678901",
"paymentMethod": {
"id": "pmt_vrt_01JRZPTWS99Z7RB57Q1CVWSWDS",
"type": "Virtual",
"currency": "USD",
"description": "Online Checkout Iframe"
},
"approvedAmount": 1000,
"requestedAmount": 1000,
"transactionResponses": [
{
"authCode": "111890",
"cardType": "VISA",
"avsResult": "Y",
"cvvResult": "M",
"accountType": "Credit",
"responseCode": 1,
"paymentMethod": {
"id": "pmt_tkn_01JRZPRGFF4J2SZC3HMDBYEN2J",
"type": "Token",
"cardType": "VISA",
"currency": "USD",
"cardExpDate": "1225",
"description": "Token for John Doe's Visa",
"maskedCardNumber": "4****1111"
},
"amountApproved": 1000,
"hostResponseText": "APPROVED"
}
]
},
{
"id": "trx_01JWBNTQ6G0MJWVADFZVYMXPBF",
"type": "Sale",
"status": "Completed",
"timestamp": "2025-05-22T19:22:47Z",
"resultCode": 0,
"resultText": "APPROVED",
"orderNumber": "order_number_1234",
"referenceId": "ref_s192i49i",
"balanceAmount": 0,
"invoiceNumber": "inv_1234567890123456789012354678901",
"paymentMethod": {
"id": "pmt_tkn_01JRZPRGFF4J2SZC3HMDBYEN2J",
"type": "Token",
"currency": "USD",
"description": "Token for John Doe's Visa"
},
"approvedAmount": 1000,
"requestedAmount": 1000,
"transactionResponses": [
{
"authCode": "111048",
"cardType": "VISA",
"avsResult": "Y",
"cvvResult": "M",
"accountType": "Credit",
"responseCode": 1,
"paymentMethod": {
"id": "pmt_tkn_01JRZPRGFF4J2SZC3HMDBYEN2J",
"type": "Token",
"cardType": "VISA",
"currency": "USD",
"cardExpDate": "1225",
"description": "Token for John Doe's Visa",
"maskedCardNumber": "4****1111"
},
"amountApproved": 1000,
"hostResponseText": "APPROVED"
}
]
}
],
"pageSize": 10,
"totalCount": 2,
"totalPages": 1,
"hasNextPage": false,
"hasPreviousPage": false
}
{
"page": 1,
"items": [
{
"id": "trx_01JWBNTQ6G0MJWVADFZVYMXPBF",
"type": "Capture",
"status": "Completed",
"timestamp": "2025-05-27T18:59:31Z",
"resultCode": 0,
"resultText": "APPROVED",
"orderNumber": "order_number_1234",
"referenceId": "ref_s192i49i",
"balanceAmount": 0,
"invoiceNumber": "inv_1234567890123456789012354678901",
"paymentMethod": {
"id": "pmt_tkn_01JRZPRGFF4J2SZC3HMDBYEN2J",
"type": "Token",
"currency": "USD",
"description": "Token for John Doe's Visa"
},
"approvedAmount": 450,
"requestedAmount": 450,
"transactionResponses": [
{
"authCode": "111688",
"cardType": "VISA",
"avsResult": "Y",
"cvvResult": "M",
"accountType": "Credit",
"responseCode": 1,
"paymentMethod": {
"id": "pmt_tkn_01JRZPRGFF4J2SZC3HMDBYEN2J",
"type": "Token",
"cardType": "VISA",
"currency": "USD",
"cardExpDate": "1225",
"description": "Token for John Doe's Visa",
"maskedCardNumber": "************0011"
},
"amountApproved": 450,
"hostResponseText": "APPROVED",
"maskedCardNumber": "4****5297"
}
]
},
{
"id": "trx_01JWBPE27KHY2K4J7A13ATQ786",
"type": "Sale",
"status": "Completed",
"timestamp": "2025-05-27T18:49:31Z",
"resultCode": 0,
"resultText": "APPROVED",
"orderNumber": "order_number_1234",
"referenceId": "ref_s192i49i",
"balanceAmount": 0,
"invoiceNumber": "inv_1234567890123456789012354678901",
"paymentMethod": {
"id": "pmt_vrt_01JRZPTWS99Z7RB57Q1CVWSWDS",
"type": "Virtual",
"currency": "USD",
"description": "Online Checkout Iframe"
},
"approvedAmount": 1000,
"requestedAmount": 1000,
"transactionResponses": [
{
"authCode": "111890",
"cardType": "VISA",
"avsResult": "Y",
"cvvResult": "M",
"accountType": "Credit",
"responseCode": 1,
"paymentMethod": {
"id": "pmt_tkn_01JRZPRGFF4J2SZC3HMDBYEN2J",
"type": "Token",
"cardType": "VISA",
"currency": "USD",
"cardExpDate": "1225",
"description": "Token for John Doe's Visa",
"maskedCardNumber": "************0011"
},
"amountApproved": 1000,
"hostResponseText": "APPROVED",
"maskedCardNumber": "4****1111"
}
]
}
],
"pageSize": 10,
"totalCount": 2,
"totalPages": 1,
"hasNextPage": false,
"hasPreviousPage": false
}
{
"code": 1000,
"status": "Rejected",
"message": "API key cannot be empty",
"traceId": "1-6838be96-74c62f8e2804352739e63476",
"timestamp": "2025-05-29T20:07:50.4723483Z",
"errorDetails": []
}