Skip to main content
POST
/
api
/
mitigation
/
search
Search
curl --request POST \
  --url https://test.paysight.io/api/mitigation/search \
  --header 'Authorization: <api-key>' \
  --header 'ClientId: <clientid>' \
  --header 'Content-Type: application/json' \
  --header 'UserEmail: <useremail>' \
  --data '{
  "email": "user@example.com",
  "orderId": 123456,
  "bin": "411111",
  "last4": "4242",
  "firstName": "John",
  "lastName": "Doe",
  "authCode": "ABC123",
  "arn": "123456789012345",
  "amount": 49.99,
  "currencyCode": "USD",
  "dateFrom": "2024-01-01",
  "dateTo": "2024-01-31",
  "mid": "MID123456",
  "descriptorExactMatch": "mydescriptor.com 558111222",
  "descriptorContains": "mydescriptor"
}'
{
  "success": true,
  "message": "<string>",
  "count": 123,
  "transactions": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

Your Paysight API key

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 payload for searching mitigation-related transactions

​
email
string

Customer's email address

Example:

"user@example.com"

​
orderId
integer

Unique order identifier

Example:

123456

​
bin
string

First 6 digits of the credit card (BIN)

Example:

"411111"

​
last4
string

Last 4 digits of the credit card

Example:

"4242"

​
firstName
string

Customer's first name

Example:

"John"

​
lastName
string

Customer's last name

Example:

"Doe"

​
authCode
string

Authorization code for the transaction

Example:

"ABC123"

​
arn
string

Acquirer Reference Number

Example:

"123456789012345"

​
amount
number

Transaction amount

Example:

49.99

​
currencyCode
string

ISO currency code

Example:

"USD"

​
dateFrom
string<date>

Start date of the search range (yyyy-MM-dd)

Example:

"2024-01-01"

​
dateTo
string<date>

End date of the search range (yyyy-MM-dd)

Example:

"2024-01-31"

​
mid
string

Merchant ID

Example:

"MID123456"

​
descriptorExactMatch
string

Descriptor string to match exactly

Example:

"mydescriptor.com 558111222"

​
descriptorContains
string

Descriptor substring to search for

Example:

"mydescriptor"

Response

Search results

​
success
boolean
​
message
string
​
count
integer
​
transactions
object[]