Some Nexio API endpoints allow the use of query parameters as a way to filter (or limit) the results returned from the request. You can also use query parameters to request that those specific parameters be included in the response.

Path parameters that you include in a regular endpoint request already act like a filter for the response. But, for the Payments endpoint of View card tokens, the Reporting endpoints of Transactions and Chargebacks and the Payouts endpoint of View recipients, there is an additional method for creating a filter: Using query parameters.

For these endpoints in the Payments, Reporting, or Payouts API, you can also filter query parameters by specifying the desired parameter to filter on, an equals ( = ) sign, and the value to use for the filter. For parameters in an object, use the object name, a dot, and the parameter name before the equals. You can combine multiple filters by including an ampersand (&) between each one.

Use this feature, along with requesting additional response parameters, to limit the scope of the response and to get back the specific parameters that you want.

For example, the following request returns all transactions (made in the Nexio Payment API) for the specified zip code where the gateway status is 'Approved' and where the response includes all the default parameters plus the content for the customer and gateway objects.

curl -X GET https://api.nexiopaysandbox.com/transaction/v3?customer.postalCode=12345&gateway.message=Approved \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'

As another example, the following searches for a transaction made in the Nexio Payment API with the to-be-specified payment ID, and also includes its Kount information in the results.

curl -X GET https://api.nexiopaysandbox.com/transaction/v3?kount.&plugin.originalId={payment_ID} \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'

Reference tables

The following tables show all the fields that you can use for filtering with the additional query parameters. (The default fields can also be used for filtering. See the API reference documentation for each endpoint for details).

• Payments
• Payouts
• Transactions

Payments filtering parameters

For information about each field, see the specific endpoint in the Payments API Reference .

Payouts filtering and additional parameters

For information about each field, see the specific endpoint in the Payouts API Reference.

Transactions filtering and additional parameters

For information about each field, see the specific endpoint in the Reporting API Reference .