Zuper Pay Payment Summary Report

post

https://{dc-region}.zuperpro.com/api/reports/zuper_pay/payment_summary

Generate a comprehensive zuper pay payment summary report with detailed filtering options

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

from_date

string

required

Start date (YYYY-MM-DD)

to_date

string

required

End date (YYYY-MM-DD)

date_type

string

Defaults to scheduled_date

skip_date_range

boolean

Defaults to false

include_uid

string

Specific payment UIDs to include (comma-separated)

filter_rules

string

Advanced filter rules JSON

filter.payment_status

string

Payment status (succeeded/failed/pending/cancelled)

filter.payment_method

string

Payment methods (card/bank_transfer/wallet)

filter.customer

string

Customer UIDs (comma-separated)

filter.job

string

Job UIDs (comma-separated)

filter.invoice

string

Invoice UIDs (comma-separated)

filter.amount_min

number

Minimum payment amount

filter.amount_max

number

Maximum payment amount

filter.currency

string

Payment currency (USD/EUR/GBP)

filter.refund_status

string

Refund status (pending/processed/failed)

filter.chargeback_status

string

Chargeback status (pending/won/lost)

filter.payout_status

string

Payout status (pending/processed/failed)

filter.created_at

string

Filter by creation date

filter.updated_at

string

Filter by update date

filter.payment_date

string

Filter by payment date

filter.refund_date

string

Filter by refund date

filter.chargeback_date

string

Filter by chargeback date

filter.payout_date

string

Filter by payout date

filter.transaction_id

string

Transaction IDs (comma-separated)

filter.payment_intent_id

string

Payment intent IDs (comma-separated)

filter.refund_id

string

Refund IDs (comma-separated)

filter.chargeback_id

string

Chargeback IDs (comma-separated)

filter.payout_id

string

Payout IDs (comma-separated)

filter.fee_amount_min

number

Minimum fee amount

filter.fee_amount_max

number

Maximum fee amount

filter.net_amount_min

number

Minimum net amount

filter.net_amount_max

number

Maximum net amount

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Zuper Pay Payment Summary report generated successfully

400Bad request - Invalid parameters

401Unauthorized - Missing or invalid authentication