Message payload samples
ProductsLookupResponse
Path: suv/v1/products
HTTP status: 200 OK{
"products" : [ {
"productId" : "12345",
"name" : "Supermarket X Voucher",
"description" : "For redemption at multiple Supermarket X merchants",
"minAmount":{
"amount":5000,
"currency":"710"
},
"maxAmount":{
"amount":50000,
"currency":"710"
}
},
{
"productId" : "67890",
"name" : "Streaming Service Voucher",
"description" : "Valid for 1 month subscription to Streaming Service",
"amount": {
"amount":10000,
"currency":"710"
}
},
{
"productId" : "13579",
"name" : "Fitness Gym Voucher",
"description" : "Valid for 3 month subscription at any Fitness Gym"
}
]
}ProvisionRequest
Path: SUV/v1/vouchers
HTTP method: POST{
"id":"062afaa8-97f5-4cb1-ae40-763b77c2ec9a",
"time":"2021-07-13T09:41:46.747Z",
"originator":{
"institution":{
"id":"1234567",
"name":"Originating System"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"123456789123456",
"merchantName":{
"name":"Originating System",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":"Originating System"
},
"receiver":{
"id":"12234567890",
"name":"Voucher Issuer"
},
"settlementEntity":{
"id":"1234567891",
"name":"Service Provider"
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"tranType":"GOODS_AND_SERVICES",
"rrn":"987654321987",
"amounts":{
"requestAmount":{
"amount":10000,
"currency":"710"
}
},
"product":{
"productId":"prodId01",
"barcode":"6009219501425"
}
}ProvisionResponse
Path: suv/v1/vouchers
HTTP status: 201 Created"id":"062afaa8-97f5-4cb1-ae40-763b77c2ec9a",
"time":"2021-07-13T09:41:47.754Z",
"originator":{
"institution":{
"id":"1234567",
"name":"Originating System"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"006001007034122",
"merchantName":{
"name":"Originating System",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":"Originating System"
},
"receiver":{
"id":"12234567890",
"name":"Voucher Issuer"
},
"settlementEntity":{
"id":"1234567891",
"name":"Service Provider"
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"tranType":" GOODS_AND_SERVICES ",
"rrn":"987654321987",
"slipData":{
"messageLines":[
],
"slipWidth":0
},
"amounts":{
"requestAmount":{
"amount":10000,
"currency":"710"
},
"approvedAmount":{
"amount":10000,
"currency":"710"
}
},
"voucher":{
"code":"23111006",
"expiryDate":"2024-07-13T09:41:47.754Z",
"serialNumber":"075183361132512",
"redeemInstructions":[ "Go to www.voucherissuer.com/voucher and enter your voucher code"
]
},
"product":{
"productId":"prodId01",
"barcode":"6009219501425"
}
}ErrorDetail
{
"id": "062afaa8-97f5-4cb1-ae40-763b77c2ec9a",
"errorType":"ROUTING_ERROR",
"errorMessage":"No route to remote"
}TenderAdvice
{
"id": "c820990a-3d77-483b-9f29-1b4d174583fa",
"requestId": "062afaa8-97f5-4cb1-ae40-763b77c2ec9a",
"time": "2021-07-13T09:41:59.848Z",
"thirdPartyIdentifiers": [
{
"institutionId": "1234567",
"transactionIdentifier": "123456789012"
}
],
"tenders": [
{
"accountType": "DEFAULT",
"amount": {
"amount": 10000,
"currency": "710"
},
"tenderType": "CASH"
}
]
}BasicReversal
Path:suv/v1/vouchers/reversals
HTTP method: POST{
"id": "5a9c4101-aafd-4ee7-9f03-593d588a0278",
"requestId": "062afaa8-97f5-4cb1-ae40-763b77c2ec9a",
"time": "2021-07-13T09:41:59.848Z",
"rrn": "987654321987",
"thirdPartyIdentifiers": [
{
"institutionId": "1234567",
"transactionIdentifier": "123456789012"
}
],
"reversalReason":"CANCELLED"
}VoucherLookupRequest
Path: SUV/v1/vouchers
HTTP method: GET{
"pathParameters": {},
"queryParameters": {
"voucherSerialNumber": "216546531"
},
"multiValueQueryParameters": {
"voucherSerialNumber": [
"216546531"
]
}
}VoucherLookupResponse
Path: SUV/v1/vouchers
HTTP status: 200 OK{
"receiver":{
"id":"1231231231",
"name":"Service Provider"
},
"settlementEntity":{
"id":"1231231231",
"name":"Service Provider"
},
"amounts":{
"approvedAmount":{
"amount":1000,
"currency":"710",
"ledgerIndicator":"CREDIT"
}
},
"voucher":{
"code":"23111006",
"expiryDate":"2024-07-13T09:41:47.754Z",
"serialNumber":"216546531"
},
"product":{
"productId":"prodId01",
"barcode":"6009219501425"
}
}RedemptionRequest
Path: suv/v1/redemptions
HTTP method: POST{
"id":"e156bc59-0bed-3693-a1a1-3db44a790446",
"time":"2021-07-13T09:41:59.848Z",
"originator":{
"institution":{
"id":"1234567",
"name":"Originating System"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"123456789123456",
"merchantName":{
"name":"Originating System",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":"Originating System"
},
"receiver":{
"id":"1231231231",
"name":"Service Provider"
},
"settlementEntity":{
"id":"1231231231",
"name":"Service Provider"
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"tranType":"CASH_WITHDRAWAL",
"rrn":"987654321987",
"voucher":{
"pin":{
"type":"HASHED_PIN",
"hash":"72E4751F359EFBC42AB38D840E4C386B1C5C0E1130B9A66119B9C95B6295B3B4",
"hashedPinParameters":{
"name":"SHA-256"
}
},
"code":"23111006",
"expiryDate":"2024-07-13T09:41:47.754Z",
"serialNumber":"075183361132512",
"redeemInstructions":[
]
},
"amounts":{
"requestAmount":{
"amount":10000,
"currency":"710"
}
}
}RedemptionResponse
Path: suv/v1/redemptions
HTTP status: 201 Created{
"id" : "e156bc59-0bed-3693-a1a1-3db44a790446",
"time" : "2021-07-13T09:41:59.848Z",
"originator": {
"institution": {
"id": "1234567",
"name": "Originating System"
},
"terminalId": "00000001",
"merchant": {
"merchantType": "5411",
"merchantId": "123456789123456",
"merchantName": {
"name": "Originating System",
"city": "Cape Town",
"region": "WC",
"country": "ZA"
}
}
},
"client": {
"id": "1234567",
"name": "Originating System"
},
"receiver": {
"id": "1231231231",
"name": "Service Provider"
},
"settlementEntity": {
"id": "1231231231",
"name": "Service Provider"
},
"thirdPartyIdentifiers": [
{
"institutionId": "1234567",
"transactionIdentifier": "123456789012"
}
],
"slipData": {
"messageLines": [],
"slipWidth": 0
},
"tranType": " CASH_WITHDRAWAL",
"rrn": "987654321987",
"voucher" : {
"code" : "23111006",
"expiryDate": "2024-07-13T09:41:47.754Z",
"serialNumber": "075183361132512",
"redeemInstructions" : [ ]
},
"amounts" : {
"requestAmount": {
"amount": 10000,
"currency": "710"
},
"approvedAmount": {
"amount": 10000,
"currency": "710"
}
}
}BasicAdvice
Path: suv/v1/redemptions/confirmations
HTTP method: POST{
"id":"c820990a-0bed-3693-a1a1-3db44a790446",
"requestId":"e156bc59-0bed-3693-a1a1-3db44a790446",
"time":"2021-07-13T09:41:59.848Z",
"thirdPartyIdentifiers": [
{
"institutionId": "13579",
"transactionIdentifier": "123456789012"
}
],
"rrn": "987654321987",
"amounts" : {
"approvedAmount": {
"amount": 10000,
"currency": "710"
}
}
}