Skip to main content

settlements

The merchant's payments, most recently captured first, as a cursor connection.

**Returns:** One page of payments for the acting merchant.

settlements(
  first: Int
  after: String
  last: Int
  before: String
  gateway: PaymentGateway
  method: PaymentMethod
  status: SettlementStatus
): SettlementConnection!

Arguments​

settlements.first ● Int scalar​

Returns the first _n_ elements from the list.

settlements.after ● String scalar​

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

settlements.last ● Int scalar​

Returns the last _n_ elements from the list.

settlements.before ● String scalar​

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

settlements.gateway ● PaymentGateway enum​

Restricts the page to one processor. Omit it for every processor.

settlements.method ● PaymentMethod enum​

Restricts the page to one way of paying. Omit it for every way.

settlements.status ● SettlementStatus enum​

Restricts the page to payments in this state. Omit it for every state.

Type​

SettlementConnection object​

A connection to a list of items.