Merchant Application Webhooks

Webhooks provide near-real-time notifications about the events that occur during the application process through POSTs to a customer-defined endpoint. 

Merchant application webhooks provide the status of an application as the application status events trigger during the application process.

Partners can subscribe to the following merchant application webhook events:

• merchantapplication.approved
• merchantapplication.declined
• merchantapplication.pending
• merchantapplication.recalled
• merchantapplication.received
• merchantapplication.rejected

If a webhook post fails (i.e., does not result in an HTTP 200 response), Forte retries the webhook post up to twenty times adding one minute for each retry.

What information is included in the merchant application Webhook?

1. Organization ID
2. Event ID
3. Merchant Application
   • Application ID
   • Fee ID
   • Services Requested
   • Decline Reason
   • Rejected Reason
   • Recalled Reason
   • Status
   • Received Date
   • Received Time
   • Updated Date
   • Updated Time
   • Merchant DBA
   • Merchant Legal Name
   • Organization
   • Account id
   • DBA Name
   • Legalname
4. Source
5. Type
6. Environment

How do I create webhooks for merchant application statuses?

Merchant application webhooks are available at the partner organization level.

To define your webhook, in Dex, select Developer > Webhooks from the Dex main menu and then click Create Webhook.

The following screen displays: Enter a unique Webhook name, set the status to Active or Pending, and enter the URL for your server which will receive the Webhook postbacks.

Define the events that trigger the Webhook using the Resource sections and actions, select All to receive webhooks for all resource actions, or Custom to specify which events trigger the webhook.

FAQs

• Developer Role
• Api_User

Note: If there are no dex users in your Partner organization with one of these roles, please reach out to your Forte contact to request the merchant application webhooks to be set-up for you.

Merchant Application Webhooks Sample Event Data

Approved: 

{"organization_id":"org_123456","event_id":"evt_6AZrPxX2DUiZCZ3O5Qit3w","MerchantApplication":{"application_id":555555,"fee_id":11111,"services_requested":"eCheck - Acquired","decline_reason":[],"reject_reason":[],"recalledReason":[],"status":"approved","received_date":"01/29/2023","received_time":"11:38:12 PM","updated_date":"01/29/2023","updated_time":"11:45:16 PM","organization":{"account_id":123456,"dba_name":"test dba","legal_name":"test dba llc"}},"source":"Console","type":"merchantapplication.approved","environment":"live"}

Declined: 

{"organization_id":"org_123456","event_id":"evt_PHfOvmHrukexY887o6uD6Q","MerchantApplication":{"application_id":555555,"fee_id":11111,"services_requested":"eCheck - Acquired","decline_reason":["Identity","Type Of Business","Reputation"],"reject_reason":[],"recalledReason":[],"status":"declined","received_date":"01/29/2023","received_time":"11:38:12 PM","updated_date":"01/29/2023","updated_time":"11:38:57 PM","organization":{"account_id":123456,"dba_name":"test dba","legal_name":"test dba llc"}},"source":"Console","type":"merchantapplication.declined","environment":"live"}

Pending: 

{"organization_id":"org_123456","event_id":"evt_oONZb8MyN0eelUyVRnYkqQ","MerchantApplication":{"application_id":555555, "fee_id": 11111,"services_requested":"eCheck - Acquired and Credit Card - Acquired","decline_reason":[],"reject_reason":[],"recalledReason":[],"status":"pending","received_date":"03/02/2023","received_time":"12:15:54 PM","updated_date":"03/02/2023","updated_time":"12:16:02 PM","organization":{"account_id":123456,"dba_name":"test dba","legal_name":"test dba llc"}},"source":"Console","type":"merchantapplication.pending","environment":"live"}

Received: 

{"organization_id":"org_123456","event_id":"evt_LOJOqbKXI0K2KifqPaxrrQ","MerchantApplication":{"application_id":555555,"fee_id":11111,"services_requested":"eCheck - Acquired","decline_reason":[],"reject_reason":[],"recalledtReason":[],"status":"submitted","received_date":"01/29/2023","received_time":"10:32:15 PM","updated_date":"01/29/2023","updated_time":"10:32:15 PM","organization":{"account_id":123456,"dba_name":"test dba","legal_name":"test dba llc"}},"source":"forte.net","type":"merchantapplication.received","environment":"live"}

Rejected: 

{"organization_id":"org_123456","event_id":"evt_BIcR-xdph0OwKBZVNXL8Dg","MerchantApplication":{"application_id":555555,"fee_id":11111,"services_requested":"eCheck - Acquired","decline_reason":[],"reject_reason":["Missing or Incomplete Pricing","Incomplete or Invalid Bank Information","Incomplete or Inaccurate TaxID/EIN","Unable to verify SSN","Unable to verify Date of Birth","Invalid Signatures"],"recalledReason":[],"status":"rejected","received_date":"01/29/2023","received_time":"11:38:12 PM","updated_date":"01/29/2023","updated_time":"11:42:20 PM","organization":{"account_id":123456,"dba_name":"test dba","legal_name":"test dba llc"}},"source":"Console","type":"merchantapplication.rejected","environment":"live"}

Recalled: 

{"organization_id":"org_123456","event_id":"evt_i62YX16Q2k-DWVS7NhYlUg","MerchantApplication":{"application_id":555555,"fee_id":11111,"services_requested":"eCheck - Acquired","decline_reason":[],"reject_reason":[],"recalledReason":["Incomplete Application","Applicant Not Responding","Partner Request"],"status":"recalled","received_date":"01/29/2023","received_time":"11:38:12 PM","updated_date":"01/29/2023","updated_time":"11:44:07 PM","organization":{"account_id":123456,"dba_name":"test dba","legal_name":"test dba llc"}},"source":"Console","type":"merchantapplication.recalled","environment":"live"}

For more information on Webhooks please see:

Understanding Webhooks  https://www.forte.net/devdocs/reference/webhooks.htm