For the complete documentation index, see llms.txt. This page is also available as Markdown.

Stored Value Cards

Stored value card operations cover the management of gift cards and prepaid cards — checking their balance, loading funds, and activating new cards.

Balance Enquiry

Retrieves the current balance on a gift or prepaid card. Accepts either an encrypted card or a reuse token.

Query the balance on a card

post
/api/v2/transactions/balance

This retrieves the current balance on a gift/prepaid card.

Authorizations
AuthorizationstringRequired
Header parameters
x-vfi-api-idempotencykeystringOptional

Example: 63bbc548-d2de-4546-b106-880a5018461c

A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.

Body
or
Responses
post
/api/v2/transactions/balance

Load Card (Add Funds)

Adds funds to an existing card. Use this for load, reload, top-up, and deposit operations.

Add funds to a card

post
/api/v2/transactions/stored-value-card/load

Load a card with given value. This is to be used for load, reload, top-up, deposit operations.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
x-vfi-api-idempotencykeystringOptional

Example: 63bbc548-d2de-4546-b106-880a5018461c

A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.

Body
or
Responses
post
/api/v2/transactions/stored-value-card/load

Activate Card

Activates a new gift card, enabling the cardholder to access the stored funds. Setting activate_now: false checks activation eligibility without changing the card status.

activate_now: false is only supported for SVS gift cards in the US region.

Activate a gift card

post
/api/v2/transactions/stored-value-card/activate

Activating the card allows the cardholder to access the funds stored on the card.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
x-vfi-api-idempotencykeystringOptional

Example: 63bbc548-d2de-4546-b106-880a5018461c

A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.

Body
or
Responses
post
/api/v2/transactions/stored-value-card/activate

Key Response Fields

balance_amount follows ISO 4217 decimal conventions (e.g. USD uses 2 decimal places, so 150 = $1.50). Iceland Krona (ISK) uses 2 decimal places with fixed minor units of 00.

Was this helpful?