Filtering using query parameters

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 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 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.

Transaction List with Additional Filters
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.

Transaction List with Additional Filters
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).

Payouts filtering and additional parameters

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

NameQuery ParameterFiltering Field
Recipient ID NumbersrecipientIdNumbers.governmentId
passportId
driversLicenseId
employerIId

Transactions filtering and additional parameters

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

NameAdditional ParameterFiltering Field
Customercustomer.id
firstName
lastName
postalCode
phone
email
company
customerRef
transactionId
Kountkount.id
status
rules
refNumber
merc
score
ruleCount
warningCount
counterCount
wasDeviceFingerprinted
mode
velo
vmax
transactionId
Bank TransferbankTransfer.id
account
routing
checkNumber
transactionId
Pluginplugin.id
originalId
invoice
orderNumber
description
userId
pluginType
paymentOptionTag
transactionId
Foreign Processing CurrencyforeignProcessingCurrency.id
amount
currencyId
transactionId
Gatewaygateway.id
merchantId
batchRef
refNumber
additionalRefNumber
trackingCode
gatewayType
message
transactionId
Processorprocessor.id
transactionRef
batchRef
originalId
processorType
transactionId
Customer AddressescustomerAddresses.id
billingAddressOne
billingAddressTwo
billingCity
billingState
billingPostalCode
billingCountry
billingPhone
shippingAddressOne
shippingAddressTwo
shippingCity
shippingState
shippingPostalCode
shippingCountry
shippingPhone
transactionId
Transaction DetailstransactionDetails.id
description
clientIp
userName
shoppingCart
customFields
retryCount
paymentType
paymentToken
transactionId
Subscriptionsubscription.id
remainingBalance
initialBalance
interval
intervalCount
subscriptionRef
accountId
scheduleType
transactionId

Did this page help you?