AWS S3 Payment data Integration

The Odyssey platform offers multiple ways to integrate mini-grid and solar home system electricity payment data depending on the data source. Integrating this data makes it available for the following purposes:

Enabling the remote verification of connections required by some results-based financing programs.

To learn more about submitting connections and using remote verification, please refer to the Odyssey user guide.

Enable analytics and visualizations of the data via Odyssey’s Analytics platform; providing insights into the operations across your mini-grid sites or solar home system installations; and joined with other data on the Odyssey platform.
Sharing operating data with other users of the Odyssey platform, such as investors or financing program administrators.

When you share, what you share, and who you share with, is entirely up to you and controllable via the Odyssey Project Sharing User Interface.

AWS S3 Integration

Integration Set-Up

Obtain credentials for accessing S3.

Send an email to support@odysseyenergsolutions.com directly with the financing facility or initiative you are participating in and request that your credentials be created.
Once completed, you will have;

An Access Key ID
A Secret Access Key
Analytics access in Odyssey

2. Set up and schedule your integration in the Odyssey platform

Navigate to Analytics > Data Integrations
On the API Data Integrations tab, click the Create button
Complete the following data;
Dataset Name
Choose ODYSSEY as The Data Provider
Choose AWS S3 as the Data Source
Chose Electricity Payments for the Dataset Type
Choose Target - Select either the Program-Level or Project-level option. This will create one bucket for all of your payment data that will be used for verification.

If you are integrating your mini-grid data, select the Project-level option. If you are integrating distributed assets (i.e. SHS) select the Program-level option.

Note:
1. You can download the ELECTRICITY_PAYMENT.csv file by clicking the link

2. Your IT team is to automatically push your payment data from your CRM using the fields on the CSV file.

3. Once set up, the integration will run daily, and ingest the file posted to the S3 Bucket specified.

Please note that manual uploads of the CSV file are not allowed

ii) Posting Data to S3

The integration will run daily and ingest the data into the Odyssey Analytics platform.

The file must meet the following specifications to be ingested:
1. The file must be saved as a .csv format.
2. The file must be named ELECTRICITY_PAYMENT.csv as shown in the file path
3. The file must contain the header names included in the sample file (see file definition below).
4. You can use the AWS REST APIs to post data to the S3 bucket for each project.
https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html
5. Once the file has been ingested, it will be moved to a sub-directory called Processed ; if there is an error processing the file it will be moved to a sub-directory called Error .

Electricity Payments File Definition

FIELD NAME DESCRIPTION REQUIRED?
EXAMPLE
ID Unique ID for the payment Required
UC45678
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'

2021-05-16T14:16:01
PAYMENT_AMOUNT Amount paid Required
5000
PAYMENT_CURRENCY The currency of the transaction Required
Naira
TRANSACTION_TYPE Possible values: FULL_PAYMENT, INSTALLMENT_PAYMENT, NON_CONTRACT_PAYMENT, DISCOUNT, REVERSAL, ENERGY_CREDIT Required
INSTALLMENT_PAYMENT
TRANSACTION_CHARGES Charges associated with the transaction Not Required
1000
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
45987
METER_ID
This is the serial number of the stand alone solar system

The system serial number will serve as the primary identifier in this program.

Required – For remote verification, this must match the external_id value entered in the connections section of the project. Learn more about verification here
Required
45987
CUSTOMER_NAME Name of the customer Required
John Doe
CUSTOMER_PHONE Phone number of the user of the device Required

+2344567890
CUSTOMER_CATEGORY Category of the customer who uses the property applicable Required Description device. Dependent on the provider.
Not Required
Public, Prepaid, Residential, Commercial, Business, etc
FINANCING_ID ID specific to the financing provider or program. Not Requiried
FIN-ASSET-4567
AGENT_ID The agent facilitating the transaction, such as a sales person's name Not Requiried
Name of the Agent/company
LATITUDE Latitude of the location of the device Not Requiried
1.3,30.14
LONGITUDE Longitude of the location of the device Not Requiried
1.3,30.14
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
Credit, debt, Public, Prepaid, Customer, Business, etc.
STATUS Payment status Not Requiried
Assigned, processed, reversed, pending, error, MANUAL, etc.
NOTES Any other notes you want to add Not Requiried

Related Articles
AWS S3 Meter metrics / Consumption data Integration
The Odyssey platform offers multiple ways to integrate mini-grid and solar home system electricity payment data depending on the data source. Integrating this data makes it available for the following purposes: Enabling the remote verification of ...
UPYA Integration
The Odyssey platform offers multiple ways to integrate mini-grid and solar home system electricity payment data depending on the data source. Integrating this data makes it available for the following purposes: Enabling the remote verification of ...
Data Analytics - Data Permissioning
The Odyssey platform offers multiple ways to integrate and share mini-grid and solar home system electricity payment data depending on the data source. Integrating this data makes it available for the following purposes: Enabling the remote ...
Angaza Integration
The Odyssey platform offers multiple ways to integrate mini-grid and solar home system electricity payment data depending on the data source. Integrating this data makes it available for the following purposes: Enabling the remote verification of ...
Mojec Integration
The Odyssey platform offers multiple ways to integrate mini-grid and solar home system electricity payment data depending on the data source. Integrating this data makes it available for the following purposes: Enabling the remote verification of ...

FIELD NAME	DESCRIPTION	REQUIRED?	EXAMPLE
ID	Unique ID for the payment	Required	UC45678
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' 2021-05-16T14:16:01
PAYMENT_AMOUNT	Amount paid	Required	5000
PAYMENT_CURRENCY	The currency of the transaction	Required	Naira
TRANSACTION_TYPE	Possible values: FULL_PAYMENT, INSTALLMENT_PAYMENT, NON_CONTRACT_PAYMENT, DISCOUNT, REVERSAL, ENERGY_CREDIT	Required	INSTALLMENT_PAYMENT
TRANSACTION_CHARGES	Charges associated with the transaction	Not Required	1000
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	45987
METER_ID	This is the serial number of the stand alone solar system The system serial number will serve as the primary identifier in this program. Required – For remote verification, this must match the external_id value entered in the connections section of the project. Learn more about verification here	Required	45987
METER_ID		Required
CUSTOMER_NAME	Name of the customer	Required	John Doe
CUSTOMER_PHONE	Phone number of the user of the device	Required	+2344567890
CUSTOMER_CATEGORY	Category of the customer who uses the property applicable Required Description device. Dependent on the provider.	Not Required	Public, Prepaid, Residential, Commercial, Business, etc
FINANCING_ID	ID specific to the financing provider or program.	Not Requiried	FIN-ASSET-4567
AGENT_ID	The agent facilitating the transaction, such as a sales person's name	Not Requiried	Name of the Agent/company
LATITUDE	Latitude of the location of the device	Not Requiried	1.3,30.14
LONGITUDE	Longitude of the location of the device	Not Requiried	1.3,30.14
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	Credit, debt, Public, Prepaid, Customer, Business, etc.
STATUS	Payment status	Not Requiried	Assigned, processed, reversed, pending, error, MANUAL, etc.
NOTES	Any other notes you want to add	Not Requiried

AWS S3 Payment data Integration

AWS S3 Payment data Integration

AWS S3 Integration

Integration Set-Up

ii) Posting Data to S3

The integration will run daily and ingest the data into the Odyssey Analytics platform.

Electricity Payments File Definition

Related Articles

AWS S3 Meter metrics / Consumption data Integration

UPYA Integration

Data Analytics - Data Permissioning

Angaza Integration

Mojec Integration