Advanced Transaction Search with Pagination

curl --request POST \
  --url https://test.paysight.io/api/mitigation/transactions \
  --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
  ],
  "includeUpdated": 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>"
    }
  ]
}

API for Chargeback Mitigation Providers

Advanced Transaction Search with Pagination

Searches for transactions using expanded filters such as transactionId, gatewayTransactionId, bin, authCodes, product and campaign filters. For broad range searches (for pulling large dataset) where only the date range is provided, a maximum of 7 days is allowed, i.e dateFrom must equal dateTo. There is also a rate limit of 40 requests per minute on this endpoint for broad range searches. Transactions that are refunded / chargedback / have associated alerts will not themselves be updated. Instead, there is a new refund / chargeback / alert transaction that can be linked to the original transaction by way of the ‘originalTransactionId’ field. These transactions are identifiable by their ‘applicationId’. 200=Refund 201=Chargeback 202=CB Alert (RDR/Ethoca)

POST

api

mitigation

transactions

Advanced Transaction Search with Pagination

curl --request POST \
  --url https://test.paysight.io/api/mitigation/transactions \
  --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
  ],
  "includeUpdated": 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>"
    }
  ]
}

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

Pagination filter. Set to 1 by default or omit on initial request.

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

includeUpdated

boolean

If true, will also return transactions that were captured during that period, even if authorized in a previous period. Note this does not affect refunds. A separate transaction will be returned for refund with a reference to the original transaction that was refunded.

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

Show child attributes

transactions.gateway

string

Gateway provider name (e.g., NMI)

transactions.transactionId

string

Unique identifier for the transaction

transactions.orderId

integer

Internal order ID

transactions.sent

string<date-time>

Timestamp when the transaction was sent

transactions.email

string

Customer email address

transactions.sandbox

boolean

Indicates if this transaction occurred in sandbox mode

transactions.applicationId

integer

ID of the application used to process the transaction

transactions.status

string

Human-readable transaction status

transactions.statusId

integer

Internal status code

transactions.success

boolean

Indicates whether the transaction was successfully charged

transactions.completed

string<date-time>

Timestamp when the transaction was completed/updated

transactions.currency

string

Transaction currency (e.g., USD)

transactions.amount

number

Transaction amount

transactions.mid

string

Merchant Identification Number (MID)

transactions.descriptor

string

Descriptor shown on bank statement

transactions.customerId

integer

Internal ID of the customer

transactions.authCode

string

Authorization code for the transaction

transactions.gatewayTransactionId

string

Identifier assigned by the payment gateway

transactions.firstName

string

First name of the customer

transactions.lastName

string

Last name of the customer

transactions.bin

string

First six digits of the credit card

transactions.last4

string

Last four digits of the credit card

transactions.refunded

boolean

Indicates if the transaction has been refunded

transactions.refundable

boolean

Indicates if the transaction is eligible for refund

transactions.hasAlert

boolean

Indicates if an alert is associated with this transaction

transactions.chargedBack

boolean

Indicates if the transaction was charged back

transactions.originalTransactionId

string

ID of the original transaction to which this transaction relates

Unsubscribe a user Payment API Integration

⌘I

Paysight API

Card Submit API

Card Submit API

Email Services

Customer Service API

Admin API

Mitigation API

Examples

Advanced Transaction Search with Pagination

Authorizations

Headers

Body

Response