settlements

QUERY

Returns settlements.

Arguments

query

SqlQuery

The query to filter the settlements with based on Pay Theory defined data.

limit

Int

The number of settlements to return.

offset

String

The value of the offset item for which the list is being sorted.

direction

MoveDirection

The direction of the pagination. Makes sure the results are returned in the correct order.

Values

BACKWARDFORWARD

offset_id

String

The settlement_batch of the offset item.

Response

Settlements

items

[Settlement]| null

List of items.

total_row_count

Int| null

Total number of rows matching the query.

Examples

List settlements for a merchant

Shows the status, settlement date, transfer date, and net amount for each batch.

SUCCESS 200

GRAPHQL

query Settlements($query: SqlQuery, $limit: Int) {
  settlements(query: $query, limit: $limit) {
    items {
      merchant_uid
      settlement_batch
      settlement_date
      currency
      status
      settlement_type
      transaction_debit_count
      transaction_reversal_count
      transfer_date
      gross_amount_64bit
      net_amount_64bit
    }
    total_row_count
  }
}