authorizations

QUERY

This query will return a list of authorizations for a merchant.

Arguments

query

SqlQuery

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

limit

Int

The number of authorizations to return.

offset

String

The value of the offset item for which the list is being sorted. If the direction is FORWARD, the offset item is the last item in the previous list. If the direction is BACKWARD, the offset is the first item in the previous list.

direction

MoveDirection

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

Values

BACKWARDFORWARD

offset_id

String

The authorization_id of the offset item. If the direction is FORWARD, the offset item is the last item in the list. If the direction is BACKWARD, the offset is the first item in the list.

Response

Authorizations

items

[Authorization]| null

List of Authorizations.

total_row_count

Int| null

Total number of rows matching the query.

Examples

List authorizations for a merchant

Filters on merchant_uid. transaction_id stays null until the authorization is captured.

SUCCESS 200

GRAPHQL

query Authorizations($query: SqlQuery, $limit: Int) {
  authorizations(query: $query, limit: $limit) {
    items {
      authorization_id
      merchant_uid
      amount
      currency
      status
      fee_mode
      fees
      authorization_date
      expiration_date
      transaction_id
    }
    total_row_count
  }
}