[FEATURE] Analytics for payouts

[kashif-m]

Feature Description

APIs There is no provision for listing / filtering payout transactions processed via HyperSwitch. This needs to be implemented for analytical processing for payouts.

• List API helps in listing payouts based on generic constraints

• Filter API helps in filtering payouts based on payout specific filters

Dashboard Analytics There are two tables for core payout operations

• payouts
• payout_attempt

The information regarding payouts and the attempts are stored in respective tables. For fetching all the information, there needs to be 2 DB calls for gathering entire context. As of writing this issue, Hyperswitch's dashboard can read data only from a single table in CKH.

As a temporary measure, all the required fields are to be moved to a single table.

Possible Implementation

List API to include below constraints (similar to payments)

• customer_id
• starting_after
• ending_before
• limit
• created
• created_lt
• created_gt
• created_lte
• created_gte

Filter API to include below filters

• payout_id
• profile_id
• customer_id
• limit
• offset
• time_range
• connector
• currency
• status
• payout_method
• entity_type

Below columns are to be added in payout_attempt

• payout_type
• amount
• destination_currency
• source_currency
• recurring
• entity_type

Have you spent some time checking if this feature request has been raised before?

• [X] I checked and didn't find a similar issue

Have you read the Contributing Guidelines?

• [X] I have read the Contributing Guidelines

Are you willing to submit a PR?

Yes, I am willing to submit a PR!