Authorise voucher (POS)

Create a voucher on-the-fly via POS integration in AUTHORISED status. Partner callers infer the selling partner from their authenticated context and cannot act across partner boundaries. MVNO callers may select a seller directly or through an externalStoreId/storeId mapping.

Access: Auth methods: JWT bearer or API key. Requires permissions: voucher:create.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

POS request UUID

string
required

Product UUID

string

Electrum-facing six-digit product ID captured for reporting

string

Selling partner UUID. Partner callers may omit it because Nova infers their authenticated partner. MVNO callers may omit it only when externalStoreId/storeId resolves the seller.

string

External store identifier from the POS integrator, resolved against partner.externalId

string

Alias for externalStoreId for integrations that submit the field as storeId

string

Third-party/reseller partner UUID for commercial attribution. MVNO callers only; direct partner callers cannot override reseller attribution.

string
enum
Defaults to API

Voucher creation source/integration

Allowed:
string
enum
Defaults to PRODUCT

Whether redemption provisions the linked product or loads airtime value

Allowed:
number
required

Voucher amount in ZAR

number

Voucher data quantity (e.g., MB for data vouchers)

string

Merchant ID

string

Terminal ID

string

Operator ID

string

Originator ID

string

Receiver ID

string

Receiver name

string

Settlement entity ID

string

Retrieval Reference Number

string

System Trace Audit Number

string

Originator reference

string

Settlement entity reference

string

Service reference

string

Tender type

string

POS state

string

Tender card number (masked)

Headers
string
required

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

Responses

400

Invalid request data

403

Partner scope violation

404

Product or partner not found

409

Voucher with request ID already exists

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json