---
title: "View spendbacks"
method: GET
path: "/payout/v3/spendback"
tags: ["Spendbacks"]
---

# View spendbacks

`GET /payout/v3/spendback`

Returns all spendbacks that meet the specified parameters (if any) and that are associated with the Nexio account used to [authenticate](https://docs.nexiopay.com/docs/authentication).

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](https://docs.nexiopay.com/docs/filtering-using-query-parameters).

<!-- theme: info -->
> 📘 Notes
> 
> For example, to return (filter) only the spendback with the specified `spendbackRef` parameter, the request would look like this:
> <code>/payout/v3/spendback?spendbackRef=43b57dce-4dca-474a-84f4-4684f3a8aa52</code><br/><br/>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:
> <code>/payout/v3/spendback?currency=EUR&spendbackStatus=90</code><br/><br/>For a more detailed tutorial, see the [query parameters](https://docs.nexiopay.com/docs/filtering-using-query-parameters) section of Guides.

<!-- theme: warning -->
> ⚠️ Try It
> 
> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).


<div style="display:none;">

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

</div>

## Query parameters

- `limit` integer
- `offset` integer
- `startDate` string
- `endDate` string
- `id` integer
- `spendbackRef` string
- `recipientId` integer
- `recipientRef` string
- `payoutAccountId` integer
- `providerId` integer
- `providerType` 10 | 20 | 30 | 40
- `providerSpendbackRef` string
- `amount` number
- `currency` string
- `description` string
- `spendbackDate` string
- `spendbackStatus` '10' | '20' | '90'
- `providerResponse` string
- `createdAt` string
- `updatedAt` string

## Response `200`

OK

- object
  - `offset` integer — The offset indicates how many spendback records were skipped before beginning to return spendbacks in a response. If both `offset` and `limit` were used together, the offset spendbacks were skipped before starting to count the spendbacks to limit.
  - `limit` integer — The maximum number of spendback records returned in a response (starting from the default or specified `offset` query parameter).
  - `rows` Schema[] — The `rows` array contains one or more sets of spendback parameters. — unresolved $ref
  - `hasMore` boolean — Will be `true` if there are more records not included in the current paged response

## Other responses

- `401` — Unauthorized. For help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payments-api-reference.md) · [All operations](https://skmtc.dev/nexiopay/apis/payments-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nexiopay/payments-api-reference/revisions/b414b73979e5/schema)