merchant

QUERY

Returns merchant.

Arguments

merchant_uid

String

The merchant_uid of the merchant to query.

merchant_name

String

The name of the merchant to query.

Response

Merchant

ach_active

Boolean| null

If the merchant has successfully completed onboarding and has an ACH processor active.

api_key

String| null

The API key of the merchant. This is used to authenticate use of the PayTheory Web and Native SDKs.

card_active

Boolean| null

If the merchant has successfully completed onboarding and has a card processor active.

cash_active

Boolean| null

If the merchant has successfully completed onboarding and has a cash processor active.

country_code

String| null

The country code of the country the merchant operates from.

fee_matrix

FeeMatrix| null

The fee matrix that the merchant is using. This is used to calculate the fees that are charged to the payor.

fee_modelDeprecated

FeeModel| null

-

is_system

Boolean| null

If the merchant is a system merchant. System merchants are merchants that also have sub merchants.

max_transaction_amount

Int| null

Maximum card or ACH payment total in cents, including service fees. Zero or null means no merchant maximum.

merchant_name

String| null

The name of the merchant.

merchant_uid

String| null

The Pay Theory unique identifier assigned to the merchant.

metadata

AWSJSON| null

The metadata that has been set on the Merchant.

parent_merchant_uid

String| null

The merchant_uid of the parent merchant. This is only set if the merchant is a sub merchant of a system merchant.

settings

MerchantSettings| null

The settings that the merchant has set.

submitted_onboarding

Boolean| null

Whether the merchant has submitted their onboarding information.

Examples

Get a merchant

Gets one merchant by merchant_uid.

SUCCESS 200

GRAPHQL

query Merchant($merchant_uid: String) {
  merchant(merchant_uid: $merchant_uid) {
    merchant_uid
    merchant_name
    card_active
    ach_active
    cash_active
    max_transaction_amount
    country_code
    settings {
      contact_email
      website
    }
  }
}