Sign in

v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Gateway Features
Transactions

Get Transaction Data

❗️ Never Use Real API Keys

Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.

<details> <summary>Usage</summary> This is a query to find live transactions by merchants under your partner account. The query will respond in Universal Time Coordinated (UTC).

If you provide a specific transaction id, then it will return that transaction.

If you provide a sub-affiliates' merchant id in the merchant id list, it will return that merchant's transactions.

</details>
post/v4/transactions/reports

Headers

Content-Typestring required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Authorizationstring required

Your v4 API key that was generated in the Partner portal.

Request body

merchantIdstring

The merchant gateway ID to which the transactions belong.

merchantIdsstring[]

The merchants gateway IDs to which the transactions belong.

maxResultsstring required

Maximum number of results per page.

offsetstring

Offset value for pagination, or null if not used.

orderIdstring

The order ID of the transaction.

parstring

The Payment Account Reference ID to search for.

hmacstring

The Hash-based Message Authentication Code ID to search for.

serviceIdstring

The ID of the processor platform you want to search for.

platformIdstring

The ID of the platform.

firstNamestring

The first name of the merchant's company contact.

lastNamestring

The last name of the merchant's company contact.

emailstring

The email of the merchant's company contact.

accountNumberstring

Account Number.

transactionTypestring

Transaction type.

customerIdstring

Customer ID.

phonestring

The phone number of the merchant's company contact.

transactionIdsstring[]

Transactions IDs to search.

statusesstring[]

The list of statuses to query.

actionTypesstring[]

The type of transaction to query.

Response

Success

objectType'serviceConfig'

The type of object that was returned as a result of the request.

reportIdnumber

The ID of the report.

offsetnumber

The first N skipped results.

maxResultsnumber

The max number results.

totalResultsnumber

The total number of results.

hasMoreboolean

Indicates if there are more results available beyond the current page.