Get Connection Health Report

Retrieve the connection health for a specific Merchant given their merchant_id. You can use this endpoint to understand whether or not merchants are ready for transactions through your app.

This endpoint cached once every 24 hours. The data you see may be stale, although if you refresh a specific merchant, those updates will be reflected here. We highly recommend subscribing to our Webhooks to get accurate information about when a merchant needs attention.

Headers

X-Violet-Token

string

X-Violet-App-Secret

string

X-Violet-App-Id

integer

Path Parameters

merchant_id

integer

required

Query Parameters

app_id

integer

refresh

boolean

default: false

Will refresh and re-calculate the merchant's connection health. This is a heavy operation and should not be done programmatically. Only pass this param when you have reason to believe something has changed the merchant's status. We recommend using our webhooks to be notified when a merchant has become unhealthy or has completed onboarding.

Response

default - application/json

The container for all status objects comprising merchant connection health

merchant_id

integer

The id of the merchant this connection health report pertains to

merchant_name

string

The name of the merchant this connection health report pertains to

merchant_email

string

The obfuscated email address of the merchant this connection health report pertains to

merchant_status

enum<string>

The status/state of the merchant this connection health report pertains to

Available options:

INACTIVE,

ACTIVE,

DISABLED,

NEW,

DISABLED_INACTIVE,

FOR_DELETION,

APPLICATION_IN_PROGRESS,

APPLICATION_SUBMITTED,

APPLICATION_DENIED,

APPLICATION_ACCEPTED

platform

enum<string>

The eCommerce platform this merchant uses

Available options:

OTHER,

SHOPIFY,

MAGENTO,

MAGENTO_ONE,

WOOCOMMERCE,

BIGCOMMERCE,

LIGHTSPEED,

ECWID,

YAAS,

SPREECOMMERCE,

DEMANDWARE,

VOLUSION,

PRESTASHOP,

THREEDCART,

SYLIUS,

WIX,

SWELL,

MIVA,

WEBSPHERE,

ORACLECC,

SAPCC,

SQUARESPACE,

SHOPWARE,

COMMERCETOOLS,

MEDUSA,

ABICART,

SPRYKER,

MYSTORE,

CENTRA,

XCART,

VTEX,

KIBO,

SALEOR,

VENDO,

CHORD,

DIGITALRIVER,

SQUARE,

AMAZON,

BIGCARTEL,

CUSTOM

store_url

string

The URL Of the Store

distribution_type

enum<string>

The distribution type this merchant is set to

Available options:

PUBLIC,

PRIVATE

connection

object

The status object for the merchant connection

scope_validation

object

The status object for the merchant connection

sync_status

object

The status object for the product sync

invalid_products

object

The status object for the merchant invalid products

offers_published

object

The status object for offers published

payout_account

object

The status object for the merchant payout account

payout_account.status

enum<string>

The status of the given property

Available options:

COMPLETE,

INCOMPLETE,

NEEDS_ATTENTION,

NOT_APPLICABLE,

ERROR

payout_account.error

object

The error encountered while retrieving status

payout_account.results

object

Violet Payout Account that stores underlying payment provider account information to be used for disbursing funds during Order processing.

payout_account.results.id

integer

Unique identifier for the object

payout_account.results.account_type

enum<string>

Type of the account entity in Violet. This is either DEVELOPER or MERCHANT.

Available options:

MERCHANT,

DEVELOPER,

MERCHANT

payout_account.results.account_id

integer

Identifier of the account entity in Violet. This is either the Violet developer or merchant identifier.

payout_account.results.status

enum<string>

Current status of this payout account. This status reflects whether or not funds can be transferred to the connected payout account.

Available options:

INCOMPLETE,

COMPLETE,

REQUIRES_UPDATES

payout_account.results.kyc_status

enum<string>

Whether or not know-your-customer requirements have been fulfilled for the underlying payment provider payout account.

Available options:

INCOMPLETE,

COMPLETE,

REQUIRES_UPDATES

payout_account.results.payouts_enabled

boolean

Whether or not transfers are being sent by Violet to the connected payment provider account for transactions.

payout_account.results.country_code

string

