Search transactions for a merchant with filtering and sorting
Search transactions for a merchant with filtering and sorting
Path parameters
The unique identifier of the merchant
The unique identifier of the merchant
Request body
Example request
{
"search": {
"amount": {
"gte": 1000,
"lte": 5000
},
"status": {
"eq": "completed"
},
"customer_email": {
"contains": "gmail"
}
},
"pagination": {
"page": 1,
"limit": 25
},
"sort": [
{
"field": "created_at",
"direction": "desc"
}
]
}Response
Success
Example response
{
"data": [
{
"currency": {
"code": "GBP",
"symbol": "€",
"name": "Euro",
"minor_unit": 2
},
"payout_currency": {
"code": "GBP",
"symbol": "€",
"name": "Euro",
"minor_unit": 2
},
"payment_request": {
"order_id": "ORD-2025-00123",
"payment_token": "tok_abc123def456"
},
"fees": {
"currency": {
"code": "GBP",
"symbol": "€",
"name": "Euro",
"minor_unit": 2
},
"items": [
{
"currency": {
"code": "GBP",
"symbol": "€",
"name": "Euro",
"minor_unit": 2
}
}
]
},
"refunds": [
{
"currency": {
"code": "GBP",
"symbol": "€",
"name": "Euro",
"minor_unit": 2
},
"payout_currency": {
"code": "GBP",
"symbol": "€",
"name": "Euro",
"minor_unit": 2
},
"payment_request": {
"order_id": "ORD-2025-00123",
"payment_token": "tok_abc123def456"
},
"fees": {
"currency": {
"code": "GBP",
"symbol": "€",
"name": "Euro",
"minor_unit": 2
},
"items": [
{
"currency": {
"code": "GBP",
"symbol": "€",
"name": "Euro",
"minor_unit": 2
}
}
]
}
}
],
"reversals": [
{
"currency": {
"code": "GBP",
"symbol": "€",
"name": "Euro",
"minor_unit": 2
},
"payout_currency": {
"code": "GBP",
"symbol": "€",
"name": "Euro",
"minor_unit": 2
},
"payment_request": {
"order_id": "ORD-2025-00123",
"payment_token": "tok_abc123def456"
},
"fees": {
"currency": {
"code": "GBP",
"symbol": "€",
"name": "Euro",
"minor_unit": 2
},
"items": [
{
"currency": {
"code": "GBP",
"symbol": "€",
"name": "Euro",
"minor_unit": 2
}
}
]
}
}
]
}
],
"search_metadata": {
"sort_applied": [
{
"field": "created_at",
"direction": "desc"
}
]
},
"totals": [
{
"currency": "EUR",
"total_amount": 3034
},
{
"currency": "GBP",
"total_amount": 534
},
{
"currency": "DKK",
"total_amount": 2034
}
]
}Changes
Changed in 3 of the 8 revisions of this API.4932
- ▲
the
//request property's minLength was increased from0to3request-property-min-length-increased
- ▲
the
/response's property type changed fromstringto no type for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromstringtonumberfor statusresponse-property-type-changed
- ●
the
//request property's maxLength was set to3request-property-max-length-set
- ●
changed the pattern of the request property
//from^[A-Z]{3}$to^[A-Za-z]{3}$request-property-pattern-changed
- ●
removed the optional property
/from the response with the statusresponse-optional-property-removed
- ●
added the new
convertedenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
converted_amountenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
fee_paidenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
receivedenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
reversalenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
unknownenum value to the//response property for the response statusresponse-property-enum-value-added
- ○
added the new optional request property
new-optional-request-property
- ○
added the new optional request property
/new-optional-request-property
- ○
added the new optional request property
/new-optional-request-property
- ○
added the new optional request property
//new-optional-request-property
- ○
added the new optional request property
//new-optional-request-property
- ○
the request property
//became optionalrequest-property-became-optional
- ○
the request property
//became optionalrequest-property-became-optional
- ○
added the new
converted_amountenum value to the request property//request-property-enum-value-added
- ○
added the new
fully_refundedenum value to the request property//request-property-enum-value-added
- ○
added the new
partially_refundedenum value to the request property//request-property-enum-value-added
- ○
added the new
refundingenum value to the request property//request-property-enum-value-added
- ○
added the new
refunding_failedenum value to the request property//request-property-enum-value-added
- ○
added the new
refunding_stuckenum value to the request property//request-property-enum-value-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○
added
subschema #1subschema #2to the/response propertyallOflist for the response statusresponse-property-all-of-added
- ○
removed the
processingenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
the
///response's property pattern^[A-Za-z]{3}$was added for the statusresponse-property-pattern-added
- ○
the
//response's property pattern was changed from^[A-Z]{3}$to^[A-Za-z]{3}$for the statusresponse-property-pattern-changed
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ○
endpoint added
endpoint-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ▲
api path removed without deprecation
api-path-removed-without-deprecation
This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