Documentation: payments_ts

Payment time series data for SHS Accounts or Meter Accounts
To import data in this format you can use our API. -> API Documentation
Rate limit: 300 requests per minute. Once the limit is exceeded, any further requests will result in a 429 (Too Many Requests) response.
You can also supply us with files in xlsx, csv or json format. -> Example CSV
Row Name Type Example

payment_external_id *

ID for the specific payment as tracked by the data provider (source)

  • * required
string

ABC-123

paid_at *

date payment was made (including time if available)

  • * required
datetime

2022-07-30 14:45:32.876Z

amount *

amount of payment, in whatever currency is specified

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

  • * required
float

150.5

currency *

currency in which payment was made according to ISO code https://en.wikipedia.org/wiki/List_of_circulating_currencies

  • * required
string

ZMW

account_external_id *

external id for the specific account (e.g. paygo loan) associated with the shs or meter

  • * required
string

1234abcd

account_origin *

The table where we find the matching account_uid

  • * required
enum: meters, shs, installations

meters

uid

account_origin + account_uid + payment_external_id + paid_at

  • auto-generated
string

meters-1-generic-1234abcd-ABC-123-2022-07-30 14:45:32.876Z

purpose

e.g.: Paygo payment, Loan repayment, cash purchase, tariff payment, etc.

 string

Paygo Payment

paid_until

date payment is valid until

 datetime

2022-07-30 14:45:32.876Z

purchase_item

item or rate which was purchased with the payment, e.g. 'Energy', 'TV', 'Uptime'

 string

Uptime

purchase_unit

unit of the purchase, e.g. 'wh', 'pcs', 'days'

 string

days

purchase_quantity

amount of units of the item purchased

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

 float

3.0

provider_name

who provided payment for particular payment (e.g. airtel, cash, MTN)

 string

MTN

provider_category

high level category of the payment, like bank transfer, cash, mobile money, app, other

 string

mobile money

provider_transaction_id

data validation, was transaction actually done

 string

12345X

reverted_at

datetime of when payment was reverted

 datetime

2022-07-30 14:48:20.876Z

days_active

information from shs table, is calculated

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

 float

7.2

account_uid

organization_id + data_origin + account_external_id

  • auto-generated
string

1-generic-1234abcd

created_at

Timestamp when row was inserted

  • auto-generated
datetime

2021-05-03 6:23:55

updated_at

Timestamp when row was updated

  • auto-generated
datetime

2021-05-03 6:23:55

source_id

References Source of data

  • auto-generated
integer

1

import_id

References Import of data

  • auto-generated
integer

1

organization_id

References Organization of data

  • auto-generated
integer

1

custom

Saves additional imported data out of standard structure

  • auto-generated
jsonb

{ "some": "key" }

data_origin

Origin of the data, generic or name of the api

  • auto-generated
string

generic

last_import_id

Id of the last import which updated the record

  • auto-generated
integer

337

last_source_id

Id of the last Source which updated the record

  • auto-generated
integer

33