When merchants require customized reports, such as retrieving all the charges paid out during a specific period like June, Tap Payments' APIs offer a streamlined way to gather this data.

Use Case

This use case is to generate all paid out charges during a specific month

Step 1: List All Payouts during a specific month

Use the 'List All Payouts' API:

• Send a request to the 'List All Payouts' API.
• Specify the date range for this specific month in your request parameters. This will filter the payouts to only include those processed within this period.
• The API response will include all payout IDs for the specified date range.

Step 2: Retrieve individual Payouts

From the API response in step 1, extract the payout IDs.

Use the download Payout API:

• Add the payout IDs to the request body of the download payout API
• This API will return detailed information on each payout, including all charges paid out in the specified month.

Step 3: Compile and Review the Data

Organize Data:

• Compile the information from the individual payout downloads into a single report.
• This report will include all the charges processed and paid out in the specified month.

Review:

• Verify that all relevant data has been included.
• Ensure the report meets your customization requirements.