splits

QUERY

Returns splits.

Arguments

query

SqlQuery

The query to filter the splits with based on Pay Theory defined data. Detailed information about the query object can be found here.

limit

Int

The number of splits 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 id of the offset item.

Response

Splits

items

[Split]| null

List of Splits.

total_row_count

Int| null

Total number of rows matching the query.

Examples

List splits for a merchant

Lists splits for a merchant. Filters on merchant_uid.

SUCCESS 200

GRAPHQL

query Splits($query: SqlQuery, $limit: Int) {
  splits(query: $query, limit: $limit) {
    items {
      id
      transaction_id
      amount
      currency
      account_code
      reference
      settlement_batch
      created_at
    }
    total_row_count
  }
}