Credit payments - export
Dive into the world of credit payments with the Credit Payments Export, tracking every credit payment action and its details.
Definition
The Credit Payments Export section provides insights into credit payments, encompassing the use of outstanding credit balances to pay invoices. This export not only covers standard credit payments but also records write-offs, credit balance removals, and credit payments subsequently refunded as cash transactions. It becomes visible and populated if you have enabled the Credit Invoices feature on your Recurly site.
Filters
Action Filter
The Credit Payments export can be pre-filtered in the Admin Console based on the Action taken. The available credit payment actions include:
| Action | Description |
|---|---|
| All of the below | All descriptions below. |
| Gift Card | Similar to a normal credit payment, but the credit invoice's amount originates from a "gift_card." Useful for tracking invoices paid with gift card credit. |
| Payment | A normal credit payment that utilizes all or a portion of a credit invoice balance to pay a charge invoice. |
| Reduction | Removes a credit balance from a credit invoice. Use this action to identify all credits "deleted" from an account and check the corresponding original invoice status to see if it resulted in a voided credit invoice or a closed credit invoice. |
| Refund | Applied when a credit payment is refunded as a refund transaction. This event generates a new credit payment that records the original credit payment's ID and the new refund transaction's ID. |
| Write-Off | Used to transfer the balance of a write-off invoice to a failed invoice, reducing the latter's balance to zero. |
Date Range Filters
Created
Lists all credit payments created within the selected timeframe.
Modified
Lists all credit payments modified during the selected timeframe. A credit payment's modified_at value is set upon creation and only updates when the credit payment is voided (voided_at value set) due to the invoice it was applied to being failed.
Exports table
To help you identify and organize information effectively, the export provides a structured table that contains the following columns:
| Column Name | Example | Description | Data type (size) |
|---|---|---|---|
| id | 41872c1bf4bcfcd5658d86401194f63b | The unique id of the credit payment. | varchar(32) |
| created_at | 2017-12-02 17:58:09 UTC | The date and time the credit payment was created. | timestamp |
| modified_at | 2017-12-02 17:58:09 UTC | The date and time the credit payment was modified, which would be when it was created or voided. | timestamp |
| voided_at | 2017-12-02 17:58:09 UTC | The date and time the credit payment was voided due to the applied invoice being failed. | timestamp |
| action | payment, gift_card, write_off, reduction, refund | The action that resulted in the credit payment being created. See action filter table above for details. | string |
| currency | USD | The currency of the credit payment amount. | varchar(3) |
| amount | 54.38 | The amount of the credit payment, which will always be positive. | numeric |
| original_invoice_billed_date | 2017-12-02 17:58:09 UTC | The date the credit invoice the credit payment came from was issued. | timestamp |
| original_invoice_status | open, processing, closed, voided | The current status of the credit invoice the credit payment came from. This is helpful to identify voided vs. closed credit invoices for reduction action credit payments. | varchar(20) |
| original_invoice_number | 1008 | The invoice number of the credit invoice the credit payment came from. | string |
| applied_to_invoice_number | 1005 | The invoice number the credit payment was applied to. | string |
| original_credit_payment_id | 775a2e6d1f90f8a8e79c584106b7418d | The unique id of the credit payment the refund action credit payment is refunding. | varchar(32) |
| refund_transaction_id | 775a2e675e4080fd31d558489da7de12 | The unique id of the new refund transaction the refund action credit payment is transferring value to. | varchar(32) |
| credit_payment_api_id | e28zov4fw0v2 | Credit Payment API ID | string |
Version Changelog
Version 3 - 4/1/2025
- Corrected issue appending the prefix to original_invoice_number and applied_to_invoice_number columns
Version 2 - 2/5/2025
- Addition of
credit_payment_api_id.
Updated about 1 month ago