Payment Report File

Shows successful payments initiated by integrator. Report can be configured for any period, frequency, or filter.

File naming convention:

transactions-<start_date>--<end_date>.csv

E.g. transactions-01-05-2025--01-25-2025.csv will include all transactions from Jan 5 to Jan 25 UTC Time (inclusive)

Field Name
Required?
Constraints / Notes

payment_id

yes

str

status

yes

str(SUCCESS | CANCELLED We only report non-failed transactions

datetime_initiated

yes

str(YYYY-MM-DDTHH:MMZ)

UTC TIME - ISO8601 UTC Time

amount

yes

email

yes

phone_number

yes

address_line_1

no

address_line_2

no

address_city

no

address_state

no

address_zip

no

idempotency_key

yes

claim_status

yes

CLAIMED - User has (1) "clicked the link", (2) securely authenticated via OTP, and (3) user has access to payment balance. UNCLAIMED - User has not (1) gained access to the payment balance and (2) authenticated via OTP

datetime_claimed

no

claim_metadata

yes

str(JSON) e.g. {ip_address: <>, device_id: <>} We usually return str(IP Address) and str(browser fingerprint), but we can't guarantee specific metadata field

notes

yes

Last updated