Two-letter country code of the bank that this Payout Account is associated to.

payout_account.results.payment_provider

enum<string>

Payment Provider that the underlying payout account was created in. This is the provider that handles payment and payout processing for this entity.

Available options:

STRIPE,

NUVEI,

CREDOVA,

EXTERNAL

payout_account.results.payment_provider_account_id

string

Identifier of the payout account in the payment provider system.

payout_account.results.payment_provider_account_type

enum<string>

Type of account in the external payment provider. This field may not be present if the underlying payment provider does not have multiple account types.

Available options:

EXPRESS,

CUSTOM,

STANDARD,

PLATFORM

payout_account.results.payment_provider_metadata

object

Metadata from the payment provider associated to this payout account.

payout_account.results.verified

boolean

Verification status of the payout account connected to the payment provider.

payout_account.results.payment_provider_account

object

payout_account.results.date_created

string

Time at which the object was created. In ISO-8601 format.

payout_account.results.date_last_modified

string

Time at which the object was last modified. In ISO-8601 format.

payout_account.results.paymentServiceAccountType

enum<string>

Available options:

EXPRESS,

CUSTOM,

STANDARD,

PLATFORM

payout_account.results.paymentService

enum<string>

Available options:

STRIPE,

NUVEI,

CREDOVA,

EXTERNAL

payout_account.results.externalId

string

payout_account.results.details

object

payout_account.results.details.legal_entity_address_city

string

Legal Entity Address City

payout_account.results.details.legal_entity_address_state

string

Legal Entity Address State

payout_account.results.details.legal_entity_address_country

string

Legal Entity Address Country

payout_account.results.details.legal_entity_address_postal_code

string

Legal Entity Address Postal/Zip Code

payout_account.results.details.legal_entity_date_of_birth

string

Legal Entity Date of Birth

payout_account.results.details.legal_entity_business_name

string

Legal Entity Business Name

payout_account.results.details.account_holder_name

string

Account Holder Name

payout_account.results.details.legal_entity_business_tax_id

string

Legal Entity Business Tax ID

payout_account.results.details.legal_entity_first_name

string

Legal Entity First Name

payout_account.results.details.legal_entity_last_name

string

Legal Entity Last Name

payout_account.results.details.legal_entity_ssn_last_four

string

Legal Entity SSN Last Four

payout_account.results.details.legal_entity_type

string

Legal Entity Type

payout_account.results.details.ssn_last_4_provided

boolean

Has SSN Last 4 been provided

payout_account.results.details.tosAccepted

boolean

Have the TOS been accepted

payout_account.results.details.legal_entity_currency

string

Desired Currency of the Legal Entity

payout_account.results.details.statement_descriptor

string

The merchants desired statement descriptor

payout_account.results.details.website_url

string

The merchants website

payout_account.results.details.email

string

The merchants email

payout_account.results.details.phone

string

The merchants phone number

payout_account.results.details.payoutsEnabled

boolean

payout_account.results.details.paymentsEnabled

boolean

payout_account.results.details.hasPayoutAccount

boolean

payout_account.results.details.disabledReason

string

payout_account.results.details.currentlyDue

string[]

payout_account.results.details.eventuallyDue

string[]

payout_account.results.details.pastDue

string[]

payout_account.results.details.pendingVerification

string[]

payout_account.results.details.legal_entity_address_line_1

string

Legal Entity Address Line One

payout_account.results.details.legal_entity_address_line_2

string

Legal Entity Address Line Two

migration

object

The status object for the merchant payout account migration

commission_rate

object

The status object for the merchant commission rate

commission_rate.status

enum<string>

The status of the given property

Available options:

COMPLETE,

INCOMPLETE,

NEEDS_ATTENTION,

NOT_APPLICABLE,

ERROR

commission_rate.error

object

The error encountered while retrieving status

commission_rate.default_rate

number

The default commission rate this merchant pays to a channel if it is not overridden

commission_rate.overrides

object[]

A list of commission rate overrides this merchant has configured

Overview

Login

Merchants

Catalog

Orders & Checkout

Events

Apps

Operations

Relay

Ecom Syncs

Headers

Path Parameters

Query Parameters

Response