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

Merchant application events

Events

• merchant_application.created
• merchant_application.in_progress
• merchant_application.processing
• merchant_application.needs_information
• merchant_application.in_review
• merchant_application.completed
• merchant_application.declined

Payload

The webhook payload consists of:

• data - represents all merchant application fields returned by the get merchant application endpoint
• event_type - merchant application events denoted by the format of merchant_application.{merchant_application_status}

{
    "data": {
        "merchant_application_id": "app_2sOuOghBfy4SGFS6b7Le8uW8zGo",
        "merchant_id": "mid_2sOuQknV0ornUMNElq9HS3Y5XUv",
        // ...
        "status": "CREATED",
        // ...
    },
    "event_type": "merchant_application.created"
}

Created

Event: merchant_application.created

Triggered when a merchant application is created. A merchant's initial merchant application is created when the merchant is created. The application has not been updated by the merchant yet.

In progress

Event: merchant_application.in_progress

Triggered when a merchant application is updated for the first time indicating that the application is being filled out.

Processing

Event: merchant_application.processing

Triggered when a merchant application is submitted and the application is in the process of underwriting and onboarding.

Needs information

Event: merchant_application.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.

In review

Event: merchant_application.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 the underwriting email provided by the platform for next steps.

Completed

Event: merchant_application.completed

Triggered when a merchant application is approved and the merchant is now active. The merchant's information in the application will not be updated once application is completed. All fields on the merchant application are now represented on the merchant.

Declined

Event: merchant_application.declined

Triggered when a merchant application is declined for a specific reason. This is a final decision and the application cannot be re-opened.