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

Settlement.id ● ID! non-null scalar

Settlement.status ● SettlementStatus! non-null union

Settlement.amount ● Money! non-null scalar

The amount paid to the destination

Settlement.destination ● Beneficiary! non-null union

The destination of the settlement

Settlement.reference ● String! non-null scalar

The destination reference

Settlement.paymentInitiations ● PaymentInitiationConnection! non-null object

The payment initiations that are included in this settlement

Settlement.paymentInitiations.first ● UInt scalar

Specifies the maximum number of results to return

Settlement.paymentInitiations.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Settlement.paymentInitiations.before ● Cursor scalar

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

Settlement.paymentInitiations.after ● Cursor scalar

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

Settlement.paymentInitiationRequests ● PaymentInitiationRequestConnection! non-null object

The payment initiation requests that are included in this settlement

Settlement.paymentInitiationRequests.first ● UInt scalar

Specifies the maximum number of results to return

Settlement.paymentInitiationRequests.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Settlement.paymentInitiationRequests.before ● Cursor scalar

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

Settlement.paymentInitiationRequests.after ● Cursor scalar

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

Settlement.directDeposits ● DirectDepositConnection! non-null object

The direct deposits that are included in this settlement

Settlement.directDeposits.first ● UInt scalar

Specifies the maximum number of results to return

Settlement.directDeposits.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Settlement.directDeposits.before ● Cursor scalar

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

Settlement.directDeposits.after ● Cursor scalar

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

Settlement.transactions ● PaymentTransactionConnection! deprecated non-null object

⚠️ DEPRECATED

No longer supported

Transactions that are included in this settlement

Settlement.transactions.first ● UInt scalar

Specifies the maximum number of results to return

Settlement.transactions.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Settlement.transactions.before ● Cursor scalar

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

Settlement.transactions.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.