The Payment Report provides combined data for individual Payments and Payment Instances.
Note: A single Payment will show up more than once in this report if it has multiple Payment Instances.
| Term | Definition | Field Type | Sample |
| Payment ID | A unique ID provided by CDCO for a specific Payment | Integer | 12345 |
| CRID | A unique ID provided by CDCO for a specific Payment Instance | String | MMU-17352 |
| Client Unique Id | A unique value provided by the client during payment creation. This value is optional. | String | 123abc |
| Amount | The total amount of the Payment | Currency | $50 |
| Payment Status | The current status of the Payment Possible Values: Not Started - Payment is in a review state, and processing has not started Awaiting Customer - Notification(s) has been sent to customer to choose their payment method or redeem their digital payment In Progress - The Payment's initial Payment Instance is currently in fulfillment and will be sent soon Complete - Fulfillment of the initial Payment Instance has been completed Failed - The payment failed during processing Canceled - Payment was canceled by the client before it was funded or processed |
Enum | Not Started |
| Payment Instance Status | The current status of the Payment Instance Possible Values: Not Started - Payment Instance is in a review state and processing has not started Fulfillment In Progress - Payment Instance has been sent to fulfillment and has not yet been mailed Sent - Payment Instance has been mailed or emailed to the Recipient Claimed - Payment Instance has been cashed or deposited; only available for checks, ACH, PayPal, and Venmo payments Void Requested - Someone has requested to reissue the Payment Instance, and the request is pending client approval Voided - Payment Instance has been reissued or refunded after it was issued to the recipient Failed - Payment Instance failed during processing Canceled - Payment was canceled before it was issued to the recipient |
String | Claimed |
| Name | Name of the recipient (if applicable) | String | Bill Smith |
| Company Name | Company name of the recipient (if applicable) | String | Bob's LLC |
| Email address of the recipient (if applicable) | test@example.com | ||
| Created | The timestamp for when the payment was created. | Medium Date and Time: dd/mmm/yyyy HH:MM AM/PM | 28 Dec 2023 7:31 AM |
| Submitted | The timestamp the payment was submitted for processing. | Medium Date and Time: dd/mmm/yyyy HH:MM AM/PM | 28 Dec 2023 7:33 AM |
| Fulfilled | The timestamp for when the Payment Instance is fulfilled (i.e. sent to the recipient). | Medium Date and Time: dd/mmm/yyyy HH:MM AM/PM | 30 Dec 2023 9:22 AM |
| Claimed | The date the Payment Instance was cashed or confirmed to be deposited into the customer's account. Due to data availability, this date is only available for checks, PayPal, Venmo, and ACH payments. | Medium Date and Time: dd/mmm/yyyy HH:MM AM/PM | 4 Jan 2024 9:05 AM |
| Program | The program that the payment was created under | Enum | My Metro Utility Direct Program |
| Batch | Batch name the payment was created under | String | My Metro Utility Direct Program-20231228-14:31:42 |
| Payment Method | The payment method used to issue the payment to the customer. | String | Virtual Prepaid Mastercard |
| Payment Channel | The method of delivery of the Payment Instance. Digital - Online delivery, such as ACH, digital prepaid card, digital merchant/gift card, Venmo/PayPal Physical - Mailed delivery, such as check, physical prepaid card, physical merchant/gift card |
Enum | Digital |
| Check Number | A unique number printed on a check. Only available for Payment Instances issued via paper check. | Integer | 341079 |
| Is Reissue Payment | Indicates if this payment is the result of a reissue | Boolean | Yes |
| Is Fallback Payment | This applies to Choice and SurePay Direct programs only, and it indicates if this payment was issued as a fallback payment because the customer didn't confirm their payment within the timeframe designated on the program. | Boolean | No |
| Is Backup Payment | Indicates if this payment was a backup payment for a failed digital direct payment (i.e. ACH or PayPal/Venmo) | Boolean | No |
| Replaces Payment Instance | The CRID value of the Payment Instance that was replaced by this Payment Instance | String | MMU-12345 |
Updated December '24