Merchants

Webhooks can be configured to receive updates on every status change that occurs through the life cycle of a merchant.

Merchant webhook payload

The webhook payload data field represents all merchant fields returned by the get merchant endpoint.

Event	Merchant Status	Description
`merchant.pending`	`PENDING`	Triggered when a merchant is created and the initial merchant application is in progress.
`merchant.onboarding`	`ONBOARDING`	Triggered when a merchant's initial application is submitted and the merchant is in the process of underwriting and onboarding.
`merchant.active`	`ACTIVE`	Triggered when a merchant is successfully onboarded and the merchant is ready to accept payments.
`merchant.suspended`	`SUSPENDED`	Triggered when a merchant is suspended and the merchant cannot accept payments.
`merchant.deactivated`	`DEACTIVATED`	Triggered when a merchant is deactivated.
`merchant.canceled`	`CANCELED`	Triggered when a merchant is canceled prior to being activated.

Webhooks can be configured to receive updates on every status change that occurs through the life cycle of a merchant application.

The webhook payload data field represents all merchant application fields returned by the get merchant application endpoint.

Event	Merchant Application Status	Description
`merchant_application.created`	`CREATED`	Triggered when a merchant application is created and the application has not been updated yet.
`merchant_application.in_progress`	`IN_PROGRESS`	Triggered when a merchant application is updated for the first time indicating that the application is being filled out.
`merchant_application.processing`	`PROCESSING`	Triggered when a merchant application is submitted and the application is in the process of underwriting and onboarding.
`merchant_application.needs_information`	`NEEDS_INFORMATION`	Triggered when a merchant application could not be approved and requires additional verification for onboarding. See the Additional verification for merchant onboarding guide for how to collect the needed information from the merchant.
`merchant_application.in_review`	`IN_REVIEW`	Triggered when a merchant application could not be approved and requires additional verification for onboarding that cannot be resolved with the Needs Information onboarding flow. We will contact the platform via a helpdesk ticket for next steps.
`merchant_application.completed`	`COMPLETED`	Triggered when a merchant application is approved and the merchant is now active.
`merchant_application.declined`	`DECLINED`	Triggered when a merchant application is declined for a specific reason.