Last updated 13 minutes ago

Using Arguments

Arguments may optionally be included with the request to export data. These can filter out data, search the data, and sort the data.

"arguments": {
    "filter": "string",
    "sort": "string",
    "q": "string"
}

Using Filter

The filter argument is the most simple to use. We would recommend using that, as it handles most cases quite elegantly.

Filter for approved

"arguments": {
    "filter": "result:approved"
}

Filter for voids and refunds

Here, you'll notice you can filter by multiple values when you separate them by commas:

"arguments": {
    "filter": "type:void,refund"
}

Filter for approved voids and refunds

Here, you'll notice you can filter by multiple fields when they are separated by semi-colons:

"arguments": {
    "filter": "result:approved;type:void,refund"
}