Merchant webhooks
API version 2023-01-01 deprecating
This version will be deprecated on May 1, 2025. If your platform is on this version, you should upgrade to at least 2023-12-01 to simplify authorization and access new features.
Merchants
Webhooks can be configured to receive updates on every status change that occurs through the life cycle of a merchant and their merchant applications.
Merchant webhook payload
The webhook payload data field represents all payin detail fields returned by the get merchant endpoint.
Merchant events
| Event | Description |
|---|---|
merchant.pending | Triggered when a merchant is created and the initial merchant application is in progress. The merchant status is PENDING. |
merchant.onboarding | Triggered when a merchant's initial application is submitted and the merchant is in the process of underwriting and onboarding. The merchant status is ONBOARDING. |
merchant.active | Triggered when a merchant is successfully onboarded and the merchant is ready to accept payments. The merchant status is ACTIVE. |
merchant.suspended | Triggered when a merchant is suspended and the merchant cannot accept payments. The merchant status is SUSPENDED. |
merchant.deactivated | Triggered when a merchant is deactivated . The merchant status is DEACTIVATED. |
Merchant applications
Webhooks can be configured to receive updates on every status change that occurs through the life cycle of a merchant application.
Merchant application webhook payload
The webhook payload data field represents all payin detail fields returned by the get merchant application endpoint.
Merchant application events
| Event | Description |
|---|---|
merchant_application.created | Triggered when a merchant application is created and the application has not been updated yet. The merchant application status is CREATED. |
merchant_application.in_progress | Triggered when a merchant application is updated for the first time indicating that the application is being filled out. The merchant application status is IN_PROGRESS. |
merchant_application.processing | Triggered when a merchant application is submitted and the application is in the process of underwriting and onboarding. The merchant application status is PROCESSING. |
merchant_application.in_review | Triggered when a merchant application is flagged for risk review after submission. The merchant application status is IN_REVIEW. |
merchant_application.completed | Triggered when a merchant application is approved and the merchant is now active. The merchant application status is COMPLETED. |
merchant_application.declined | Triggered when a merchant application is declined for a specific reason. The merchant application status is DECLINED. |
Updated 6 months ago