Requesting additional response parameters

When searching for report data or payouts data, you may request additional parameters to be returned, beyond what the system returns by default.

📘

Note

You can also filter the response to only include records that match a specific value for one or more parameters. For more information, see Filtering using query parameters.

The response for the reporting APIs (for transactions and chargebacks) and payouts APIs (for view recipients and view payouts) returns a default set of parameters. For example, transactionDate and cardType in the reporting API or recipientIdNumbers in the payouts API. For a full list of parameters, see the specific endpoint in the Reporting API Reference or Payouts API Reference.

You can also specify in the request that the system return one or more additional parameters in the response. To do this, you only need to include, in the GET request, the name of the query parameter followed by a dot. When you use a parameter from one of these as a filter, the entire object automatically gets included in the response. Return multiple additional parameters by including an ampersand (&) between each one.

You may request additional parameters or filter the results for any of the following API endpoints:

For example, the following Reporting request returns only the default parameters for up to 20 transactions:

Transaction List with Filter for 20 Results
curl -X GET https://api.nexiopaysandbox.com/transaction/v3?limit=20 \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'

To request an additional parameter, include an empty query parameter in your GET request followed by a dot.

For example, the following returns a standard list of up to 20 transactions along with the customer object for each one:

Transaction List with Filter and Customer Object
curl -X GET https://api.nexiopaysandbox.com/transaction/v3?limit=20&customer. \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'

Now, the same request for the same 20 transactions with the default parameters, but also requesting that the response include additional information about Kount, payment plugins, the customer, processor, and gateway:

Transaction List with Filter and Multiple Additional Parameters
curl -X GET https://api.nexiopaysandbox.com/transaction/v3?limit=20&kount.&plugin.&customer.&processor.&gateway. \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'

For the list of additional parameters, see the Transactions filtering and additional parameters and Payouts filtering and additional parameters tables.


Did this page help you?