Message payload samples

Path: airtime/v5/purchases/trials
Method: POST

{
  "id": "e83e28a3-2fbe-4265-9543-efa66f37869c",
  "time": "2020-12-03T12:09:05.017Z",
  "originator": {
    "institution": {
      "id": "12345",
      "name": "Originator"
    },
    "terminalId": "00000003",
    "merchant": {
      "merchantType": "0000",
      "merchantId": "1111111111",
      "merchantName": {
        "name": "Merchant",
        "city": "Cape Town",
        "region": "WC",
        "country": "ZA"
      },
    },
  },
  "client": {
    "id": "23456",
    "name": "Client"
  },
  "thirdPartyIdentifiers": [
    {
      "institutionId": "12345",
      "transactionIdentifier": "033814aafc20"
    },
    {
      "institutionId": "23456",
      "transactionIdentifier": "033814aafc20"
    },
  ],
  "amounts": {
    "requestAmount": {
      "amount": 5000,
      "currency": "710"
    },
  },
  "product": {
    "productId": "759",
    "type": "DATA"
  },
  "tenders": [
    {
      "accountType": "DEFAULT",
      "amount": {
        "amount": 5000,
        "currency": "710"
      },
      "reference": "bde7db52624c4667ba339eb80abcc87c",
      "tenderType": "OTHER"
    },
  ],
  "recipientMsisdn": {
    "msisdn": "27555666332",
    "country": "ZA",
    "operator": {
      "id": "6329442",
      "name": "MTN"
    },
 },
}

Path: airtime/v5/purchases/trials
Status: OK

{
  "id": "ecd4205d-6cda-4fc8-99e6-6d9132a651fc",
  "time": "2020-12-03T12:25:05.193Z",
  "originator": {
    "institution": {
      "id": "12345",
      "name": "Originator"
    },
    "terminalId": "00000003",
    "merchant": {
      "merchantType": "0000",
      "merchantId": "1111111111",
      "merchantName": {
        "name": "Merchant",
        "city": "Cape Town",
        "region": "WC",
        "country": "ZA"
      },
    },
  },
  "client": {
    "id": "23456",
    "name": "Client"
  },
  "thirdPartyIdentifiers": [
    {
      "institutionId": "12345",
      "transactionIdentifier": "033814gafqan"
    },
    {
      "institutionId": "23456",
      "transactionIdentifier": "033814gafqan"
    }
  ],
  "amounts": {
    "requestAmount": {
      "amount": 1000,
      "currency": "710"
    },
  },
  "product": {
    "productId": "766",
    "type": "DATA"
  },
  "recipientMsisdn": {
    "msisdn": "27891111001",
    "country": "ZA",
    "operator": {
      "id": "6329442",
      "name": "MTN"
    },
  },
}

Path: airtime/v5/purchases
Method: POST

{
  "id": "e83e28a3-2fbe-4265-9543-efa66f37869c",
  "time": "2020-12-03T12:09:05.017Z",
  "originator": {
    "institution": {
      "id": "12345",
      "name": "Originator"
    },
    "terminalId": "00000003",
    "merchant": {
      "merchantType": "0000",
      "merchantId": "1111111111",
      "merchantName": {
        "name": "Merchant",
        "city": "Cape Town",
        "region": "WC",
        "country": "ZA"
      },
    },
  },
  "client": {
    "id": "23456",
    "name": "Client"
  },
  "thirdPartyIdentifiers": [
    {
      "institutionId": "12345",
      "transactionIdentifier": "033814aafc20"
    },
    {
      "institutionId": "23456",
      "transactionIdentifier": "033814aafc20"
    },
  ],
  "amounts": {
    "requestAmount": {
      "amount": 5000,
      "currency": "710"
    },
  },
  "product": {
    "productId": "759",
    "type": "DATA"
  },
  "tenders": [
    {
      "accountType": "DEFAULT",
      "amount": {
        "amount": 5000,
        "currency": "710"
      },
      "reference": "bde7db52624c4667ba339eb80abcc87c",
      "tenderType": "OTHER"
    },
  ],
  "recipientMsisdn": {
    "msisdn": "27555666332",
    "country": "ZA",
    "operator": {
      "id": "6329442",
      "name": "MTN"
    },
 },
}

Path: airtime/v5/purchases
Status: Created

{
  "id": "e83e28a3-2fbe-4265-9543-efa66f37869c",
  "time": "2020-12-03T12:09:05.017Z",
  "originator": {
    "institution": {
      "id": "12345",
      "name": "Originator"
    },
    "terminalId": "00000003",
    "merchant": {
      "merchantType": "0000",
      "merchantId": “1111111111",
      "merchantName": {
        "name": "Merchant",
        "city": "Cape Town",
        "region": "WC",
        "country": "ZA"
      },
    },
  },
  "client": {
    "id": "23456",
    "name": "Client"
  },
  "settlementEntity": {
    "id": "6329431",
    "name": "Easypay"
  },
  "receiver": {
    "id": "6329431",
    "name": "Easypay"
  },
  "thirdPartyIdentifiers": [
    {
      "institutionId": "12345",
      "transactionIdentifier": "033814aafc20"
    },
    {
      "institutionId": "23456",
      "transactionIdentifier": "033814aafc20"
    },
    {
      "institutionId": "6329431",
      "transactionIdentifier": "15787309"
    },
  ],
  "amounts": {
    "requestAmount": {
      "amount": 5000,
      "currency": "710"
    },
    "approvedAmount": {
      "amount": 5000,
      "currency": "710"
    },
  },
  "product": {
    "productId": "759",
    "type": "DATA"
  },
  "msisdn": {
    "msisdn": "27555666332",
    "operator": {
      "id": "6329442",
      "name": "MTN"
    },
  },
}

  {
    "id": "be6c28e6-6c10-4012-b0ad-6ada28f57a58",
    "errorType": "GENERAL_ERROR",
    "errorMessage": "General system error",
    "requestType": "TRIAL_PURCHASE_REQUEST",
    "detailMessage": { }
    "providerErrorCode": "9000",
    "providerErrorMsg": "General system error"
  }