Applications

Submit a new merchant application

The Applications API is used to submit new merchant enrollment applications to PaySimple. Endpoints related to merchant applications can be found within the New Application API Reference.

All calls must be made with a Reseller API key in the header.

Subscribe to the application_status_updated webhook event to get notified when the status of the application changes.

Subscribe to to the merchant_activated_for_payment_type webhook to be notified when the merchant is enabled for payment processing.

Application Status Updated Webhook

This webhook is functional only for applications to the Forte credit card or Forte ACH processing platform

Sent when the status of an application changes

Example Body:

{
  "event_type": "application_status_updated",
  "event_id": "evt_5b2ac7e83b6325a85c23149e",
  "created_at": "2018-06-20T21:32:24.3265438Z"
  "data": {
    "status": "declined",
    "external_id": "8M27CVE8S90"
  }
}

Properties

PropertyTypeDescription
statusstringThe current status of the application
external_idstringThe unique id in the partner's system submitted at application creation

Application Status

StatusDescription
pendingThe merchant is being evaluated. This is the initial state of the application
approvedThe merchant is approved for processing, will be enrolled soon
declinedThe merchant cannot be approved for processing
cancelledThe merchant enrollment process was cancelled
approvedThe merchant can begin processing
recalledThe merchant has not responded to a request for documentation within 7 days of the request. If the requested documentation is provided within 60 days of the date we received the application we can update the status of the application. If after 60 days from the date we received the application the applicant would need to re-apply.

Did this page help you?