Skip to main content
POST

Authorizations

ā€‹
Authorization
string
header
required

Authentication using Bearer tokens. Include your API key in the Authorization header.

Key Types:

  • Test Keys: sk_test_* for development and testing
  • Live Keys: sk_* for production environments
  • Public Keys: pk_test_* or pk_* for client-side operations

šŸ“© Need access? Contact Support to request your API keys.

Usage:

Headers

ā€‹
Moment-Business-Unit
string

Identifies the business unit the request applies to.

Required when the API key is linked to more than one business unit. When the key is linked to exactly one business unit the header may be omitted and that business unit is used.

Errors:

  • 400 business_unit_missing when the header is absent and the key is linked to multiple business units
  • 400 business_unit_invalid when the value is not a valid business unit identifier
  • 403 business_unit_access_denied when the value is well formed but the key is not linked to that business unit
Pattern: ^bu_[A-Za-z0-9_-]{21}$

Body

application/json

Request body for a stateless stored value lookup.

ā€‹
type
enum<string>
required

Namespaced redemption type in category.type form. The category selects the value class and the suffix selects the specific provider that will fulfil the redemption.

Only the vouchers category is available today. Loyalty point categories (for example loyalty_points.skywards, loyalty_points.ebucks) are planned.

Available options:
vouchers.one_voucher,
vouchers.ott,
vouchers.blu
ā€‹
source
OTT Ā· object
required

Provider specific source credential object for a stored value lookup. The shape is owned by the adapter and selected by the parent type field.

1Voucher does not expose a stored value lookup and is not represented here. A lookup request for 1Voucher is still validated but returns HTTP 422.

Response

Lookup result.

Generic envelope returned by a successful stored value lookup.

ā€‹
type
enum<string>
required

Namespaced redemption type in category.type form. The category selects the value class and the suffix selects the specific provider that will fulfil the redemption.

Only the vouchers category is available today. Loyalty point categories (for example loyalty_points.skywards, loyalty_points.ebucks) are planned.

Available options:
vouchers.one_voucher,
vouchers.ott,
vouchers.blu
ā€‹
balance
integer

Stored value balance in minor units (cents).

ā€‹
currency
string
Required string length: 3
ā€‹
source
OTT Ā· object

Echo of the provider specific source the lookup was performed against.

ā€‹
provider_metadata
OTT Ā· object

Provider specific result fields returned by a stored value lookup. The shape is selected by the parent provider field. Only keys returned by the upstream provider are present.

ā€‹
error
object

Provider mapped error attached to a failed operation or to a failed redemption aggregate.