POST Ussd/SendInsurancePaymentNotification

Request Information

URI Parameters

None.

Body Parameters

UssdInsurancePaymentRequest
NameDescriptionTypeAdditional information
ServiceUsername

string

Required

ServicePassword

string

Required

PolicyNumber

string

Required

Amount

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Amount": "sample string 4",
  "PolicyNumber": "sample string 3",
  "ServicePassword": "sample string 2",
  "ServiceUsername": "sample string 1"
}

application/xml, text/xml

Sample:
<UssdInsurancePaymentRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ServiceUsername>sample string 1</ServiceUsername>
  <ServicePassword>sample string 2</ServicePassword>
  <PolicyNumber>sample string 3</PolicyNumber>
  <Amount>sample string 4</Amount>
</UssdInsurancePaymentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UssdPaymentResponse
NameDescriptionTypeAdditional information
Status

integer

None.

StatusMessage

string

None.

TransactionReference

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 1,
  "TransactionReference": 3,
  "StatusMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<UssdPaymentResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Status>1</Status>
  <StatusMessage>sample string 2</StatusMessage>
  <TransactionReference>3</TransactionReference>
</UssdPaymentResponse>