Skip to main content

PurchaseResponse

referencestring

The Plustive transaction reference. Store this.

Example: PLS-9KQ2M7P3XR
statusstring

Processing settles asynchronously — poll Get a transaction or wait for a webhook.

Possible values: [Success, Failed, Processing]

providerReferencestringnullable

Upstream provider reference, when available.

priceChargedint64

Amount debited from your wallet, in kobo.

Example: 27000
balanceint64

Your wallet balance after this purchase, in kobo.

Example: 4973000
tokenstringnullable

Provider-delivered token/PIN for services that vend one (electricity prepaid token, education PIN). Null for data, airtime and cable TV.

idempotentReplayboolean

true when this purchase reused a clientReference that already had a transaction: the original transaction is returned unchanged — no new vend and no extra charge. A replay also carries the Idempotent-Replay: true response header. false (or absent) for a fresh purchase.

Default value: false
PurchaseResponse
{
"reference": "PLS-9KQ2M7P3XR",
"status": "Success",
"providerReference": "string",
"priceCharged": 27000,
"balance": 4973000,
"token": "string",
"idempotentReplay": false
}