Sample Flows

This article presents possible use cases your app could support and provides sample flows as a starting point for your implementation.

Generate monthly transaction report

Merchants need to reconcile their accounts by generating monthly reports showing all transactions. This report helps with accounting and financial record-keeping.

To generate the report:

1. Determine the reporting period:

   • Set the start date to the first day of the month
   • Set the end date to the last day of the month

2. Call Transactions List with:

   • from set to the start date
   • to set to the end date

3. Process the results:

   • Filter for specific payment methods if needed (for example, credit cards)
   • Export transaction data (date, amount, status, payment method) to CSV or your accounting system
   • Calculate totals for successful transactions
   • Flag any failed or refunded transactions for review

Monitor transactions from a specific payment provider

Monitoring transactions from a specific payment provider helps identify performance issues and troubleshoot problems. This is useful when you need to analyze provider-specific transaction patterns or success rates.

To monitor provider transactions:

1. Identify the provider you want to monitor:

   • Get the provider ID from a previous transaction's provider field
   • Or use a known provider identifier (e.g., "stripe", "paypal")

2. Call Transactions List with:

   • paymentProvider query parameter set to the provider ID
   • Optionally add from and to date range filters to limit results

3. Analyze the returned transaction data:

   • Review transaction statuses to identify patterns
   • Calculate success rate for the provider
   • Identify any recurring errors or issues