API Reference

View recipient balance

get https://api.nexiopaysandbox.com/payout/v3/recipientBalance

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.

⚠️

Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.

Include the recipientRef parameter in the request.

Request parameters

  • recipientRef

Response parameters

  • recipientRef
  • recipientBalances
  • recipientBalances.recipientId
  • recipientBalances.amount
  • recipientBalances.currency
  • recipientBalances.providerId
  • recipientBalances.providerType
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!