Sign in
Spendbacks

View recipient balance

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 endpoint.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.<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>
get/payout/v3/recipientBalance

Query parameters

recipientRefstring required
Example:[your_recipient_id]

Payer's unique reference value for the recipient.

Response

OK

recipientRefRecipientRef — unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.