{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-vas/vas.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Message payload samples","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"message-payload-samples"},"children":["Message payload samples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"productslookupresponse"},"children":["ProductsLookupResponse"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path: suv/v1/products\nHTTP status: 200 OK\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"{\n    \"products\" : [ {\n      \"productId\" : \"12345\",\n      \"name\" : \"Supermarket X Voucher\",\n      \"description\" : \"For redemption at multiple Supermarket X merchants\",\n      \"minAmount\":{\n         \"amount\":5000,\n         \"currency\":\"710\"\n         },\n      \"maxAmount\":{\n         \"amount\":50000,\n         \"currency\":\"710\"\n      }\n    }, \n    {\n      \"productId\" : \"67890\",\n      \"name\" : \"Streaming Service Voucher\",\n      \"description\" : \"Valid for 1 month subscription to Streaming Service\",\n      \"amount\": {\n         \"amount\":10000,\n         \"currency\":\"710\"\n         }\n    }, \n    {\n      \"productId\" : \"13579\",\n      \"name\" : \"Fitness Gym Voucher\",\n      \"description\" : \"Valid for 3 month subscription at any Fitness Gym\"\n    } \n    ]\n}\n","lang":"JSON"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"provisionrequest"},"children":["ProvisionRequest"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path: SUV/v1/vouchers\nHTTP method: POST\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"{\n   \"id\":\"062afaa8-97f5-4cb1-ae40-763b77c2ec9a\",\n   \"time\":\"2021-07-13T09:41:46.747Z\",\n   \"originator\":{\n      \"institution\":{\n         \"id\":\"1234567\",\n         \"name\":\"Originating System\"\n      },\n      \"terminalId\":\"00000001\",\n      \"merchant\":{\n         \"merchantType\":\"5411\",\n         \"merchantId\":\"123456789123456\",\n         \"merchantName\":{\n            \"name\":\"Originating System\",\n            \"city\":\"Cape Town\",\n            \"region\":\"WC\",\n            \"country\":\"ZA\"\n         }\n      }\n   },\n   \"client\":{\n      \"id\":\"1234567\",\n      \"name\":\"Originating System\"\n   },\n   \"receiver\":{\n      \"id\":\"12234567890\",\n      \"name\":\"Voucher Issuer\"\n   },\n   \"settlementEntity\":{\n      \"id\":\"1234567891\",\n      \"name\":\"Service Provider\"\n   },\n   \"thirdPartyIdentifiers\":[\n      {\n         \"institutionId\":\"1234567\",\n         \"transactionIdentifier\":\"123456789012\"\n      }\n   ],\n   \"tranType\":\"GOODS_AND_SERVICES\",\n   \"rrn\":\"987654321987\",\n   \"amounts\":{\n      \"requestAmount\":{\n         \"amount\":10000,\n         \"currency\":\"710\"\n      }\n   },\n   \"product\":{\n      \"productId\":\"prodId01\",\n      \"barcode\":\"6009219501425\"\n   }\n}\n","lang":"JSON"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"provisionresponse"},"children":["ProvisionResponse"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path: suv/v1/vouchers\nHTTP status: 201 Created\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"\"id\":\"062afaa8-97f5-4cb1-ae40-763b77c2ec9a\",\n\"time\":\"2021-07-13T09:41:47.754Z\",\n\"originator\":{\n   \"institution\":{\n      \"id\":\"1234567\",\n      \"name\":\"Originating System\"\n   },\n   \"terminalId\":\"00000001\",\n   \"merchant\":{\n      \"merchantType\":\"5411\",\n      \"merchantId\":\"006001007034122\",\n      \"merchantName\":{\n         \"name\":\"Originating System\",\n         \"city\":\"Cape Town\",\n         \"region\":\"WC\",\n         \"country\":\"ZA\"\n      }\n   }\n},\n\"client\":{\n   \"id\":\"1234567\",\n   \"name\":\"Originating System\"\n},\n\"receiver\":{\n    \"id\":\"12234567890\",\n   \"name\":\"Voucher Issuer\"\n},\n\"settlementEntity\":{\n   \"id\":\"1234567891\",\n   \"name\":\"Service Provider\"\n},\n\"thirdPartyIdentifiers\":[\n   {\n      \"institutionId\":\"1234567\",\n      \"transactionIdentifier\":\"123456789012\"\n   }\n],\n\"tranType\":\" GOODS_AND_SERVICES \",\n\"rrn\":\"987654321987\",\n\"slipData\":{\n   \"messageLines\":[\n       ],\n   \"slipWidth\":0\n},\n\"amounts\":{\n   \"requestAmount\":{\n      \"amount\":10000,\n      \"currency\":\"710\"\n   },\n   \"approvedAmount\":{\n      \"amount\":10000,\n      \"currency\":\"710\"\n   }\n},\n\"voucher\":{\n   \"code\":\"23111006\",\n   \"expiryDate\":\"2024-07-13T09:41:47.754Z\",\n   \"serialNumber\":\"075183361132512\",\n   \"redeemInstructions\":[ \"Go to            www.voucherissuer.com/voucher and enter your voucher code\"\n   ]\n},\n\"product\":{\n   \"productId\":\"prodId01\",\n   \"barcode\":\"6009219501425\"\n}\n}\n","lang":"JSON"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"errordetail"},"children":["ErrorDetail"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"{\n\t\"id\": \"062afaa8-97f5-4cb1-ae40-763b77c2ec9a\",\n\t\"errorType\":\"ROUTING_ERROR\",\n\t\"errorMessage\":\"No route to remote\"\n}\n","lang":"JSON"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"tenderadvice"},"children":["TenderAdvice"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"c820990a-3d77-483b-9f29-1b4d174583fa\",\n  \"requestId\": \"062afaa8-97f5-4cb1-ae40-763b77c2ec9a\",\n  \"time\": \"2021-07-13T09:41:59.848Z\",\n  \"thirdPartyIdentifiers\": [\n    {\n      \"institutionId\": \"1234567\",\n      \"transactionIdentifier\": \"123456789012\"\n    }\n  ],\n  \"tenders\": [\n    {\n      \"accountType\": \"DEFAULT\",\n      \"amount\": {\n        \"amount\": 10000,\n        \"currency\": \"710\"\n      },\n      \"tenderType\": \"CASH\"\n    }\n  ]\n}\n","lang":"JSON"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"basicreversal"},"children":["BasicReversal"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path:suv/v1/vouchers/reversals\nHTTP method: POST\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"5a9c4101-aafd-4ee7-9f03-593d588a0278\",\n  \"requestId\": \"062afaa8-97f5-4cb1-ae40-763b77c2ec9a\",\n  \"time\": \"2021-07-13T09:41:59.848Z\",\n  \"rrn\": \"987654321987\",\n  \"thirdPartyIdentifiers\": [\n    {\n      \"institutionId\": \"1234567\",\n      \"transactionIdentifier\": \"123456789012\"\n    }\n  ],\n  \"reversalReason\":\"CANCELLED\"\n}\n","lang":"JSON"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"voucherlookuprequest"},"children":["VoucherLookupRequest"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path: SUV/v1/vouchers\nHTTP method: GET\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"{\n  \"pathParameters\": {},\n  \"queryParameters\": {\n    \"voucherSerialNumber\": \"216546531\"\n  },\n  \"multiValueQueryParameters\": {\n    \"voucherSerialNumber\": [\n      \"216546531\"\n    ]\n  }\n}\n","lang":"JSON"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"voucherlookupresponse"},"children":["VoucherLookupResponse"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path: SUV/v1/vouchers\nHTTP status: 200 OK\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"{\n   \"receiver\":{\n      \"id\":\"1231231231\",\n      \"name\":\"Service Provider\"\n   },\n   \"settlementEntity\":{\n      \"id\":\"1231231231\",\n      \"name\":\"Service Provider\"\n   },\n   \"amounts\":{\n      \"approvedAmount\":{\n         \"amount\":1000,\n         \"currency\":\"710\",\n         \"ledgerIndicator\":\"CREDIT\"\n      }\n   },\n   \"voucher\":{\n      \"code\":\"23111006\",\n      \"expiryDate\":\"2024-07-13T09:41:47.754Z\",\n      \"serialNumber\":\"216546531\"\n   },\n   \"product\":{\n      \"productId\":\"prodId01\",\n      \"barcode\":\"6009219501425\"\n   }\n}\n","lang":"JSON"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"redemptionrequest"},"children":["RedemptionRequest"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path: suv/v1/redemptions\nHTTP method: POST\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"{\n   \"id\":\"e156bc59-0bed-3693-a1a1-3db44a790446\",\n   \"time\":\"2021-07-13T09:41:59.848Z\",\n   \"originator\":{\n      \"institution\":{\n         \"id\":\"1234567\",\n         \"name\":\"Originating System\"\n      },\n      \"terminalId\":\"00000001\",\n      \"merchant\":{\n         \"merchantType\":\"5411\",\n         \"merchantId\":\"123456789123456\",\n         \"merchantName\":{\n            \"name\":\"Originating System\",\n            \"city\":\"Cape Town\",\n            \"region\":\"WC\",\n            \"country\":\"ZA\"\n         }\n      }\n   },\n   \"client\":{\n      \"id\":\"1234567\",\n      \"name\":\"Originating System\"\n   },\n   \"receiver\":{\n      \"id\":\"1231231231\",\n      \"name\":\"Service Provider\"\n   },\n   \"settlementEntity\":{\n      \"id\":\"1231231231\",\n      \"name\":\"Service Provider\"\n   },\n   \"thirdPartyIdentifiers\":[\n      {\n         \"institutionId\":\"1234567\",\n         \"transactionIdentifier\":\"123456789012\"\n      }\n   ],\n   \"tranType\":\"CASH_WITHDRAWAL\",\n   \"rrn\":\"987654321987\",\n   \"voucher\":{\n      \"pin\":{\n         \"type\":\"HASHED_PIN\",\n         \"hash\":\"72E4751F359EFBC42AB38D840E4C386B1C5C0E1130B9A66119B9C95B6295B3B4\",\n         \"hashedPinParameters\":{\n            \"name\":\"SHA-256\"\n         }\n      },\n      \"code\":\"23111006\",\n      \"expiryDate\":\"2024-07-13T09:41:47.754Z\",\n      \"serialNumber\":\"075183361132512\",\n      \"redeemInstructions\":[\n         \n      ]\n   },\n   \"amounts\":{\n      \"requestAmount\":{\n         \"amount\":10000,\n         \"currency\":\"710\"\n      }\n   }\n}\n","lang":"JSON"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"redemptionresponse"},"children":["RedemptionResponse"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path: suv/v1/redemptions\nHTTP status: 201 Created\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"{\n  \"id\" : \"e156bc59-0bed-3693-a1a1-3db44a790446\",\n  \"time\" : \"2021-07-13T09:41:59.848Z\",\n  \"originator\": {\n    \"institution\": {\n      \"id\": \"1234567\",\n      \"name\": \"Originating System\"\n    },\n    \"terminalId\": \"00000001\",\n    \"merchant\": {\n      \"merchantType\": \"5411\",\n      \"merchantId\": \"123456789123456\",\n      \"merchantName\": {\n        \"name\": \"Originating System\",\n        \"city\": \"Cape Town\",\n        \"region\": \"WC\",\n        \"country\": \"ZA\"\n      }\n    }\n  },\n  \"client\": {\n    \"id\": \"1234567\",\n    \"name\": \"Originating System\"\n  },\n  \"receiver\": {\n    \"id\": \"1231231231\",\n    \"name\": \"Service Provider\"\n  },\n  \"settlementEntity\": {\n    \"id\": \"1231231231\",\n    \"name\": \"Service Provider\"\n  },\n  \"thirdPartyIdentifiers\": [\n    {\n      \"institutionId\": \"1234567\",\n      \"transactionIdentifier\": \"123456789012\"\n    }\n  ],\n  \"slipData\": {\n    \"messageLines\": [],\n    \"slipWidth\": 0\n  },\n  \"tranType\": \" CASH_WITHDRAWAL\",\n  \"rrn\": \"987654321987\",\n  \"voucher\" : {\n    \"code\" : \"23111006\",\n    \"expiryDate\": \"2024-07-13T09:41:47.754Z\",\n    \"serialNumber\": \"075183361132512\",\n    \"redeemInstructions\" : [ ]\n  },\n  \"amounts\" : {\n    \"requestAmount\": {\n      \"amount\": 10000,\n      \"currency\": \"710\"\n    },\n    \"approvedAmount\": {\n      \"amount\": 10000,\n      \"currency\": \"710\"\n    }\n  }\n}\n","lang":"JSON"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"basicadvice"},"children":["BasicAdvice"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path: suv/v1/redemptions/confirmations\nHTTP method: POST\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"{\n\t\"id\":\"c820990a-0bed-3693-a1a1-3db44a790446\",\n\t\"requestId\":\"e156bc59-0bed-3693-a1a1-3db44a790446\",\n\t\"time\":\"2021-07-13T09:41:59.848Z\",\n\t\"thirdPartyIdentifiers\": [\n\t    {\n\t      \"institutionId\": \"13579\",\n\t      \"transactionIdentifier\": \"123456789012\"\n\t    }\n  \t],\n  \t\"rrn\": \"987654321987\",\n  \t\"amounts\" : {\n\t    \"approvedAmount\": {\n\t      \"amount\": 10000,\n\t      \"currency\": \"710\"\n\t    }\n  }\n}","lang":"JSON"},"children":[]}]},"headings":[{"value":"Message payload samples","id":"message-payload-samples","depth":1},{"value":"ProductsLookupResponse","id":"productslookupresponse","depth":4},{"value":"ProvisionRequest","id":"provisionrequest","depth":4},{"value":"ProvisionResponse","id":"provisionresponse","depth":4},{"value":"ErrorDetail","id":"errordetail","depth":4},{"value":"TenderAdvice","id":"tenderadvice","depth":4},{"value":"BasicReversal","id":"basicreversal","depth":4},{"value":"VoucherLookupRequest","id":"voucherlookuprequest","depth":3},{"value":"VoucherLookupResponse","id":"voucherlookupresponse","depth":3},{"value":"RedemptionRequest","id":"redemptionrequest","depth":3},{"value":"RedemptionResponse","id":"redemptionresponse","depth":3},{"value":"BasicAdvice","id":"basicadvice","depth":4}],"frontmatter":{"seo":{"title":"Message payload samples"}},"lastModified":"2026-01-28T10:41:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/vas/public/digital-vouchers/integrate-your-channel/message-payload-samples","userData":{"isAuthenticated":false,"teams":["anonymous"]}}