Required Parameters for Building UI

Your user interface needs to dynamically adjust to reflect required fields based on the product’s configuration.

The response from GET Retrieve list of products indicates which parameters are required.

Possibly Required Parameters

Credit Party Identifier

Identifies the party receiving the value (e.g. the mobile_number or account_number to be topped up or recharged).

Debit Party Identifier

Identifies the party being charged for the transaction.

Beneficiary Fields

Details about the end beneficiary (e.g. name, email, or phone number) when the product requires them.

Statement Fields

Additional information required to appear on the transaction statement for the product.

Rules for Handling Required Parameters

  • If a Credit Party Identifier (Mobile Number) is required (marked "Yes" in the API response), the UI must prompt the user to enter a mobile number.
  • If an Account Number or other identifier is mandatory, the UI must display the corresponding input field.
  • If no mandatory fields are required (case for majority of Gift Cards), the UI must allow seamless checkout without additional inputs.
  • The UI must handle different product types and required identifiers dynamically, updating input fields in real time based on API responses.

Did this page help you?