Submit for Review

Submit onboarding application for partners' review

POST https://<PayEngine-host>/merchant/:id/submit

Attempts to submit fully completed application to start the review process.

Path Parameters

Name	Type	Description
id*	string	Merchant ID

Request Body

Name	Type	Description
status	string	New Status

Response Body

Name	Type	Description
signing_url	string	Depending on the configuration in the partner portal, the link will either direct to a DocuSign page or to the merchant portal, where the docusign document can be viewed for signature

200

The link is typically rendered in an iframe which sends an event back to hosting app upon completion of the signing process.

{
    "message": "merchant updated",
    "data": {
        "id": "8dbf55c3-46c8-424d-817c-e14838c76ab4",
        "signing_url": <Digital Signature URL>
    }
}

Status Values

If your account has auto signature enabled then application is automatically submitted and signature link is provided in the response to initiate underwriting process. If your merchant decides not to sign the document or does not complete the process then the status of the application remain unchanged.

Status	Description
in_review	Start the review process and notify appropriate admins
submitted_to_pe	Submit the application to PayEngine for onboarding
editing	Move application to editing phase
suspended	Suspend merchant account

Webhook event: MERCHANT_STATUS_CHANGED

{
  event_uid: '43ab1219e4eab0809528a211c115f099',
  event: 'MERCHANT_STATUS_CHANGED',
  data: {
    id: 'c404d923-226f-4aae-92da-22c1ef370434',
    signing_url: <Digital Signature URL>,
    account_id: 'e90c1de6-4e87-4c9e-bcbc-c535d6e349ec',
    merchant_id: 'c404d923-226f-4aae-92da-22c1ef370434'
  }
}