Filtering Transactions in Subscribe
The filters allow you to search for a list of transactions you seek by filtering out unwanted results.
Pages associated with the billing menu typically include large volume of results. This is why they do not display results by default when you initially access them. Instead, the filtering screen lets you search for the required records. The search results appear for the page throughout the session.
Transaction Filtering Considerations
Use the following guidance and considerations to improve filtering performance:
- When filtering by multiple fields such as ID and Status, the displayed results displayed match both the ID AND the Status values you entered. Fields in which you type a value, filter for that value. A search for customer Pete Johnson, for example, will not return results for Peter Johnson. A search for customer Pete, will display results for Peter Johnson.
- The filtering screen includes key search fields, displayed with a light blue background for specific fields. At least one key search field (with a blue background) must be used in order to search.
- Filtering with multiple input details improves the list of returned results and the speed of their return. When filtering by the date range key field only, the search is limited to 90 days. When using multiple filtering input (regardless if key fields), the date range is unlimited.
- Up to 50,000 results will be displayed per search.
Transaction Filters
Field | Previous Naming (Portal 1.0) | Guidance | Relevancy |
---|---|---|---|
ID | Merchant Transaction ID | Your unique identifier for the Transaction. | Key field, at least one is required to filter. |
Status | Status | Select the
status of the relevant Transaction you're seeking. Select from:
| Optional |
Transaction Type | N/A | Select the type of transaction you're seeking whether One time or Recurring (subscription generated) Transaction. | Optional |
Account ID | Merchant Customer ID | Also known as Customer ID. Enter the unique identifier for an account associated with the Transaction. | Key field, at least one is required to filter. |
Account Name | Customer Name | Enter the Customer’s full name—typically corresponds to the name associated with the payment method on the account. | Optional |
Account Email | Customer Email | Enter the Email address of the customer account (associated with the transaction) in the typical format XXXX@example.com | Key field, at least one is required to filter. |
Payment Method Type | Payment Method Type | Select the relevant payment method from the dropdown list. Depending on the Payment Method Type selected, Subscribe displays additional information fields in which you must specify additional information. For a list of supported payment methods, see Account Payment Methods Pane. | Key field, at least one is required to filter. |
For Payment Method Type > Credit Card:
| Credit Card and Credit Card Number | Search by entering the following:
| Credit Card Number is a key field. The rest are Optional |
For Payment Method Type > Boleto:
| Boleto Fiscal Number | Enter the fiscal number that appears on the customer’s Boleto Bancário payment slip. This is a personal identification number per customer. | Key field, required in order to search by Boleto Payment Method |
For Payment Method Type > Carrier Billing:
| Enter the phone number associated with the carrier billing account (regular or encoded). | Key field, required in order to search by Carrier Billing Payment Method | |
For Payment Method Type > Direct Debit:
|
| Search by entering the following:
| |
For Payment Method Type > ECP:
|
| Search by entering the following:
| Account Number is a key field, required in order to search by ECP Payment Method |
For Payment Method Type > External Billing:
| N/A | Search by entering the following:
| External Billing ID is a key field, required in order to search by External Billing Payment Method |
For Payment Method Type > PayPal:
| PayPal Email Address | Enter the email address associated with the PayPal account. | PayPal Email is a key field, required in order to search by PayPal Payment Method |
Currency | N/A | Select the relevant Currency for the transaction you are seeking. | Optional |
Financial Account ID | N/A | See external Billing above. | Optional |
Subscription ID | AutoBill ID | Enter the unique identifier for the subscription associated with the transaction you're seeking (when available). | Key field, at least one is required to filter. |
Original Billing Date | Original Billing Date | The exact date or the date range of the scheduled billing date
for which this transaction collects funds (such as a
Subscription). Select Equals in the calendar picker to enter an exact date. Select Between to enter a date range. | Key field, at least one is required to filter. |
Billing Cycle | Billing Cycle | Enter the billing cycle of the Subscription sourcing the
Transaction you seek based on the Billing Plan defined. Note: 0
(zero) indicates an initial Billing Cycle; any number greater
than zero indicates a subsequent Billing Cycle. Select Equalsto enter an exact number. Select Between to enter a number range. | Optional |
Risk Score | Chargeback Risk | Enter the chargeback and fraud risk score of the Transaction you
are seeking. Select Equalsto enter an exact number. Select Between to enter a number range. | Optional |
Processor ID | The Processor ID is the transaction ID generated by the payment provider This serves as an additional ID for transaction. | Key field, at least one is required to filter. | |
SKU | The unique identifier of the product that is part of the transaction you seek | Optional | |
Include Validation Transactions | Include Validation Transactions | Toggle Yes to include validation Transaction that will not be captured for payment. | Default is No |
Created Date Between | Created Date Range | Define the date range during which the transaction was created. When filtering by the this field only, the search is limited to 90 days. When using multiple filtering input (regardless if key fields), the date range is unlimited. Use the Calendar picker to select your date range, or enter dates directly in the fields. | Key field, at least one is required to filter. |
How to Filter
To filter the page, do the following:
- Enter the relevant value by which you'd like to search in the key fields (blue background). You can also search by additional fields. Refer to the tables for guidance regarding the filter fields.
- Click Apply to filter the results.
A list of the results appears. If there is only one result, the details page opens immediately.
- To change the filter query, click Change Query and enter the relevant values.
- To clear your filter parameters, click Clear.