Skip to main content

Payout

One transfer of money from a processor into the merchant's bank account, covering a batch of payments.

type Payout {
  settlements(
    first: Int
    after: String
    last: Int
    before: String
  ): SettlementConnection!
  id: ID!
  gateway: PaymentGateway!
  payoutDate: Date!
  status: PayoutStatus!
  settlementCount: Int!
  amount: Money!
}

Fields​

Payout.settlements ● SettlementConnection! non-null object​

The payments this payout covers, most recently captured first, as a cursor connection.

**Returns:** One page of the payments in this batch.

Payout.settlements.first ● Int scalar​

Returns the first _n_ elements from the list.

Payout.settlements.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

Payout.settlements.last ● Int scalar​

Returns the last _n_ elements from the list.

Payout.settlements.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

Payout.id ● ID! non-null scalar​

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

Payout.gateway ● PaymentGateway! non-null enum​

The processor that sent the money.

Payout.payoutDate ● Date! non-null scalar​

The day the money reaches the merchant's account, or is expected to, in UTC.

Payout.status ● PayoutStatus! non-null enum​

Whether the money has landed yet.

Payout.settlementCount ● Int! non-null scalar​

How many payments are in this batch.

Payout.amount ● Money! non-null object​

What lands in the merchant's account: every payment in the batch, less what the processor charged on each, less anything refunded from them.

Member Of​

PaymentsSummary object ● PayoutConnection object ● PayoutEdge object ● Settlement object