Redeem a voucher into an MVNO product

post

https://megsapp-nova-stg.85.group/api/v1/purchases/voucher-redemptions

Purchase-flow voucher redemption. APP_USER callers may send their own appUserUuid and a selected totogiAccountId; Nova verifies both against the authenticated user and their live verified account links. API-key callers require purchase:admin and may omit appUserUuid when redeeming to an explicit active totogiAccountId in the current tenant. When supplied by an admin or API-key caller, appUserUuid is retained as the attributed customer identity. Internal MVNO vouchers are redeemed from Nova inventory; external voucher types use their provider redemption flows.

Access: Auth methods: JWT bearer or API key. Requires any permission: purchase:write, purchase:admin.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

productUuid

string

Deprecated and ignored. External vouchers always redeem as MVNO airtime; Nova-owned vouchers use the product assigned to the voucher.

amount

number

Override amount for flexible-price products. Voucher redemption stores 0 until the provider resolves the voucher value.

voucherType

string

enum

required

Voucher provider. Use GENERIC_VOUCHER to check Nova-owned MVNO vouchers before supported external provider redeem endpoints.

Allowed:

voucherCode

string

required

Voucher PIN / token to redeem.

totogiAccountId

string

Selected Totogi account id. APP_USER callers may supply an account that is verified and linked to their authenticated profile. API-key callers without appUserUuid must supply an active account from the current tenant and require purchase:admin. Admin and API-key callers with appUserUuid use this as an explicit account override requiring purchase:admin. When omitted for a JWT caller, Nova falls back to the app user primary account.

appUserUuid

string

Optional customer app_user UUID for attribution. For APP_USER callers, when supplied it must match the authenticated user. For admin and API-key callers it is an act-as identity requiring purchase:admin. API-key callers may omit it only when they supply totogiAccountId.

Headers

Idempotency-Key

string

required

Client-generated UUID v4. Reuse the same key only when retrying the exact same request.

Responses

201

Voucher redemption initiated

400

Invalid input

503

Voucher target account or monetary balance is not ready

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200