Billing Schedule Activity report
This report provides both summary and detailed views at the billing cycle level and can be used to monitor and review all managed billing cycle activities offered by merchants.
| Report type | Supported entity types | Supported file formats |
|---|---|---|
| Managed Billing |
|
|
Granularity
- Summary section: Combination of Plan Name, Plan ID , Billing Cycle Status, Number of Unique Profiles, Number of Unique Recurring Programs, Currency and Total Billing Amount.
- Details section: Combination of Consumer Profile ID, Processor Profile ID, Payment Method ID, Payment Account Number, Recurring Program ID, Merchant Order Number, Plan Name, Plan ID, Recurring Program Status, Billing Date, Currency Code, Next Billing Date, Firm Authorization Response Category Code, Payment Brand Auth Response, and Authorization Code
Fields
Summary
The following table shows the summary section field details.
| Field name | Description |
|---|---|
Record Type |
The section of the report. For the summary section, record type value is MBR0020. |
Plan Name |
The label for a payment program or contract offered by the merchant for products or services that include product pricing and billing frequency. |
Plan ID |
Unique identifier for a payment program or contract managed by the firm on behalf of the merchant for products or services that include product pricing and billing frequency. |
Billing Cycle Status |
Determines the current status of the billing schedule dependent on the payment processing outcome. Sample values:
|
Number of Unique Profiles |
Identifies a unique occurrence of a consumer's information maintained by the firm on behalf of the merchant. The consumer profile contains information relevant to processing transactions such as name, address, account and potentially information for multiple payment methods. |
Number of Unique Recurring Programs |
A firm generated identifier that connects a merchant's consumer to products or services offered by the merchant. The program (subscription) allows a consumer to receive products or services on a regular basis and be automatically charged on their preferred method of payment according to the chosen frequency. |
Currency |
Unique identifier for currencies, as assigned by the ISO 4217 specification. Alternatively, a currency code may also be a custom firm assigned value created where an ISO code does not exist. In this instance, the currency of the representment is being referenced. |
Total Billing Amount |
The monetary value of the transaction performed. |
Details
The following table shows the details section field details.
| Field name | Description |
|---|---|
Record Type |
The section of the report. For the details section, record type value is MBR0020. |
Transaction Processing Entity Identifier |
Unique entity identifier for transaction processing at the lowest level of the account hierarchy of the firm's microservices Application Program Interface (API) and events based payment processing platform that supports domestic and international merchants. This level organizes transaction types for submission, funding, and reporting. |
Consumer Profile ID |
Identifies a unique occurrence of a consumer's information maintained by the Firm on behalf of the merchant. The consumer profile contains information relevant to processing transactions such as name, address, account and potentially information for multiple payment methods. |
Processor Profile ID |
Unique identifier of a consumer's information maintained by the firm on behalf of the merchant. The consumer profile contains information relevant to processing transactions such as name, address, account and potentially information for multiple payment methods. In this case, the identifier was assigned by the firm's Client Profile System (CPS). |
Payment Method ID |
Unique identifier of the type of payment accepted by a level of the hierarchy of the merchant acquiring account. |
Payment Method Code |
The method used to pay for the exchange of money, goods or services between a merchant and their customer. Examples: Visa, MasterCard, PayPal, Bill Me Later etc. Also known with the Firm as method of payment or MOP. |
Payment Account Number |
Unique number of a financial account as assigned by the system of record when the account is created. This element includes the account number or loan number as presented to the customer. |
Recurring Program ID |
A firm generated identifier that connects a merchant's consumer to products or services offered by the merchant. The program (subscription) allows a consumer to receive products/services on a regular basis and be automatically charged on their preferred method of payment according to the chosen frequency. |
Recurring Program Description |
A textual description of a recurring payment program (subscription) by the merchant's consumer for products or services offered by merchant. The program (subscription) allows a consumer to receive products/services on a regular basis and be automatically charged on their preferred method of payment according to the chosen frequency. |
Merchant Order Number |
Unique merchant assigned identifier for the confirmation of goods and/or services purchased. The merchant order provides the merchant a reference to the prices, quantity and description of goods and/or services to be delivered for all transactions included in the sale. |
Plan Name |
The label for a payment program or contract offered by the merchant for products or services that include product pricing and billing frequency. |
Plan ID |
Unique identifier for a payment program or contract managed by the Firm on behalf of the merchant for products or services that include product pricing and billing frequency. |
Recurring Program Status |
The current standing of a recurring payment program (subscription) by the merchant's consumer for products or services offered by merchant. The program (subscription) allows a consumer to receive products/services on a regular basis and be automatically charged on their preferred method of payment according to the chosen frequency. |
Billing Cycle Sequence |
The sequence number of the billing cycle. A billing cycle is a period of time determined by the billing frequency unit and billing frequency count as defined on the recurring plan. In this context, this is the total number of billing cycles expected for the recurring program. |
Billing Date |
The year, month, day on which the consumer will be billed for the current billing cycle. |
Billing Cycle Start Date |
The year, month and day when the specified time interval used to calculate the billable activity for the account begins. Some examples of a billing period interval are cycle (same day number each calendar month), daily or bi-weekly. |
Billing Cycle End Date |
The year, month and day when the specified time interval used to calculate the billable activity for the account ends. Some examples of a billing period interval are cycle (same day number each calendar month), daily or bi-weekly. |
Billing Cycle Status |
The current status of the billing schedule dependent on the payment processing outcome. Sample values:
|
Currency Code |
Unique identifier for currencies, as assigned by the ISO 4217 specification. Alternatively, a currency code may also be a custom firm assigned value created where an ISO code does not exist. In this instance, the currency of the representment is being referenced. |
Total Billing Amount |
The monetary value of the transaction performed. |
First Payment Attempt Date |
For Adjustable Rate Loans (ARM) loans, the date of first payment adjustment. |
Number of Retries Attempted |
The number of payment retries that have been attempted for the current billing cycle. |
Number of Retries Remaining |
The number of payment retries remaining for the current billing cycle. |
Latest Payment Attempt Date |
The year, month, day, hour, minute, and second of the last payment attempt for the current billing cycle. |
Next Billing Date |
The year, month and day when the first demand for payment (bill) is generated for the associated schedule. |
Firm Authorization Response Category Code |
The firm's representation of the authorization response category code. |
Firm Authorization Response Code |
The firm's representation of the authorization response code being sent back to the merchant during credit card authorization. |
Firm Authorization Response Description |
A verbose explanation of the firm's representation of the authorization response code being sent back to the merchant during credit card authorization. |
Payment Brand Auth Response |
The label /decode of the response being sent back to merchant from Authorization Engine during Credit Card authorization. (e. g. 00=Approved, 01=Referral to Issuer, 04=Pickup Card). |
Payment Brand Response Code Category |
The Payment Brand Authorization Response Code Category Response code category derived from payment brand authorization systems. Possible values:
|
Authorization Code |
Unique code generated by visa/mc for one or more related transactions every time a transaction is authorized. |
Merchant Order Number (O) |
The order number submitted by the merchant with the original sale. |
Merchant Order Description (O) |
Additional metadata information for order number submitted by the merchant with the original sale. |
Sample report configurations
The following samples help you get an idea of how to configure account updated reports.
CO/BU/TD/PE
The following request code block shows how to configure an account updated report for entityType = CO/BU/TD/PE.
{
"entityType": "CO",
"entityIds": [
"1234567"
],
"reportSections": [
{
"sectionReportTypeName": "Managed Billing",
"sectionTitle": "Billing Schedule Activity Summary",
"sectionReportTypeId": "3020",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "MBR0020"
},
{
"alias": "Plan Name",
"reportAttributeName": "Merchant Recurring Plan Name"
},
{
"alias": "Plan ID",
"reportAttributeName": "Recurring Plan Identifier"
},
{
"alias": "Billing Cycle Status",
"reportAttributeName": "Billing Schedule Status Name"
},
{
"alias": "Number of Unique Profiles",
"reportAttributeName": "Consumer Profile Identifier",
"aggregateOperationText": "distinctCount"
},
{
"alias": "Number of Unique Recurring Programs",
"reportAttributeName": "Recurring Program Identifier",
"aggregateOperationText": "distinctCount"
},
{
"alias": "Currency",
"reportAttributeName": "Representment Currency Code"
},
{
"alias": "Total Billing Amount",
"reportAttributeName": "Total Billing Amount",
"aggregateOperationText": "sum"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Report Type Name",
"filterAttributeCode": "IN (\"ACTIVITY\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Merchant Recurring Plan Name",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Billing Schedule Status Name",
"sortOrderCode": "asc"
}
]
},
{
"sectionReportTypeName": "Managed Billing",
"sectionTitle": "Billing Schedule Activity Details",
"sectionReportTypeId": "3020",
"sectionSelectedFields": [
{
"alias": "Record Type",
"constantValueText": "MBR0020"
},
{
"reportAttributeName": "Transaction Processing Entity Identifier"
},
{
"alias": "Consumer Profile ID",
"reportAttributeName": "Consumer Profile Identifier"
},
{
"alias": "Processor Profile ID",
"reportAttributeName": "Internal Consumer Profile Identifier"
},
{
"alias": "Payment Method ID",
"reportAttributeName": "Payment Method Identifier"
},
{
"reportAttributeName": "Payment Method Code"
},
{
"alias": "Payment Account Number",
"reportAttributeName": "Masked Account Number"
},
{
"alias": "Recurring Program ID",
"reportAttributeName": "Recurring Program Identifier"
},
{
"alias": "Recurring Program Description",
"reportAttributeName": "Recurring Program Description Text"
},
{
"reportAttributeName": "Merchant Order Number"
},
{
"alias": "Plan Name",
"reportAttributeName": "Merchant Recurring Plan Name"
},
{
"alias": "Plan ID",
"reportAttributeName": "Recurring Plan Identifier"
},
{
"alias": "Recurring Program Status",
"reportAttributeName": "Recurring Program Status Code"
},
{
"reportAttributeName": "Billing Cycle Sequence"
},
{
"alias": "Billing Date",
"reportAttributeName": "Current Billing Date"
},
{
"alias": "Billing Cycle Start Date",
"reportAttributeName": "Billing Period Start Date"
},
{
"alias": "Billing Cycle End Date",
"reportAttributeName": "Billing Period End Date"
},
{
"alias": "Billing Cycle Status",
"reportAttributeName": "Billing Schedule Status Name"
},
{
"alias": "Currency Code",
"reportAttributeName": "Representment Currency Code"
},
{
"alias": "Total Billing Amount",
"reportAttributeName": "Total Billing Amount"
},
{
"alias": "First Payment Attempt Date",
"reportAttributeName": "First Payment Adjustment Date"
},
{
"reportAttributeName": "Number of Retries Attempted"
},
{
"reportAttributeName": "Number of Retries Remaining"
},
{
"alias": "Latest Payment Attempt Date",
"reportAttributeName": "Last Payment Timestamp"
},
{
"alias": "Next Billing Date",
"reportAttributeName": "Billing Schedule Date"
},
{
"reportAttributeName": "Firm Authorization Response Category Code"
},
{
"reportAttributeName": "Firm Authorization Response Code"
},
{
"alias": "Firm Authorization Response Description",
"reportAttributeName": "Firm Authorization Response Code Description Text"
},
{
"alias": "Payment Brand Auth Response",
"reportAttributeName": "Authorization Response Name"
},
{
"alias": "Payment Brand Response Code Category",
"reportAttributeName": "Payment Brand Authorization Response Category Code"
},
{
"reportAttributeName": "Authorization Code"
}
],
"sectionFilterAttributeList": [
{
"reportAttributeName": "Report Type Name",
"filterAttributeCode": "IN (\"ACTIVITY\")"
}
],
"sectionSortOrderList": [
{
"reportAttributeName": "Merchant Recurring Plan Name",
"sortOrderCode": "asc"
},
{
"reportAttributeName": "Billing Schedule Status Name",
"sortOrderCode": "asc"
}
]
}
],
"fileDelimiter": ",",
"reportConfigurationName": "Billing Schedule Activity Report",
"reportFileName": "Billing Schedule Activity Report.<Processing Entity ID>.<Report Type>.<frequency>.<From Date YYYY-MM-DD>.<To Date YYYY-MM-DD>",
"reportHeader": "<Processing Entity ID>,<Report Type>,<frequency>,<From Date YYYY-MM-DD>,<To Date YYYY-MM-DD>,<Generation Date YYYY-MM-DD>,GenerationTime=<Generation Time HH:MM:SS>",
"fileHeader": "BEGIN,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"fileTrailer": "END,EntityId=<Processing Entity ID>,Frequency=<frequency>",
"csvColumnNameDisplayIndicator": true,
"reportConfigStatus": "active",
"frequencyConfig": {
"scheduleFrequency": "adhoc",
"reportingPeriodStartTimestamp": "2025-03-15 00:00:00",
"reportingPeriodEndTimestamp": "2025-04-04 00:00:00"
}
}