View spendbacks

Returns all spendbacks that meet the specified parameters (if any) and that are associated with the Nexio account used to authenticate.

This is the only endpoint where you can use spendbackRef in the request to view a specific spendback based on that value.

You may also request to filter results using one or more query parameters.



For example, to return (filter) only the spendback with the specified spendbackRef parameter, the request would look like this:

To return (filter) all spendbacks where the currency is EUR and there was an error response from the provider, the request would look like this:

For a more detailed tutorial, see the query parameters section of Guides.


Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.

Request parameters

  • amount
  • currency
  • description
  • endDate
  • id
  • limit
  • offset
  • payoutAccountId
  • providerId
  • providerResponse
  • providerSpendbackRef
  • providerType
  • recipientId
  • recipientRef
  • spendbackRef
  • spendbackStatus
  • startDate
  • updatedAt
  • createdAt
  • spendbackDate

Response parameters

  • offset
  • limit
  • rows
  • rows.spendbackRef
  • rows.recipientId
  • rows.recipientRef
  • rows.payoutAccountId
  • rows.providerId
  • rows.providerType
  • rows.providerSpendbackRef
  • rows.amount
  • rows.currency
  • rows.description
  • rows.spendbackDate
  • rows.spendbackStatus
  • rows.providerResponse
  • rows.createdAt
  • rows.updatedAt
  • hasMore
Click Try It! to start a request and see the response here!