Skip to main content

PaymentsSummary

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.

type PaymentsSummary {
  period: PaymentsPeriod!
  settledVolume: Money!
  feeTotal: Money!
  netTotal: Money!
  refundTotal: Money!
  paymentCount: Int!
  feeRatePercent: Float!
  methodMix: [MethodMixEntry!]!
  gatewaySplit: [GatewaySplitEntry!]!
  nextPayout: Payout
}

Fields​

PaymentsSummary.period ● PaymentsPeriod! non-null object​

The span of days these figures cover.

PaymentsSummary.settledVolume ● Money! non-null object​

What was captured in the period, before charges and before refunds.

PaymentsSummary.feeTotal ● Money! non-null object​

What the processors charged the merchant for taking it.

PaymentsSummary.netTotal ● Money! non-null object​

What the merchant is left with: captured, less charges, less anything refunded. This is the figure that reconciles with the payouts.

PaymentsSummary.refundTotal ● Money! non-null object​

How much of the captured volume went back to customers.

PaymentsSummary.paymentCount ● Int! non-null scalar​

How many payments the merchant took in the period.

PaymentsSummary.feeRatePercent ● Float! non-null scalar​

Charges as a percentage of captured volume, between 0 and 100. Zero when the period captured nothing.

PaymentsSummary.methodMix ● [MethodMixEntry!]! non-null object​

The same period, one entry per way of paying that was used. A rail with no payments in the period is absent rather than reported as zero.

PaymentsSummary.gatewaySplit ● [GatewaySplitEntry!]! non-null object​

The same period, one entry per processor that took a payment.

PaymentsSummary.nextPayout ● Payout object​

The next money due into the merchant's bank account, or null when every payout has already landed. It is the soonest payout that has not landed, whatever period was asked for — a merchant reading a summary of June still wants to know when they are next paid.

Returned By​

paymentsSummary query