---
title: "Spendback refund"
method: POST
path: "/payout/v3/spendbackRefund"
tags: ["Spendbacks"]
---

# Spendback refund

`POST /payout/v3/spendbackRefund`

## Request

- Base URL: `https://api.nexiopaysandbox.com`
- URL: `https://api.nexiopaysandbox.com/payout/v3/spendbackRefund`
- Auth: HTTP basic

Allows the merchant to refund recipients who have previously made a spendback transaction.

<!-- theme: warning -->
> ⚠️ Try It
> 
> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).<br/><br/>Include at least the spendback ID and amount to refund in the request.

<div style="display:none;">

## Request parameters
- spendbackId
- amount
- payoutAccountId
- recipientId
- providerId
- spendbackRef
- recipientRef
- providerSpendbackRef
- currency
- providerType
- spendbackType
- spendbackStatus
- spendbackDate
- createdAt
- updatedAt

## Response parameters
- spendbackId
- payoutAccountId
- recipientId
- providerId
- spendbackRef
- recipientRef
- providerSpendbackRef
- amount
- currency
- providerType
- spendbackType
- spendbackStatus
- spendbackDate
- createdAt
- updatedAt

</div>

## Request body

- object
  - `spendbackId` integer, required: The ID value auto-generated by Nexio when the spendback request was submitted (see the [Submit spendback](ref:SubmitSpendback) endpoint).
  - `amount` number, required: The payout amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point.
  - `payoutAccountId` integer: The Nexio ID for the payout account. Useful for identifying the business or business segment associated with the recipient.
  - `recipientId` integer: The Nexio-generated ID for a recipient. This is the payer account used for the spendback refund.
  - `providerId` ProviderId (unresolved $ref)
  - `spendbackRef` string: Reference value for the spendback request. This allows for easier synchronization and searching across different systems.
  - `recipientRef` string: Payer's unique reference value for the recipient. This allows for easier synchronization and searching across different systems. This is the same `recipientRef` that is used in the [Submit spendback](ref:submitspendback) endpoint and is a unique value used for spendbacks.
  - `providerSpendbackRef` string: Reference value for the spendback from the payout provider. This allows for easier synchronization and searching across different systems.
  - `currency` Currency (unresolved $ref)
  - `providerType` 10 | 20 | 30 | 40 | 50 | 60: The Nexio ID for the payout provider used to process the spendback request. Possible values include the following: - 10 - Interchecks - 20 - Hyperwallet - 30 - Payquicker - 40 - Nexio's mock payout provider for quicker sandbox integration - 50 - MassPay - 60 - Nomad
  - `spendbackType` 10 | 20: The type of spendback used. `10` is `spendback` and `20` is `refund`.
  - `spendbackStatus` 10 | 20 | 30 | 40 | 50 | 90: The status of the spendback, returned as an integer. For more information about possible values, see the [spendbackStatus](doc:constant-payouts-values#spendback-status-spendbackstatus) table.
  - `spendbackDate` string, date: The date the spendback request was sent to the provider, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.
  - `updatedAt` string: The date and time the spendback record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.
  - `createdAt` string: The date and time the spendback request was sent to the provider, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.

## Response `200`

OK

- object
  - `spendbackId` SpendbackId (unresolved $ref)
  - `payoutAccountId` PayoutAccountId (unresolved $ref)
  - `recipientId` RecipientId (unresolved $ref)
  - `providerId` ProviderId (unresolved $ref)
  - `spendbackRef` SpendbackRef (unresolved $ref)
  - `recipientRef` string: Your unique identifier for a recipient. This is the payer account used for the spendback.
  - `providerSpendbackRef` ProviderSpendbackRef (unresolved $ref)
  - `amount` Amount (unresolved $ref)
  - `currency` string: The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for the spendback by the specified payer.
  - `providerType` ProviderType (unresolved $ref)
  - `spendbackType` SpendbackType (unresolved $ref)
  - `spendbackStatus` SpendbackStatus (unresolved $ref)
  - `spendbackDate` SpendbackDate (unresolved $ref)
  - `updatedAt` UpdatedAt (unresolved $ref)
  - `createdAt` CreatedAt (unresolved $ref)

## Other responses

- `401`: Unauthorized. For help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.
- `433`: Spendback to refund not found

---

[API](https://skmtc.dev/nexiopay/apis/payouts-api-reference.md) - [All operations](https://skmtc.dev/nexiopay/apis/payouts-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/nexiopay/apis/payouts-api-reference/revisions/36c088967d63?raw)