Skip to main content

paymentsSummary

How the merchant was paid over a period: captured volume, charges, what they were left with, refunds, the same figures per processor and per rail, and the next money due into their bank account.

**Returns:**

The period's figures. A period with no payments comes back with zeroes and empty breakdowns rather than as an error — a quiet month is an answer.

paymentsSummary(
  period: PaymentsPeriodInput!
): PaymentsSummary!

Arguments​

paymentsSummary.period ● PaymentsPeriodInput! non-null input​

The span of days to count, both ends included, in UTC.

Type​

PaymentsSummary object​

How a merchant was paid over a period: the headline figures a dashboard shows, the same figures broken down by processor and by rail, and the next money due into their bank account.