notifyTokenPurchase

An event notification to signal that a successful token purchase was performed. This operation is for informational purposes only. Implementations that do not need to subscribe to this event may simply return an HTTP status code 501.

SecurityhttpBasic or oauth2
Request
query Parameters
purchaseId
required
string

The id of the original purchase request.

Request Body schema: application/json

A token purchase response

Array of objects (TransactionLabel)

A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.

object (LedgerAmount)

An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT

object (LedgerAmount)

An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT

object (Amounts)

Amounts which make up the transaction. Absent amounts have zero value.

required
object (Meter)

Data associated with a prepaid utility meter

required
object (Customer)

A customer who ultimately requests a transaction be performed.

required
object (Utility)

Represents a utility with whom a meter is registered.

utilityType
string

Type of utility purchase being requested (e.g. electricity, water, gas).

Array of objects (Token)

List of tokens issued for the purchase.

Array of objects (DebtRecoveryCharge)

List of charges that have been levied in order to reclaim outstanding debts associated with the meter.

Array of objects (ServiceCharge)

List of service charges levied against this meter.

vatInvoiceNumber
string

The VAT invoice number corresponding to this specific transaction.

id
required
string

The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122

time
required
string <date-time>

The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision

required
object (Originator)

The Originator object encapsulates data relating to the originator of the transaction

required
object (Institution)

Originating, acquiring, processing, or receiving institution details

object (Institution)

Originating, acquiring, processing, or receiving institution details

object (Institution)

Originating, acquiring, processing, or receiving institution details

required
Array of objects (ThirdPartyIdentifier)

An array of identifiers which each identify the transaction within each entity's system.

object (SlipData)

Data that may be printed on the customer slip for information purposes

basketRef
string

Used to group multiple transactions which would otherwise be considered independent.

tranType
string

Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).

Enum: "GOODS_AND_SERVICES" "CASH_WITHDRAWAL" "DEBIT_ADJUSTMENT" "GOODS_AND_SERVICES_WITH_CASH_BACK" "NON_CASH" "RETURNS" "DEPOSIT" "CREDIT_ADJUSTMENT" "GENERAL_CREDIT" "AVAILABLE_FUNDS_INQUIRY" "BALANCE_INQUIRY" "GENERAL_INQUIRY" "CARD_VERIFICATION_INQUIRY" "CARDHOLDER_ACCOUNTS_TRANSFER" "GENERAL_TRANSFER" "PAYMENT_FROM_ACCOUNT" "GENERAL_PAYMENT" "PAYMENT_TO_ACCOUNT" "PAYMENT_FROM_ACCOUNT_TO_ACCOUNT" "PLACE_HOLD_ON_CARD" "GENERAL_ADMIN" "CHANGE_PIN" "CARD_HOLDER_INQUIRY" "POINTS_INQUIRY"
srcAccType
string

This specifies the type of source account being used in the transaction (i.e. cheque, savings).

Enum: "DEFAULT" "SAVINGS" "CHEQUE" "CREDIT" "UNIVERSAL" "ELECTRONIC_PURSE" "GIFT_CARD" "STORED_VALUE"
destAccType
string

This specifies the type of destination account being used in the transaction (i.e. cheque, savings).

Enum: "DEFAULT" "SAVINGS" "CHEQUE" "CREDIT" "UNIVERSAL" "ELECTRONIC_PURSE" "GIFT_CARD" "STORED_VALUE"
stan
string

The System Trace Audit Number can be used to locate transactions across different systems.

rrn
string

This is a reference set by the original source of the transaction.

Responses
202

Accepted

400

Bad request

404

Not found

500

Internal server error

501

Not implemented

503

Service unavailable

504

Gateway timeout

post/events/tokenPurchases
Request samples
application/json
{
  • "transactionLabels": [
    ],
  • "purchaseTotal": {
    },
  • "taxTotal": {
    },
  • "amounts": {
    },
  • "meter": {
    },
  • "customer": {
    },
  • "utility": {
    },
  • "utilityType": "string",
  • "tokens": [
    ],
  • "debtRecoveryCharges": [
    ],
  • "serviceCharges": [
    ],
  • "vatInvoiceNumber": "string",
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "originator": {
    },
  • "client": {
    },
  • "settlementEntity": {
    },
  • "receiver": {
    },
  • "thirdPartyIdentifiers": [
    ],
  • "slipData": {
    },
  • "basketRef": "string",
  • "tranType": "GOODS_AND_SERVICES",
  • "srcAccType": "DEFAULT",
  • "destAccType": "DEFAULT",
  • "stan": "string",
  • "rrn": "string"
}
Response samples
application/json
{
  • "errorType": "DUPLICATE_RECORD",
  • "errorMessage": "string",
  • "requestType": "METER_LOOKUP_REQUEST",
  • "id": "string",
  • "originalId": "string",
  • "detailMessage": { }
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2022. All right reserved.