payors

QUERY

Returns payors.

Arguments

query

SqlQuery

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

limit

Int

The number of payors 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 payor_id of the offset item.

Response

Payors

items

[Payor]| null

List of Payors.

total_row_count

Int| null

Total number of rows matching the query.

Examples

List payors

Lists payors for a merchant with a SqlQuery filter.

SUCCESS 200

GRAPHQL

query Payors($query: SqlQuery, $limit: Int) {
  payors(query: $query, limit: $limit) {
    items {
      payor_id
      merchant_uid
      full_name
      email
      phone
      address_line1
      city
      region
      postal_code
      country
    }
    total_row_count
  }
}