Reports
Convenient Checkout Gateway (CCG) will provide payout reports via Electronic Communication Gateway(ECG).
A Payout report is a reconciliation report to help match the payouts received in the Merchants bank account with the
payments and other transactions that they relate to. There are two types of payout reports:
- Individual Payout for Merchants and Finance team
- Combined Payout for Treasury Team
- Transaction-Level Fee report for Merchants
ECG Setup
ECG Setup has details on how to request and setup. Merchant, Finance and Treasury team members can get the reports from ECG source location. CCG will provide source user ID and Merchant ID during Merchant configuration that will be needed for the setup.
ECG Folder Structure
Merchant determines the destination location.
ECG Source folder structure to request for Individual Payout report:
/ccg/<env>/reports/<merchant-id>
ECG Source folder structure to request for Treasury Payout report:
/ccg/<env>/reports/treasury
Types of Data
Depending on the audience of Payout report, it will be composed of the combination of four categories of data:
CCG specific metadata
CCG will always include the following metadata in payments and other transactions.
CCG Payment metadata
| Field Name | Description | Sample value |
|---|---|---|
| checkoutId | CCG unique checkout identifier | 434189e3-e63v-47ef-a8fc-0d9a6d22f6c8 |
| merchantGroupId | CCG merchant Group Identifier composed of different Merchants belonging to a same group | 98da3d38-ff4j-44ee-be00-c47a94ed01a4 |
| merchantId | CCG unique merchant identifier | d4d9760a-9cea-45h8-a25d-e6a3612e479a |
| merchantName | CCG merchant name | someNewMerchant-merchant-stage |
| merchantTransactionId | merchant unique Transaction identifier | cef9923e-9fe0-4679-82hf-7151fe311cbb |
| referenceId | CCG unique reference identifier | e1837bc7-f5b3-4f52-bfrg-77e8d1cc95a0 |
| ccg_processor | CCG processor | STRIPE |
| ccg_paymentmethodlast4 | CCG payment method last 4 | 1234 |
| ccg_nameoncard | CCG name that was entered for the card | Shahrukh Khan |
| ccg_paymentmethodnickname | CCG nickname for customers payment method | personal WF Master |
| ccg_paymentMethodId | CCG Payment method id | 534179e3-redv-47ef-a7fc-0d9a5d22f6c7 |
CCG Refund metadata
| Field Name | Description | Sample value |
|---|---|---|
| ccg_refundId | CCG unique refund identifier | bf75eb27-7b1f-4171-b27f-099a284f5540 |
Merchant specific metadata
Merchant chosen data that may be beneficial to tie back to Merchant records for reconciling, reporting etc. Merchant can have payment or refund specific metadata.
Merchant Payment metadata
Some examples of Payment meta data:
| Field Name | Description | Sample value |
|---|---|---|
| ItemCode | Merchants unique code for an Item | 3456-4876 |
| orderId | Merchant unique orderId | 98da3d38-ff4j-44ee-be00-c47a94ed01a4 |
| siteName | Merchant site where payment is initiated from | www.somesitename.com |
| claimId | Merchant unique claim identifier payment is made for | ABCDE-12345 |
| InvoiceNumber | Merchant unique Invoice number payment is made for | 34987 |
Merchant Refund Metadata
Some examples of Refund meta data:
| Field Name | Description | Sample value |
|---|---|---|
| Refund_ID | Merchants refund Identifier | 3456-4876 |
| Claim_ID | Claim ID the refund will go towards | ABCDF-12346 |
Transaction data
| Field Name | Description | Sample value |
|---|---|---|
| customer_name | Name of the customer, if any, associated with the transaction | John Smith |
| customer_email | Email address of the customer, if any, associated with the transaction | testcustomer@gmail.com |
| reporting_category | Categorization of transaction | charge |
| charge_created_utc | Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in UTC. | 2023-08-16 10:14:30 |
| payment_method_type | The type of payment method used in the related payment. | card |
| dispute_reason | Reason given by cardholder for dispute | fraudulent |
| shipping_address_postal_code | Postal code of the shipping address associated with this charge, if any | 123456 |
| currency | Three-letter ISO code for the currency in which the gross, fee and net amounts are defined | usd |
| created_utc | Time at which the balance transaction was created. Dates in UTC. | 2023-08-16 10:15:32 |
| available_on_utc | The date the balance transaction’s net funds will become available in the Stripe balance. Dates in UTC. | 2023-08-23 12:00:00 |
| gross | Gross amount of the transaction. Expressed in major units of the currency | 35.33 |
| net | Net amount of the transaction. Expressed in major units of the currency | 34.01 |
| fee | Fees paid for this transaction Expressed in major units of the currency | 1.32 |
| description | Payment description that will be useful to a Merchant to identify the payment | UI widget payment |
| card_brand | CCG merchant name, set up when the merchant is onboarded | Possible values:AMEX, CARTES_BANCAIRES, DINERS, DISCOVER, INTERAC, JCB, MASTERCARD, UNIONPAY, VISA, UNKNOWN |
| card_funding | CCG merchant name, set up when the merchant is onboarded | Possible values:CREDIT, DEBIT, PREPAID, UNKNOWN |
| processor | Who processed the transaction | STRIPE |
| payment_method_last4 | The last four of the payment method account/card number | 1234 |
Fee data
| Field Name | Description | Sample value |
|---|---|---|
| balance_transaction_created_at | Creation time of this balance transaction Dates in UTC. | 2024-04-02 08:22:00 |
| balance_transaction_reporting_category | Categorization of balance transaction | charge |
| balance_transaction_component | per_auth_fee | |
| event_type | The originating type of event | charge_authorized |
| activity_at | The time associated with this balance transaction. Dates in UTC. | 2024-04-01 23:37:00 |
| activity_interval_type | The transaction time interval | instant |
| activity_start_date | The transaction start time. Dates in UTC. | 2024-04-01 |
| activity_end_date | The transaction end time. Dates in UTC. | 2024-04-01 |
| amount | Amount of the transaction in major units | 25.000000 |
| balance_transaction_description | Description of the transaction | SALE Transaction |
| card_address_postal_code | Postal code of the card address | 12345 |
| automatic_payout_effective_at | The expected automatic payout date. Dates in UTC. | 2024-04-03 00:05:00:00 |
| card_country | The two-letter ISO country code | US |
statement_descriptor
Merchant Payout report
The Merchant Payout report is a comprehensive reconciliation report designed specifically for merchants. It serves as a detailed record that outlines fund transfers made to the merchant's bank account. This report includes important information such as the date, amount, currency, payment and refund metadata, the total sum of fees deducted, etc.
This report is generated daily, providing information up until the previous day. For example, if the report is triggered on June 11th, 2024, the timestamp range will cover from June 10th, 2024 00:00:00 UTC to June 11th, 2024 00:00:00 UTC. The time it takes for a transaction to appear in the payout report varies depending on the transaction type. Typically, a sale may take up to 24 hours to be reflected, while authorizations may take longer, depending on the capture date.
The file will be delivered on a daily basis between 11:00 and 16:00 UTC via ECG.
It includes three types of data specified above:
Report name format:
<ccg-merchant-id>_<report-source>_<report-name>_<yyyymmdd>.csv where
ccg-merchant-id is what CCG will provide after configuration. Example: 44387763-4eeb-4592-a564-b10aadee95be
report-source is the source where the report was generated. In this case: CCG
Report-name is type of report. In this case: MERCHANT_DAILY_PAYOUT_TRANSACTION
Example: 1729eb88-619a-49d0-8780-a04e79243337_CCG_MERCHANT_DAILY_PAYOUT_TRANSACTION_20231204.csv
Report Example
Combined Payout report
Combined Payout report merges all Merchant Payout reports into a single file. This file is delivered to treasury for reconciliation and contains all the Merchants that CCG services has under the UHC Entity such as Rx, UHC, Solutran, etc.
This report is generated on a daily basis, being triggering for a date two days prior. For example, if the report is triggered on June 11th, 2024, the timestamp range will be set from June 9th, 2024 00:00:00 UTC to June 10th, 2024 00:00:00 UTC. Please note that this report will be delivered 24 hours after the Merchant Payout report.
The file will be delivered on a daily basis between 11:00 and 16:00 UTC via ECG.
It includes:
Report name format:
<report-name>_<yyyymmdd>.csv where
Report-name is type of report. In this case: CCG_Treasury_CombinedPayout
Example: CCG_Treasury_CombinedPayout_20231202.csv
Report Example
Stripe_Treasury_CombinedPayout_20230824.csv
Transaction-Level Fee report
Transaction-Level Fee report is a comprehensive document that provides a detailed breakdown of all fees associated with transactions within a given date range.
This report is generated on a daily basis, with the latest possible triggering date being three days prior. For example, if the report is triggered on June 11th, 2024, the timestamp range will be set from June 7th, 2024 00:00:00 UTC to June 8th, 2024 00:00:00 UTC. Please note that there will be a time difference of 48 to 72 hours between this report and the Payout report if we want to see the broken down fees for a charge reflected in the Payout report.
The file will be delivered on a daily basis between 11:00 and 16:00 UTC via ECG.
This transaction-level fee report is specific to a Merchant. It includes all four types of data specified above:
This report will not be enabled by default. Merchant should request enabling it. The reports will be delivered to merchant ECG location.
Report name format:
<ccg-merchant-id>_<report-source>_<report-name>_<yyyymmdd>.csv where
ccg-merchant-id is what CCG will provide after configuration. Example: f09af645-6e53-4a97-a209-ddfb0c846ccd
report-source is the source where the report was generated. In this case: CCG
Report-name is type of report. In this case: MERCHANT_DAILY_TRANSACTION_LEVEL_FEE_REPORT
Example: f09af645-6e53-4a97-a209-ddfb0c846ccd_CCG_MERCHANT_DAILY_TRANSACTION_LEVEL_FEE_REPORT_20240401.csv
f09af645-6e53-4a97-a209-ddfb0c846ccd_CCG_MERCHANT_DAILY_TRANSACTION_LEVEL_FEE_REPORT_20240401.csv