Data Definition
Field Name | Data Type | Options | State |
---|---|---|---|
recipientName | string | - | Mandatory |
recipientPhoneNumber | string | - | Mandatory |
recipientccy | string | - | Mandatory |
amount | integer | - | Mandatory |
callBackUrl | string | - | Mandatory |
Explanation in Plain English:
-
recipientName: This is the name of the person receiving the airtime. It's a required field.
-
recipientPhoneNumber: The phone number to which the airtime will be sent. This is also mandatory.
-
recipientccy: This stands for the currency code of the country the airtime is being purchased for. For example, you would use "KES" for Kenya, "USD" for the United States. It's a mandatory field.
-
amount: This is the amount of airtime being purchased. It’s specified in integers (e.g.,
500
for 500 units of airtime). This is required. -
callBackUrl: This is the URL where you'll receive a notification (callback) once the transaction is complete. It's a required field and should be set to the URL where your system can handle the callback.
Additional Descriptions:
-
CurrencyCode: This refers to the country's currency code (e.g., "KES" for Kenya Shilling). It’s used to ensure that the airtime is purchased in the correct currency.
-
PhoneNumber: This is the phone number associated with the airtime purchase. It is where the airtime will be credited after a successful transaction.
-
Amount: The value (in the chosen currency) for how much airtime is to be bought for the recipient.
-
OriginatorConversationId: This is a unique identifier for the transaction. It is automatically generated by Zamupay for tracking purposes.
-
CallbackURL: This is a specific endpoint (URL) where you will receive updates about the status of the airtime purchase, such as success or failure.