Skip to main content

Settlement

No description

type Settlement implements Node {
  id: ID!
  status: SettlementStatus!
  amount: Money!
  destination: Beneficiary!
  reference: String!
  paymentInitiations(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
  ): PaymentInitiationConnection!
  paymentInitiationRequests(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
  ): PaymentInitiationRequestConnection!
  directDeposits(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
  ): DirectDepositConnection!
  transactions(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
  ): PaymentTransactionConnection! @deprecated
}

Fields​

id ● ID! non-null scalar​

status ● SettlementStatus! non-null union​

amount ● Money! non-null scalar​

The amount paid to the destination

destination ● Beneficiary! non-null union​

The destination of the settlement

reference ● String! non-null scalar​

The destination reference

paymentInitiations ● PaymentInitiationConnection! non-null object​

The payment initiations that are included in this settlement

first ● UInt scalar​

Specifies the maximum number of results to return

last ● UInt scalar​

Specifies the maximum number of results to return for backwards pagination

before ● Cursor scalar​

Takes in the paging cursor. The next page of results will start after this cursor

after ● Cursor scalar​

Takes in the paging cursor. The previous page of results will start before this cursor

paymentInitiationRequests ● PaymentInitiationRequestConnection! non-null object​

The payment initiation requests that are included in this settlement

first ● UInt scalar​

Specifies the maximum number of results to return

last ● UInt scalar​

Specifies the maximum number of results to return for backwards pagination

before ● Cursor scalar​

Takes in the paging cursor. The next page of results will start after this cursor

after ● Cursor scalar​

Takes in the paging cursor. The previous page of results will start before this cursor

directDeposits ● DirectDepositConnection! non-null object​

The direct deposits that are included in this settlement

first ● UInt scalar​

Specifies the maximum number of results to return

last ● UInt scalar​

Specifies the maximum number of results to return for backwards pagination

before ● Cursor scalar​

Takes in the paging cursor. The next page of results will start after this cursor

after ● Cursor scalar​

Takes in the paging cursor. The previous page of results will start before this cursor

transactions ● PaymentTransactionConnection! deprecated non-null object​

DEPRECATED

No longer supported

Transactions that are included in this settlement

first ● UInt scalar​

Specifies the maximum number of results to return

last ● UInt scalar​

Specifies the maximum number of results to return for backwards pagination

before ● Cursor scalar​

Takes in the paging cursor. The next page of results will start after this cursor

after ● Cursor scalar​

Takes in the paging cursor. The previous page of results will start before this cursor

Interfaces​

Node interface​

An abstract datatype that has a locally unique identifier, allowing a given node to be later queried by id using the node(id: ID!) query.