The Electrum Prepaid Utility Service describes an interface for facilitating the purchase of prepaid tokens for utilities such as electricity and water. One or more tokens for a requested value are issued by an upstream provider (typically a payments aggregator) against a specified meter number. The tokens (each being a sequence of usually 20 digits) are printed on the customer receipt and are input manually on the meter's keypad for the value to be redeemed.
https://[placeholder].dev/prepaidutility/v3/
Amounts which make up the transaction. Absent amounts have zero value.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
{ "requestAmount": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "approvedAmount": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "feeAmount": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "balanceAmount": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "additionalAmounts": { "property1": { … }, "property2": { … } } }
Base model for all payment types
The general method of payment used
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An alternative identifier for the customer's source of funds. Acts as a stand in for the customer identifier. E.g. a customer's MSISDN or email address.
An enumerated value describing the type of value used as the proxy.
{ "type": "AccountPayment", "name": "string", "amount": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "issuer": { "id": "string", "name": "string" }, "pin": { "type": "CLEAR_PIN" }, "proxy": "string", "proxyType": "MSISDN", "srcAccountId": "string", "srcCustomerId": "string", "destAccountId": "string", "destCustomerId": "string" }
A token purchase response
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.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
A customer who ultimately requests a transaction be performed.
The status of this customer on the Giftcard system. For example: active, inactive
This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en) e.g. 27821234567 for a South African number.
The customer's email address. This address must conform to RFC 5322 3.4.1 addr-spec (https://tools.ietf.org/html/rfc5322#section-3.4.1).
Represents a utility with whom a meter is registered.
Identifier assigned by the utility to the client connecting to the utility's token issuing service.
List of charges that have been levied in order to reclaim outstanding debts associated with the meter.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/prepaidutility/v3/events/tokenPurchases
Failed to generate code sample.A fault report
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.
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
Type of fault that is being reported.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/prepaidutility/v3/faultReports/{requestId}
Failed to generate code sample.Created
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.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
{ "transactionLabels": [ { … } ], "reference": "string", "description": "string", "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "string", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string" }
Requests a key change token for a specified meter. This resource is used when the utility has updated a meter's encryption key and the customer required a token to input the new key to the meter. Key change tokens are typically supplied as part of a normal purchase, so this operation is rarely used.
A key change token request
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.
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/prepaidutility/v3/keyChangeTokenRequests/{requestId}
Failed to generate code sample.Created
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.
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
{ "transactionLabels": [ { … } ], "meter": { "meterId": "string", "track2Data": "string", "serviceType": "string", "supplyGroupCode": "string", "keyRevisionNum": "string", "tariffIndex": "string", "tokenTechCode": "string", "algorithmCode": "string", "keyChangeData": { … } }, "tokens": [ { … } ], "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "string", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string" }
A key change confirmation
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
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
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/prepaidutility/v3/keyChangeTokenRequests/{requestId}/confirmations/{confirmationId}
Failed to generate code sample.Accepted
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
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
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
{ "id": "string", "requestId": "string", "time": "2019-08-24T14:15:22Z", "thirdPartyIdentifiers": [ { … } ], "stan": "string", "rrn": "string", "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … } } }
Request information about a specified meter, including customer and utility details. This resource is used to verify that a meter number is valid and registered with the correct details. It also confirms whether the meter is recognised by a provider and that tokens can be issued against it.
A meter information lookup request.
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.
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/prepaidutility/v3/meterLookups/{lookupId}
Failed to generate code sample.Created
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.
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
A customer who ultimately requests a transaction be performed.
The status of this customer on the Giftcard system. For example: active, inactive
This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en) e.g. 27821234567 for a South African number.
The customer's email address. This address must conform to RFC 5322 3.4.1 addr-spec (https://tools.ietf.org/html/rfc5322#section-3.4.1).
Represents a utility with whom a meter is registered.
Identifier assigned by the utility to the client connecting to the utility's token issuing service.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Boolean flag indicating whether a free basic service support token is owing on this meter. Not all meters support this and typically only one free token is issued per calendar month. If the value of this field is true, then a purchase request with an amount of 0 can be sent and the response will contain the free token.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
{ "transactionLabels": [ { … } ], "meter": { "meterId": "string", "track2Data": "string", "serviceType": "string", "supplyGroupCode": "string", "keyRevisionNum": "string", "tariffIndex": "string", "tokenTechCode": "string", "algorithmCode": "string", "keyChangeData": { … } }, "customer": { "firstName": "string", "lastName": "string", "address": "string", "dateOfBirth": "2019-08-24T14:15:22Z", "status": "string", "msisdn": "string", "emailAddress": "string", "addressDetails": { … }, "profileId": "string" }, "utility": { "name": "string", "address": "string", "vatRegNum": "string", "clientId": "string", "message": "string" }, "minAmount": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "maxAmount": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "arrearsAmount": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "bsstDue": false, "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "string", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string" }
Requests that the provider issue a token against the meter for a given monetary value. In the case that the meter and/or utility supports the issue of free tokens under a basic service support tariff scheme, then any free tokens due will also be returned. If the requested amount is 0 and a free token is due to the meter, then only this free token will be returned. A portion of the request amount may be used by the provider to offset outstanding debt or service charges owed by the customer, in which case the value of the token returned may be less than the request amount (see interface documentation for further details).
A token purchase request.
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.
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Amount in minor denomination, e.g. R799.95 is encoded as 79995
Three digit currency number from ISO 4217, e.g. South African Rand is encoded as 710
Mobile phone number of the customer to which the outcome of a transaction can be communicated. This should conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en), but a 10-digit number beginning with zero is also acceptable.
An array of tenders used to pay for the transaction. This is used if payment is tendered at the point of sale. A Tender differs from a PaymentMethod in that the former represents a payment that has already been collected at the point of sale, whereas the latter represents a payment that still needs to be collected from a third party.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
An array of payment methods to be used as payment for the transaction. This is used if payment is not tendered at the point of sale, but is effected through one or more calls to third party payment providers as part of the request. A PaymentMethod differs from a Tender in that the former represents payment that still needs to be collected from a third party, whereas the latter represents payment that has already been collected at the point of sale.
https://[placeholder].dev/prepaidutility/v3/tokenPurchases/{purchaseId}
Failed to generate code sample.Created
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.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
A customer who ultimately requests a transaction be performed.
The status of this customer on the Giftcard system. For example: active, inactive
This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en) e.g. 27821234567 for a South African number.
The customer's email address. This address must conform to RFC 5322 3.4.1 addr-spec (https://tools.ietf.org/html/rfc5322#section-3.4.1).
Represents a utility with whom a meter is registered.
Identifier assigned by the utility to the client connecting to the utility's token issuing service.
List of charges that have been levied in order to reclaim outstanding debts associated with the meter.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
{ "transactionLabels": [ { … } ], "purchaseTotal": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "taxTotal": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … } }, "meter": { "meterId": "string", "track2Data": "string", "serviceType": "string", "supplyGroupCode": "string", "keyRevisionNum": "string", "tariffIndex": "string", "tokenTechCode": "string", "algorithmCode": "string", "keyChangeData": { … } }, "customer": { "firstName": "string", "lastName": "string", "address": "string", "dateOfBirth": "2019-08-24T14:15:22Z", "status": "string", "msisdn": "string", "emailAddress": "string", "addressDetails": { … }, "profileId": "string" }, "utility": { "name": "string", "address": "string", "vatRegNum": "string", "clientId": "string", "message": "string" }, "utilityType": "string", "tokens": [ { … } ], "debtRecoveryCharges": [ { … } ], "serviceCharges": [ { … } ], "vatInvoiceNumber": "string", "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "string", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string" }
Confirms that a purchase has been completed successfully (i.e. the tokens have been issued to the customer and payment has been received by the merchant). It is typical that token providers do not support confirmations (aka advices), but certain point-of-sale integrations may require support for these. A confirmation request must be sent repeatedly until an HTTP response code indicating a final state has been received (i.e. either 202 or 4xx).
A token purchase confirmation
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
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
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
An array of tenders used to pay for the transaction
The type of account
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Amount in minor denomination, e.g. R799.95 is encoded as 79995
Three digit currency number from ISO 4217, e.g. South African Rand is encoded as 710
A PCI compliant masked card number, with at least the first 6 digits in the clear. Only applicable to card based transactions
https://[placeholder].dev/prepaidutility/v3/tokenPurchases/{purchaseId}/confirmations/{confirmationId}
Failed to generate code sample.Accepted
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
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
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
{ "id": "string", "requestId": "string", "time": "2019-08-24T14:15:22Z", "thirdPartyIdentifiers": [ { … } ], "stan": "string", "rrn": "string", "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … } } }
If no response was received to a purchase request due to a timeout or temporary communications failure, PoS may retry the same purchase request by calling this resource. The original purchase request will be resubmitted to the provider. If the provider had received the original request, it will respond by returning any tokens that were already issued. If not, then either new tokens may be issued as per a normal purchase or the retry will be declined.
The original token purchase request.
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.
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Amount in minor denomination, e.g. R799.95 is encoded as 79995
Three digit currency number from ISO 4217, e.g. South African Rand is encoded as 710
Mobile phone number of the customer to which the outcome of a transaction can be communicated. This should conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en), but a 10-digit number beginning with zero is also acceptable.
An array of tenders used to pay for the transaction. This is used if payment is tendered at the point of sale. A Tender differs from a PaymentMethod in that the former represents a payment that has already been collected at the point of sale, whereas the latter represents a payment that still needs to be collected from a third party.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
An array of payment methods to be used as payment for the transaction. This is used if payment is not tendered at the point of sale, but is effected through one or more calls to third party payment providers as part of the request. A PaymentMethod differs from a Tender in that the former represents payment that still needs to be collected from a third party, whereas the latter represents payment that has already been collected at the point of sale.
https://[placeholder].dev/prepaidutility/v3/tokenPurchases/{purchaseId}/retry
Failed to generate code sample.Accepted
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.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
A customer who ultimately requests a transaction be performed.
The status of this customer on the Giftcard system. For example: active, inactive
This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en) e.g. 27821234567 for a South African number.
The customer's email address. This address must conform to RFC 5322 3.4.1 addr-spec (https://tools.ietf.org/html/rfc5322#section-3.4.1).
Represents a utility with whom a meter is registered.
Identifier assigned by the utility to the client connecting to the utility's token issuing service.
List of charges that have been levied in order to reclaim outstanding debts associated with the meter.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
{ "transactionLabels": [ { … } ], "purchaseTotal": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "taxTotal": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … } }, "meter": { "meterId": "string", "track2Data": "string", "serviceType": "string", "supplyGroupCode": "string", "keyRevisionNum": "string", "tariffIndex": "string", "tokenTechCode": "string", "algorithmCode": "string", "keyChangeData": { … } }, "customer": { "firstName": "string", "lastName": "string", "address": "string", "dateOfBirth": "2019-08-24T14:15:22Z", "status": "string", "msisdn": "string", "emailAddress": "string", "addressDetails": { … }, "profileId": "string" }, "utility": { "name": "string", "address": "string", "vatRegNum": "string", "clientId": "string", "message": "string" }, "utilityType": "string", "tokens": [ { … } ], "debtRecoveryCharges": [ { … } ], "serviceCharges": [ { … } ], "vatInvoiceNumber": "string", "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "string", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string" }
Notifies that a purchase was not completed successfully. This can occur if the original request timed out or if payment was unsuccessful. Many providers, however, do not support reversals and once a token has been issued the merchant becomes liable for the cost irrespective of payment failure or timeout. The token may still be retrieved by a reprint request, which merchants may use to help accommodate this scenario. A reversal request must be sent repeatedly until an HTTP response code indicating a final state has been received (i.e. either 202 or 4xx).
A token purchase reversal.
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
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
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/prepaidutility/v3/tokenPurchases/{purchaseId}/reversals/{reversalId}
Failed to generate code sample.Accepted
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
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
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
{ "id": "string", "requestId": "string", "time": "2019-08-24T14:15:22Z", "thirdPartyIdentifiers": [ { … } ], "stan": "string", "rrn": "string", "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … } } }
This operation is identical to the 'createTokenPurchaseRequest' operation except that no tokens are returned and this operation carries no financial impact. This operation allows the customer to make an informed choice about the transaction outcome before committing to purchase electricity. This operation serves to inform a customer exactly what the outcome of their purchase is: the service charges which will be levied, the debt recovery charges, the number of units which will be provided etc. If a customer is dissatisfied with the details in the response, the customer may abort the transaction without any consequences.
A token purchase request.
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.
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Amount in minor denomination, e.g. R799.95 is encoded as 79995
Three digit currency number from ISO 4217, e.g. South African Rand is encoded as 710
Mobile phone number of the customer to which the outcome of a transaction can be communicated. This should conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en), but a 10-digit number beginning with zero is also acceptable.
An array of tenders used to pay for the transaction. This is used if payment is tendered at the point of sale. A Tender differs from a PaymentMethod in that the former represents a payment that has already been collected at the point of sale, whereas the latter represents a payment that still needs to be collected from a third party.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
An array of payment methods to be used as payment for the transaction. This is used if payment is not tendered at the point of sale, but is effected through one or more calls to third party payment providers as part of the request. A PaymentMethod differs from a Tender in that the former represents payment that still needs to be collected from a third party, whereas the latter represents payment that has already been collected at the point of sale.
https://[placeholder].dev/prepaidutility/v3/tokenPurchases/{trialId}/trial
Failed to generate code sample.OK
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.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
A customer who ultimately requests a transaction be performed.
The status of this customer on the Giftcard system. For example: active, inactive
This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en) e.g. 27821234567 for a South African number.
The customer's email address. This address must conform to RFC 5322 3.4.1 addr-spec (https://tools.ietf.org/html/rfc5322#section-3.4.1).
Represents a utility with whom a meter is registered.
Identifier assigned by the utility to the client connecting to the utility's token issuing service.
List of charges that have been levied in order to reclaim outstanding debts associated with the meter.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
{ "transactionLabels": [ { … } ], "purchaseTotal": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "taxTotal": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … } }, "meter": { "meterId": "string", "track2Data": "string", "serviceType": "string", "supplyGroupCode": "string", "keyRevisionNum": "string", "tariffIndex": "string", "tokenTechCode": "string", "algorithmCode": "string", "keyChangeData": { … } }, "customer": { "firstName": "string", "lastName": "string", "address": "string", "dateOfBirth": "2019-08-24T14:15:22Z", "status": "string", "msisdn": "string", "emailAddress": "string", "addressDetails": { … }, "profileId": "string" }, "utility": { "name": "string", "address": "string", "vatRegNum": "string", "clientId": "string", "message": "string" }, "utilityType": "string", "tokens": [ { … } ], "debtRecoveryCharges": [ { … } ], "serviceCharges": [ { … } ], "vatInvoiceNumber": "string", "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "string", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string" }
A token reprint request.
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.
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
Reference or receipt number for the original token in the case that a specific token is requested. If this field is not present, then the last-issued token will be requested from the provider.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/prepaidutility/v3/tokenReprints/{reprintId}
Failed to generate code sample.OK
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.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Data associated with a prepaid utility meter
Track 2 data stored on the magnetic stripe of a card that is supplied with certain meters. This data contains all meter details. It can be used as an alternative means of input at PoS and may be required by some providers.
Type of service dispensed by this meter (e.g. electricity, water or gas).
The means by which tokens are supplied for this meter (typically either numeric token or magnetic track).
Code used to identify token encryption algorithm used by the meter.
A customer who ultimately requests a transaction be performed.
The status of this customer on the Giftcard system. For example: active, inactive
This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en) e.g. 27821234567 for a South African number.
The customer's email address. This address must conform to RFC 5322 3.4.1 addr-spec (https://tools.ietf.org/html/rfc5322#section-3.4.1).
Represents a utility with whom a meter is registered.
Identifier assigned by the utility to the client connecting to the utility's token issuing service.
List of charges that have been levied in order to reclaim outstanding debts associated with the meter.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
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
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
{ "transactionLabels": [ { … } ], "purchaseTotal": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "taxTotal": { "amount": 0, "currency": "string", "ledgerIndicator": "DEBIT" }, "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … } }, "meter": { "meterId": "string", "track2Data": "string", "serviceType": "string", "supplyGroupCode": "string", "keyRevisionNum": "string", "tariffIndex": "string", "tokenTechCode": "string", "algorithmCode": "string", "keyChangeData": { … } }, "customer": { "firstName": "string", "lastName": "string", "address": "string", "dateOfBirth": "2019-08-24T14:15:22Z", "status": "string", "msisdn": "string", "emailAddress": "string", "addressDetails": { … }, "profileId": "string" }, "utility": { "name": "string", "address": "string", "vatRegNum": "string", "clientId": "string", "message": "string" }, "utilityType": "string", "tokens": [ { … } ], "debtRecoveryCharges": [ { … } ], "serviceCharges": [ { … } ], "vatInvoiceNumber": "string", "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "string", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string" }