Skip to main content
POST
/
api
/
transactions
/
search
Advanced transaction search
curl --request POST \
  --url https://test.paysight.io/api/transactions/search \
  --header 'Authorization: <api-key>' \
  --header 'ClientId: <clientid>' \
  --header 'Content-Type: application/json' \
  --header 'UserEmail: <useremail>' \
  --data '{
  "pageNumber": 123,
  "limit": 123,
  "emails": [
    "<string>"
  ],
  "orderIds": [
    123
  ],
  "transactionIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "gatewayTransactionIds": [
    "<string>"
  ],
  "bin": "<string>",
  "last4": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "authCodes": [
    "<string>"
  ],
  "currency": "<string>",
  "dateFrom": "2023-12-25",
  "dateTo": "2023-12-25",
  "descriptorContains": "<string>",
  "sandbox": true,
  "applicationIds": [
    123
  ],
  "productIds": [
    123
  ],
  "campaignIds": [
    123
  ],
  "merchantAccountIds": [
    123
  ],
  "companyIds": [
    123
  ],
  "amounts": [
    123
  ],
  "subscriptionIds": [
    123
  ],
  "affiliateIds": [
    123
  ],
  "mostRecentFirst": true,
  "statusIds": [
    123
  ],
  "dateCompleted": true
}'
{
  "success": true,
  "message": "<string>",
  "count": 123,
  "pageNumber": 123,
  "moreResults": true,
  "transactions": [
    {
      "gateway": "<string>",
      "transactionId": "<string>",
      "orderId": 123,
      "sent": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "sandbox": true,
      "applicationId": 123,
      "status": "<string>",
      "statusId": 123,
      "success": true,
      "completed": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "amount": 123,
      "mid": "<string>",
      "descriptor": "<string>",
      "customerId": 123,
      "authCode": "<string>",
      "gatewayTransactionId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "bin": "<string>",
      "last4": "<string>",
      "refunded": true,
      "refundable": true,
      "hasAlert": true,
      "chargedBack": true,
      "originalTransactionId": "<string>",
      "application": "<string>",
      "applicationId2": 123,
      "application2": "<string>",
      "shopId": 123,
      "storeName": "<string>",
      "storeDomain": "<string>",
      "storeRootDomain": "<string>",
      "originalApplicationId": 123,
      "originalApplication": "<string>",
      "merchantAccountId": 123,
      "midName": "<string>",
      "companyId": 123,
      "company": "<string>",
      "parentCompanyId": 123,
      "subId": 123,
      "refundSourceId": 123,
      "alertTypeId": 123,
      "alertSourceId": 123,
      "submitOrderId": 123,
      "alertSource": "<string>",
      "alertType": "<string>",
      "refundSource": "<string>",
      "binCountry": "<string>",
      "ipCountry": "<string>",
      "campaignId": 123,
      "campaign": "<string>",
      "affiliateId": 123,
      "affiliate": "<string>",
      "productId": 123,
      "product": "<string>",
      "paymentNumber": 123,
      "attempt": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your Paysight API key. You can find it in your Paysight account at https://app.paysight.io/settings/account

Headers

​
ClientId
string
required

Your Paysight Tenant/Client Id. This is the id of the parent company listed in https://app.paysight.io/management/companies. Alternatively, this will be provided by Paysight

​
UserEmail
string
required

The email address of the party or group making the request

Body

application/json

Request body for transaction search with flexible filters

​
pageNumber
integer
required

The current page number for results

​
limit
integer

The maxium number of results to return per page. Default is 100. Maxiumum is 1000.

​
emails
string[]

Filter transactions by one or more customer emails

​
orderIds
integer[]

Filter by one or more order IDs

​
transactionIds
string<uuid>[]

Filter by transaction UUIDs

​
gatewayTransactionIds
string[]

Gateway-specific transaction identifiers

​
bin
string

Bank Identification Number (first 6 digits)

​
last4
string

Last 4 digits of card

​
firstName
string

Customer first name

​
lastName
string

Customer last name

​
authCodes
string[]

Authorization codes

​
currency
string

Currency code (e.g., USD)

​
dateFrom
string<date>

Start of transaction date range

​
dateTo
string<date>

End of transaction date range

​
descriptorContains
string

Substring search on the descriptor

​
sandbox
boolean

If true, only return sandbox transactions

​
applicationIds
integer[]

Filter by application ID

​
productIds
integer[]

Filter by product ID

​
campaignIds
integer[]

Filter by campaign ID

​
merchantAccountIds
integer[]

Filter by specific merchant account IDs

​
companyIds
integer[]

Filter by company IDs

​
amounts
number[]

Filter by specific transaction amounts

​
subscriptionIds
integer[]

Filter by subscription IDs

​
affiliateIds
integer[]

Filter Affiliate (Traffic Source) Ids

​
mostRecentFirst
boolean

If true, results are sorted by most recent transactions first

​
statusIds
integer[]

Paysight Status Ids

​
dateCompleted
boolean

If true, timetamp of completion is used for date range filtering instead of sent timestamp

Response

200 - application/json

List of matching transactions

The response payload for transaction search endpoint

​
success
boolean

True if request succeeded

​
message
string

Response message for context

​
count
integer

Total number of records returned

​
pageNumber
integer

The page number of results

​
moreResults
boolean

True if there are more pages of data

​
transactions
object[]

Array of matching transactions

⌘I