Confirm a voucher redemption request that completed successfully. There is typically no need to notify the voucher vendor of the successful completion of the sale. However, this API recognises that client implementations may be very familiar with dual message APIs and this confirmation operation is provided to achieve consistency across the API with respect to single vs dual message operations. By performing this operation the client indicates that no subsequent reversal of the redemption will be performed. Note though that the successful completion of the confirmRedemption operation does not guarantee that the voucher will not be refunded in future.
A voucher redemption confirmation.
id required | string The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122 |
requestId required | string The UUID identifying the request that this advice relates to |
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 | Array of objects (ThirdPartyIdentifier) 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. |
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. |
object (Amounts) Amounts which make up the transaction. Absent amounts have zero value. |
successful operation
Accepted
Bad request
Not found
Internal server error
Service unavailable
Gateway timeout
{- "id": "string",
- "requestId": "string",
- "time": "2019-08-24T14:15:22Z",
- "thirdPartyIdentifiers": [
- {
- "institutionId": "string",
- "transactionIdentifier": "string"
}
], - "stan": "string",
- "rrn": "string",
- "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"
}
}
}
}
{- "id": "string",
- "requestId": "string",
- "time": "2019-08-24T14:15:22Z",
- "thirdPartyIdentifiers": [
- {
- "institutionId": "string",
- "transactionIdentifier": "string"
}
], - "stan": "string",
- "rrn": "string",
- "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"
}
}
}
}