Settlement

One payment the merchant took: what was captured, on which rail, what the processor kept, and how much of it has since gone back to the customer.

type Settlement {
  payout: Payout
  id: ID!
  gateway: PaymentGateway!
  method: PaymentMethod!
  status: SettlementStatus!
  capturedAt: DateTime!
  grossAmount: Money!
  feeAmount: Money!
  netAmount: Money!
  refundedAmount: Money!
  order: Order!
}

Fields

Settlement.payout ● Payout object

The payout this payment was included in.

**Returns:**

The payout, or null when the payment has not been batched into one yet — which is the normal state of a payment taken today.

Settlement.id ● ID! non-null scalar

The stable identifier of this payment, unique across every merchant.

Settlement.gateway ● PaymentGateway! non-null enum

The processor that took the money.

Settlement.method ● PaymentMethod! non-null enum

How the customer paid.

Settlement.status ● SettlementStatus! non-null enum

Where this payment has reached.

Settlement.capturedAt ● DateTime! non-null scalar

When the money was taken, in UTC.

Settlement.grossAmount ● Money! non-null object

What the customer paid.

Settlement.feeAmount ● Money! non-null object

What the processor charged the merchant for taking it. Charged on the capture, and not returned when the payment is refunded.

Settlement.netAmount ● Money! non-null object

What the merchant earned on the capture: the amount less the processor's charge. It does not account for anything refunded afterwards.

Settlement.refundedAmount ● Money! non-null object

How much has gone back to the customer — by refund, or because a dispute was decided against the merchant. Zero for most payments.

Settlement.order ● Order! non-null object

The order this payment paid for.

Returned By

settlement query

Member Of

Dispute object ● Order object ● SettlementConnection object ● SettlementEdge object