Find a transaction

get

https://api.openpath.io/platform/transactions/find

Find a transaction within the OpenPath Platform based on the supplied filtered attributes. Note that this API Endpoint is designed to find single transactions; however, based on some query attributes it may return multiple transactions. For instance, if you search for an Order ID and that order has had multiple transactions processed against it, like Authorization, Capture and Refund, then you may receive 3 transactions results.

Query Params

OrderId

string

length between 0 and 64

Will find all transactions that have the assoicated Order ID. This will include Sales, Authorizations, Captures, Voids, Redfunds and anything that was a single transaction action that was performed against this Order.

TransactionId

string

Will find all transactions that have the assoicated Payment Transaction ID. This is the Transaction ID that is returned from your Payment Processor or Gateway and not the OpenPath Transaction ID.

OpenPathTransactionId

int64

Will find the transaction that is assoicated to the OpenPath Transaction ID. This is the OpenPath Transaction ID that is unique per payment transaction, transactions such as Authorization, Capture, Sale, Void, Refund, Ect all will have a unique OpenPath Transaction ID.

PacketId

int64

Will find the transaction that is assoicated to the Packet ID of this transaction. When making calls to the OpenPath Transaction API, OpenPath will return the Packet ID in the header of the API response and is unique per every transaction request.

StartDate

date-time

Gets or sets the start date for the transaction or operation. This represents the beginning of the date range associated with the transaction's activity.

EndDate

date-time

Gets or sets the end date for the transaction or operation. This represents the conclusion of the date range associated with the transaction's activity.

Limit

int32

The number of data rows returned is limited to a value between 1 and 100, which is used for pagination purposes.

Offset

int32

The offset represents the page being returned from the original dataset in the pagination process or the page number calculated based on the specified limit.

Responses

200An array of transaction packets that matched the filter attributes.

400There was an error in the filter attributes.

404No transactions were found.

500There was an error on the server side and the error was logged, please reach out to [email protected] for further resolution.