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.

Notes

For example, to return (filter) only the spendback with the specified spendbackRef parameter, the request would look like this:
/payout/v3/spendback?spendbackRef=43b57dce-4dca-474a-84f4-4684f3a8aa52

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:
/payout/v3/spendback?currency=EUR&spendbackStatus=90

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

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.id
  • 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
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!