Payment Based Reports
This page provides descriptions of payment-related reports that can be downloaded via the endpoints mentioned above. Below report types are only applicable for fleet organizations.
¶ REPORT_TYPE_PAYMENTS_ORDER
The “Payment_Order” report type in the Generate Reports API is a critical tool for suppliers in Fleet sectors, offering payment-related information that is crucial for financial management and analysis. This report type serves as a path parameter in the Generate Report API, allowing users to access essential information related to financial transactions within the system.
Columns
| Column Name | Description |
|---|---|
| transaction UUID | A unique identifier for each transaction. |
| Driver UUID | A unique identifier for the driver associated with the transaction. |
| Driver first name | The first name of the driver. This column provides a personal identifier for the driver involved in the transaction. |
| Driver last name | The last name of the driver. |
| Vehicle License Plate | License plate of the vehicle used for the trip. Only included when this column is enabled for your organization. |
| Trip UUID | A unique identifier for the trip associated with the transaction. This is important for tracking the origin of financial transactions. |
| Description | A short description of the transaction, for example trip completed order or trip fare adjust order. Other charges and payments can have free-text descriptions. |
| Organization name | Name of the organization that requested the report. |
| Org alias | Alias of the organization that requested the report. If the organization has no alias, the name on the organization’s account is shown instead. |
| Processed At | The time the transaction was processed, in the organization’s local time with UTC offset (for example, 2026-10-14 04:17:15.602 +0530 IST). |
| Paid to you | Total amount paid to you for this transaction. |
| Paid to you : Your earnings | Your earnings from this transaction. |
| Paid to you : Trip balance : Payouts : Cash Collected | Cash collected from the rider for this transaction. |
| Paid to you : Your earnings : Fare | Fare portion of your earnings. |
| Paid to you : Your earnings : Taxes | Taxes included in your earnings. |
Note
- By default, column headers are translated into the language set for your organization’s location (for example, an organization in Brazil gets Portuguese headers), so the wording can vary by language and region. Even English headers can differ between regions (for example, “Driver last name” or “Driver surname”, “Organization name” or “Organisation name”).
- After the amount columns listed above, the report can add more amount columns for other earnings items present in the data (for example,
Paid to you:Your earnings:Fare:Surge). These headers join levels with “:” and no spaces. Which of these columns appear varies from report to report, so match columns by header name, not by position. - In Japan, the amount columns are different: meter, cancellation penalty, promotion, cash collected, service fee, paid to you, and adjustment.
¶ REPORT_TYPE_PAYMENTS_DRIVER
The “Payment Driver” report type in the Generate API is a crucial tool for managing payment information related to drivers in Fleet operations. This report serves as a comprehensive record of financial transactions and earnings for individual drivers, providing valuable information into their performance and payment status.
Columns
| Column Name | Description |
|---|---|
| Driver UUID | A unique identifier for the driver. |
| Driver first name | The first name of the driver. |
| Driver last name | The last name of the driver. |
| Total earnings | The driver’s total earnings for the reporting period. |
| Total earnings : Net fare | Net fare part of the total earnings. |
| Total earnings : Promotions | Promotions part of the total earnings. |
| Refunds & Expenses | Refunds and expenses for the reporting period, such as tolls and subscription charges. |
| Payouts | Total payouts for the reporting period. |
| Payouts : Transferred To Bank Account | Payouts transferred to a bank account. |
| Payouts : Cash collected | Payouts collected as cash. |
Note
- By default, column headers are translated into the language set for your organization’s location (for example, an organization in Brazil gets Portuguese headers), so the wording can vary by language and region. Even English headers can differ between regions (for example, “Driver last name” or “Driver surname”, “Organization name” or “Organisation name”).
- After the amount columns listed above, the report can add more amount columns for other earnings items present in the data (for example,
Total earnings:TiporPaid to Uber). These headers join levels with “:” and no spaces. Which of these columns appear varies from report to report, so match columns by header name, not by position. - In some markets the amount columns are instead: Paid to you, Paid to you : Your earnings, Paid to you : Trip balance : Payouts : Cash Collected, Paid to you : Your earnings : Fare, and Paid to you : Your earnings : Taxes. In the United States they are: Total earnings, Total earnings : Net fare, Refunds & Expenses, and Payouts.
¶ REPORT_TYPE_PAYMENTS_ORGANIZATION
The “Payments Organization” report type within the Generate API is a valuable tool designed specifically for Fleet operations. This report focuses on providing detailed payment information related to organizations, offering insights into financial transactions and earnings for better financial management and decision-making.
Columns
| Column Name | Description |
|---|---|
| Organization UUID | Identifier of the organization this row is for. The report has one row for your organization and one for each of its sub-organizations. |
| Organization name | Name of the organization that requested the report. |
| Org alias | Alias of the organization that requested the report. Empty if the organization has no alias. |
| Driver first name | First name on the account of the organization in this row. This is not a driver. |
| Driver last name | Last name on the account of the organization in this row. This is not a driver. |
| Start of period balance | The balance at the start of the reporting period. |
| End of period balance | The balance at the end of the reporting period. This helps in understanding the financial changes over the period. |
| Total earnings | Total earnings for the reporting period. |
| Total earnings : Net fare | Net fare part of the total earnings. |
| Total earnings : Promotions | Promotions part of the total earnings. |
| Refunds & Expenses | Refunds and expenses for the reporting period, such as tolls and subscription charges. |
| Payouts | Total payouts for the reporting period. |
| Payouts : Cash collected | Payouts collected as cash. |
| Payouts : Transferred To Bank Account | Payouts transferred to a bank account. |
Note
- By default, column headers are translated into the language set for your organization’s location (for example, an organization in Brazil gets Portuguese headers), so the wording can vary by language and region. Even English headers can differ between regions (for example, “Driver last name” or “Driver surname”, “Organization name” or “Organisation name”).
- After the amount columns listed above, the report can add more amount columns for other earnings items present in the data (for example,
Total earnings:TiporPaid to Uber). These headers join levels with “:” and no spaces. Which of these columns appear varies from report to report, so match columns by header name, not by position. - In some markets the amount columns are instead: Paid to you, Paid to you : Your earnings, Paid to you : Trip balance : Payouts : Cash Collected, Paid to you : Your earnings : Fare, and Paid to you : Your earnings : Taxes. In the United States they are: Total earnings, Total earnings : Net fare, Refunds & Expenses, and Payouts.
¶ FAQ
- Can we use Get Transactions API to fetch transaction information similar to payment transaction report?
- Yes, we have the option to utilize this endpoint. However, its primary purpose is to furnish transaction information in real-time. Moreover, this endpoint imposes stringent rate limits and restricts the query time range to 15 minutes with a look-back of 24 hours, as per our internal architecture. Additionally, while the breakdown in the response of this endpoint may lack the granularity found in the Payment Transaction Report, it does offer fundamental transaction information that aligns with the data in the payment transaction report.