---
title: "View recipient balance"
method: GET
path: "/payout/v3/recipientBalance"
tags: ["Spendbacks"]
---

# View recipient balance

`GET /payout/v3/recipientBalance`

## Request

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

Allows merchants to view a recipient's spendback balance to ensure sufficient funds are available for spendbacks. Shows the balance for each spendback provider account associated with the `recipientRef` parameter. 

Requires `recipientRef` query parameter to access recipient balance information. This is the same `recipientRef` that is used in the [Submit spendback](ref:submitspendback) endpoint.

<!-- 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 the `recipientRef` parameter in the request.

<div style="display:none;">

## Request parameters
- recipientRef

## Response parameters
- recipientRef
- recipientBalances
- recipientBalances.recipientId
- recipientBalances.amount
- recipientBalances.currency
- recipientBalances.providerId
- recipientBalances.providerType

</div>

## Query parameters

- `recipientRef` string, required

## Response `200`

OK

- object
  - `recipientRef` RecipientRef (unresolved $ref)
  - `recipientBalances` object
    - `recipientId` RecipientId (unresolved $ref)
    - `amount` number: The amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point.
    - `currency` string: The [three-digit ISO numeric currency code](https://en.wikipedia.org/wiki/ISO_4217). For information about valid values, see the [currency table](doc:constant-transaction-values#currency-id-currencyid) in Guides.
    - `providerId` ProviderId (unresolved $ref)
    - `providerType` ProviderType (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.

---

[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)