This operation is performed when a voucher is used as a form of tender. When used as a form of tender, the recipient redeems the requestAmount
against the voucher. The voucher vendor is responsible for authorizing the redemption. Once fully redeemed, the voucher may not be used as a form of tender again.
A redemption 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. | |
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.). |
srcAccType | string This specifies the type of source account being used in the transaction (i.e. cheque, savings). |
destAccType | string This specifies the type of destination account being used in the transaction (i.e. cheque, savings). |
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. |
required | object (Voucher) Specifically describes the voucher provisioned by the vendor. |
object (Amounts) Amounts which make up the transaction. Absent amounts have zero value. | |
object (PosInfo) POS related data. |
successful operation
Created
Bad request
Internal server error
Service unavailable
Gateway timeout
{- "transactionLabels": [
- {
- "name": "string",
- "value": "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",
- "voucher": {
- "code": "string",
- "expiryDate": "2019-08-24T14:15:22Z",
- "redeemInstructions": [
- "string"
], - "serialNumber": "string",
- "pin": {
- "type": "CLEAR_PIN"
}
}, - "amounts": {
- "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": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "property2": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}
}
}, - "posInfo": {
- "entryMode": {
- "panEntryMode": "UNKNOWN",
- "pinEntryCapability": "UNKNOWN"
}, - "posConditionCode": "NORMAL_PRESENTMENT"
}
}
{- "transactionLabels": [
- {
- "name": "string",
- "value": "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",
- "voucher": {
- "code": "string",
- "expiryDate": "2019-08-24T14:15:22Z",
- "redeemInstructions": [
- "string"
], - "serialNumber": "string",
- "pin": {
- "type": "CLEAR_PIN"
}
}, - "amounts": {
- "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": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "property2": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}
}
}, - "posInfo": {
- "entryMode": {
- "panEntryMode": "UNKNOWN",
- "pinEntryCapability": "UNKNOWN"
}, - "posConditionCode": "NORMAL_PRESENTMENT"
}
}