merchants

QUERY

Returns merchants.

Arguments

query

SqlQuery

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

limit

Int

The number of merchants 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 merchant_uid of the offset item.

Response

Merchants

items

[ListMerchant]| null

List of Merchants.

total_row_count

Int| null

Total number of rows matching the query.

Examples

List merchants

Lists the merchants scoped to your access.

SUCCESS 200

GRAPHQL

query Merchants($limit: Int) {
  merchants(limit: $limit) {
    items {
      merchant_uid
      merchant_name
      card_active
      ach_active
      cash_active
      country_code
      parent_merchant_uid
    }
    total_row_count
  }
}