Widget SDK Reference
Examples
Paysight API
Email Services
Payment API
- Card
Customer Service API
- API Reference
Admin API
- MerchantAccounts
- Transactions
Mitigation API
- API for Chargeback Mitigation Providers
Transactions
Advanced transaction search
Searches for transactions using expanded filters such as transactionId, gatewayTransactionId, bin, authCodes, product and campaign filters.
POST
/
api
/
transactions
/
search
Copy
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
]
}'
Copy
{
"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
Your Paysight API key. You can find it in your Paysight account at https://app.paysight.io/settings/account
Headers
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
The email address of the party or group making the request
Body
application/json
Request body for transaction search with flexible filters
Response
200 - application/json
List of matching transactions
The response payload for transaction search endpoint
Copy
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
]
}'
Copy
{
"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
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.