Skip to main content
Version: Lab (preview)

ListMerchant

TYPE

This is a limited merchant object that is returned when you want to query a list of merchants.

Fields

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.