Skip to main content
Stored value lookups support a few common scenarios. Below are some examples:
  • Scenario: Confirm a stored value instrument’s balance before redeeming it.
  • Use Case: A customer presents a stored value instrument, such as a voucher, and the Merchant wants to show its available balance, or verify it is valid, before starting a redemption.
  • Behaviour:
    • Choose the stored value type and provide the source credentials it requires. List the supported types with GET /collect/redemptions/types.
    • Call POST /stored_value/lookup to fetch the balance, currency, and provider metadata.
    • If the balance is sufficient, create a redemption for the desired amount.
  • Example: Showing a voucher balance in a wallet top-up flow before the customer commits.