createMerchant

MUTATION

Creates merchant.

Arguments

merchant_nameRequired

String

The name of the merchant to create.

parent_merchant_uid

String

The merchant_uid of the parent merchant. This is only set if the merchant belongs to another merchant account.

user

MerchantUserInput

The user that will be created for the merchant. This user will be given access to the onboarding form on Merchant creation.

metadata

AWSJSON

The metadata that will be set on the Merchant.

Response

ListMerchant

ach_active

Boolean| null

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

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.

is_system

Boolean| null

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

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.

submitted_onboarding

Boolean| null

Whether the merchant has submitted their onboarding information.

updated_row_at

AWSDateTime| null

The date the merchant was last updated.

Examples

Create a merchant

Creates a merchant in Pay Theory to start the underwriting process.

SUCCESS 200

GRAPHQL

mutation CreateMerchant(
  $merchant_name: String!
  $metadata: AWSJSON
) {
  createMerchant(
    merchant_name: $merchant_name
    metadata: $metadata
  ) {
    merchant_uid
    merchant_name
    parent_merchant_uid
    ach_active
    card_active
    cash_active
    country_code
    is_system
    submitted_onboarding
    metadata
  }
}