FIELD NAME | DESCRIPTION | NOTES |
ID | Unique ID for the payment | |
TIMESTAMP | Date and time for the reading | Required
Time of payment in UTC timezone using ISO 8601 format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' |
PAYMENT_AMOUNT | Amount paid | Required |
PAYMENT_CURRENCY | The currency of the transaction | Required |
TRANSACTION_TYPE | Possible values: FULL_PAYMENT, INSTALLMENT_PAYMENT, NON_CONTRACT_PAYMENT, DISCOUNT, REVERSAL, ENERGY_CREDIT | Required |
TRANSACTION_CHARGES | Charges associated with the transaction | Not Required |
REFERENCE_ID | Payment reference ID | Not Required |
CUSTOMER_ID | The customer ID of the user of the device (SHS device or mini-grid meter). This may be required by the financing organization in order to verify the sale. | Required |
METER_ID | | Required |
|
CUSTOMER_NAME | Name of the customer | Required |
CUSTOMER_PHONE | Phone number of the user of the device | Not Required
Example : +234xxxxxx |
CUSTOMER_CATEGORY | Category of the customer who uses the property applicable Required Description device. Dependent on the provider.
| Example values are Public, Prepaid, Residential, Commercial, Business, etc. |
FINANCING_ID | ID specific to the financing provider or program. | Not Requiried |
AGENT_ID | The agent facilitating the transaction, such as a sales person's name | Not Requiried |
LATITUDE | Latitude of the location of the device | Not Requiried |
LONGITUDE | Longitude of the location of the device | Not Requiried |
UTILITY_ID | A unique ID for utility | Not Requiried |
FAILED_BATTERY_CAPACITY_COUNT | This field will track the number of instances where batteries fail to reach their capacity limit, a crucial metric for understanding payment and operational efficiency. | Not Requiried |
ACCOUNT_TYPE | This is the customer type | Not Requiried |
STATUS | | Not Requiried |
NOTES | Any other notes you want to add | Not Requiried |