createKeyChangeTokenRequest

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.

SecurityhttpBasic or oauth2

Request

path Parameters

requestId

required

string

The randomly generated UUID of this request.

Request Body schema: application/json

A key change token request

	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.
required	object (Meter) Data associated with a prepaid utility meter
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

201

Created

400

Bad request

500

Internal server error

501

Not implemented

503

Service unavailable

504

Gateway timeout

post/keyChangeTokenRequests/{requestId}

Request samples

Payload
curl
Java
Node.js

application/json

{"transactionLabels": [{"name": "string",
"value": "string"
}
],
"meter": {"meterId": "string",
"track2Data": "string",
"serviceType": "string",
"supplyGroupCode": "string",
"keyRevisionNum": "string",
"tariffIndex": "string",
"tokenTechCode": "string",
"algorithmCode": "string",
"keyChangeData": {"newSupplyGroupCode": "string",
"newKeyRevisionNumber": "string",
"newTariffIndex": "string"
}
},
"id": "string",
"time": "2019-08-24T14:15:22Z",
"originator": {"institution": {"id": "string",
"name": "string"
},
"terminalId": "stringst",
"merchant": {"merchantType": "string",
"merchantId": "stringstringstr",
"merchantName": {"name": "string",
"city": "string",
"region": "st",
"country": "st"
}
},
"operatorId": "string",
"channelId": "string"
},
"client": {"id": "string",
"name": "string"
},
"settlementEntity": {"id": "string",
"name": "string"
},
"receiver": {"id": "string",
"name": "string"
},
"thirdPartyIdentifiers": [{"institutionId": "string",
"transactionIdentifier": "string"
}
],
"slipData": {"messageLines": [{"barcode": {"data": "string",
"encoding": "string"
},
"text": "string",
"fontWidthScaleFactor": 0,
"fontHeightScaleFactor": 0,
"line": false,
"cut": false
}
],
"slipWidth": 0,
"issuerReference": "string"
},
"basketRef": "string",
"tranType": "GOODS_AND_SERVICES",
"srcAccType": "DEFAULT",
"destAccType": "DEFAULT",
"stan": "string",
"rrn": "string"
}

Response samples

application/json

{"transactionLabels": [{"name": "string",
"value": "string"
}
],
"meter": {"meterId": "string",
"track2Data": "string",
"serviceType": "string",
"supplyGroupCode": "string",
"keyRevisionNum": "string",
"tariffIndex": "string",
"tokenTechCode": "string",
"algorithmCode": "string",
"keyChangeData": {"newSupplyGroupCode": "string",
"newKeyRevisionNumber": "string",
"newTariffIndex": "string"
}
},
"tokens": [{"tokenType": "STD",
"units": 0,
"amount": {"tax": 0,
"taxType": "string",
"taxRate": 0,
"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"receiptNum": "string",
"token": "string",
"tariffCalc": [{"units": 0,
"rate": 0
}
]
}
],
"id": "string",
"time": "2019-08-24T14:15:22Z",
"originator": {"institution": {"id": "string",
"name": "string"
},
"terminalId": "stringst",
"merchant": {"merchantType": "string",
"merchantId": "stringstringstr",
"merchantName": {"name": "string",
"city": "string",
"region": "st",
"country": "st"
}
},
"operatorId": "string",
"channelId": "string"
},
"client": {"id": "string",
"name": "string"
},
"settlementEntity": {"id": "string",
"name": "string"
},
"receiver": {"id": "string",
"name": "string"
},
"thirdPartyIdentifiers": [{"institutionId": "string",
"transactionIdentifier": "string"
}
],
"slipData": {"messageLines": [{"barcode": {"data": "string",
"encoding": "string"
},
"text": "string",
"fontWidthScaleFactor": 0,
"fontHeightScaleFactor": 0,
"line": false,
"cut": false
}
],
"slipWidth": 0,
"issuerReference": "string"
},
"basketRef": "string",
"tranType": "GOODS_AND_SERVICES",
"srcAccType": "DEFAULT",
"destAccType": "DEFAULT",
"stan": "string",
"rrn": "string"
}