{"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":2,"id":"purchase-trial-request"},"children":["Purchase Trial Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path: airtime/v5/purchases/trials\nMethod: POST\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"e83e28a3-2fbe-4265-9543-efa66f37869c\",\n  \"time\": \"2020-12-03T12:09:05.017Z\",\n  \"originator\": {\n    \"institution\": {\n      \"id\": \"12345\",\n      \"name\": \"Originator\"\n    },\n    \"terminalId\": \"00000003\",\n    \"merchant\": {\n      \"merchantType\": \"0000\",\n      \"merchantId\": \"1111111111\",\n      \"merchantName\": {\n        \"name\": \"Merchant\",\n        \"city\": \"Cape Town\",\n        \"region\": \"WC\",\n        \"country\": \"ZA\"\n      },\n    },\n  },\n  \"client\": {\n    \"id\": \"23456\",\n    \"name\": \"Client\"\n  },\n  \"thirdPartyIdentifiers\": [\n    {\n      \"institutionId\": \"12345\",\n      \"transactionIdentifier\": \"033814aafc20\"\n    },\n    {\n      \"institutionId\": \"23456\",\n      \"transactionIdentifier\": \"033814aafc20\"\n    },\n  ],\n  \"amounts\": {\n    \"requestAmount\": {\n      \"amount\": 5000,\n      \"currency\": \"710\"\n    },\n  },\n  \"product\": {\n    \"productId\": \"759\",\n    \"type\": \"DATA\"\n  },\n  \"tenders\": [\n    {\n      \"accountType\": \"DEFAULT\",\n      \"amount\": {\n        \"amount\": 5000,\n        \"currency\": \"710\"\n      },\n      \"reference\": \"bde7db52624c4667ba339eb80abcc87c\",\n      \"tenderType\": \"OTHER\"\n    },\n  ],\n  \"recipientMsisdn\": {\n    \"msisdn\": \"27555666332\",\n    \"country\": \"ZA\",\n    \"operator\": {\n      \"id\": \"6329442\",\n      \"name\": \"MTN\"\n    },\n },\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"purchase-trial-response"},"children":["Purchase Trial Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path: airtime/v5/purchases/trials\nStatus: OK\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"ecd4205d-6cda-4fc8-99e6-6d9132a651fc\",\n  \"time\": \"2020-12-03T12:25:05.193Z\",\n  \"originator\": {\n    \"institution\": {\n      \"id\": \"12345\",\n      \"name\": \"Originator\"\n    },\n    \"terminalId\": \"00000003\",\n    \"merchant\": {\n      \"merchantType\": \"0000\",\n      \"merchantId\": \"1111111111\",\n      \"merchantName\": {\n        \"name\": \"Merchant\",\n        \"city\": \"Cape Town\",\n        \"region\": \"WC\",\n        \"country\": \"ZA\"\n      },\n    },\n  },\n  \"client\": {\n    \"id\": \"23456\",\n    \"name\": \"Client\"\n  },\n  \"thirdPartyIdentifiers\": [\n    {\n      \"institutionId\": \"12345\",\n      \"transactionIdentifier\": \"033814gafqan\"\n    },\n    {\n      \"institutionId\": \"23456\",\n      \"transactionIdentifier\": \"033814gafqan\"\n    }\n  ],\n  \"amounts\": {\n    \"requestAmount\": {\n      \"amount\": 1000,\n      \"currency\": \"710\"\n    },\n  },\n  \"product\": {\n    \"productId\": \"766\",\n    \"type\": \"DATA\"\n  },\n  \"recipientMsisdn\": {\n    \"msisdn\": \"27891111001\",\n    \"country\": \"ZA\",\n    \"operator\": {\n      \"id\": \"6329442\",\n      \"name\": \"MTN\"\n    },\n  },\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"purchase-request"},"children":["Purchase Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path: airtime/v5/purchases\nMethod: POST\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"e83e28a3-2fbe-4265-9543-efa66f37869c\",\n  \"time\": \"2020-12-03T12:09:05.017Z\",\n  \"originator\": {\n    \"institution\": {\n      \"id\": \"12345\",\n      \"name\": \"Originator\"\n    },\n    \"terminalId\": \"00000003\",\n    \"merchant\": {\n      \"merchantType\": \"0000\",\n      \"merchantId\": \"1111111111\",\n      \"merchantName\": {\n        \"name\": \"Merchant\",\n        \"city\": \"Cape Town\",\n        \"region\": \"WC\",\n        \"country\": \"ZA\"\n      },\n    },\n  },\n  \"client\": {\n    \"id\": \"23456\",\n    \"name\": \"Client\"\n  },\n  \"thirdPartyIdentifiers\": [\n    {\n      \"institutionId\": \"12345\",\n      \"transactionIdentifier\": \"033814aafc20\"\n    },\n    {\n      \"institutionId\": \"23456\",\n      \"transactionIdentifier\": \"033814aafc20\"\n    },\n  ],\n  \"amounts\": {\n    \"requestAmount\": {\n      \"amount\": 5000,\n      \"currency\": \"710\"\n    },\n  },\n  \"product\": {\n    \"productId\": \"759\",\n    \"type\": \"DATA\"\n  },\n  \"tenders\": [\n    {\n      \"accountType\": \"DEFAULT\",\n      \"amount\": {\n        \"amount\": 5000,\n        \"currency\": \"710\"\n      },\n      \"reference\": \"bde7db52624c4667ba339eb80abcc87c\",\n      \"tenderType\": \"OTHER\"\n    },\n  ],\n  \"recipientMsisdn\": {\n    \"msisdn\": \"27555666332\",\n    \"country\": \"ZA\",\n    \"operator\": {\n      \"id\": \"6329442\",\n      \"name\": \"MTN\"\n    },\n },\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"purchase-response"},"children":["Purchase Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Path: airtime/v5/purchases\nStatus: Created\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"e83e28a3-2fbe-4265-9543-efa66f37869c\",\n  \"time\": \"2020-12-03T12:09:05.017Z\",\n  \"originator\": {\n    \"institution\": {\n      \"id\": \"12345\",\n      \"name\": \"Originator\"\n    },\n    \"terminalId\": \"00000003\",\n    \"merchant\": {\n      \"merchantType\": \"0000\",\n      \"merchantId\": “1111111111\",\n      \"merchantName\": {\n        \"name\": \"Merchant\",\n        \"city\": \"Cape Town\",\n        \"region\": \"WC\",\n        \"country\": \"ZA\"\n      },\n    },\n  },\n  \"client\": {\n    \"id\": \"23456\",\n    \"name\": \"Client\"\n  },\n  \"settlementEntity\": {\n    \"id\": \"6329431\",\n    \"name\": \"Easypay\"\n  },\n  \"receiver\": {\n    \"id\": \"6329431\",\n    \"name\": \"Easypay\"\n  },\n  \"thirdPartyIdentifiers\": [\n    {\n      \"institutionId\": \"12345\",\n      \"transactionIdentifier\": \"033814aafc20\"\n    },\n    {\n      \"institutionId\": \"23456\",\n      \"transactionIdentifier\": \"033814aafc20\"\n    },\n    {\n      \"institutionId\": \"6329431\",\n      \"transactionIdentifier\": \"15787309\"\n    },\n  ],\n  \"amounts\": {\n    \"requestAmount\": {\n      \"amount\": 5000,\n      \"currency\": \"710\"\n    },\n    \"approvedAmount\": {\n      \"amount\": 5000,\n      \"currency\": \"710\"\n    },\n  },\n  \"product\": {\n    \"productId\": \"759\",\n    \"type\": \"DATA\"\n  },\n  \"msisdn\": {\n    \"msisdn\": \"27555666332\",\n    \"operator\": {\n      \"id\": \"6329442\",\n      \"name\": \"MTN\"\n    },\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    \"id\": \"be6c28e6-6c10-4012-b0ad-6ada28f57a58\",\n    \"errorType\": \"GENERAL_ERROR\",\n    \"errorMessage\": \"General system error\",\n    \"requestType\": \"TRIAL_PURCHASE_REQUEST\",\n    \"detailMessage\": { }\n    \"providerErrorCode\": \"9000\",\n    \"providerErrorMsg\": \"General system error\"\n  }\n","lang":"json"},"children":[]}]},"headings":[{"value":"Message payload samples","id":"message-payload-samples","depth":1},{"value":"Purchase Trial Request","id":"purchase-trial-request","depth":2},{"value":"Purchase Trial Response","id":"purchase-trial-response","depth":4},{"value":"Purchase Request","id":"purchase-request","depth":4},{"value":"Purchase Response","id":"purchase-response","depth":4},{"value":"ErrorDetail","id":"errordetail","depth":4}],"frontmatter":{"seo":{"title":"Message payload samples"}},"lastModified":"2026-01-28T10:41:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/vas/public/airtime-direct-top-up/message-payload-samples","userData":{"isAuthenticated":false,"teams":["anonymous"]}}