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.

Request parameters

  • recipientRef

Response parameters

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