WePay logo
      Nothing Found

Onboarding As A Service

 

BETA

Submitters On Core is a BETA offering. Work with your integration team at WePay to determine whether this offering is appropriate for your platform.

Currently, onboarding submerchants as a Full Liability Submitter with Chase Merchant Services requires a manual process using multiple forms and email.

With WePay's Onboarding As A Service offering, you'll leverage onboarding APIs to provide submerchant details and documents directly to Chase Merchant Services, dramatically reducing the effort and time involved in submerchant onboarding. Onboarding As A Service offers:

  • Instant response and validation
  • AML/KYC verifications
  • Instant MID provisioning
  • Asynchronous communication to support rare cases where more submerchant information is required

At a high level, you'll integrate the onboarding subset of WePay's Clear APIs to send merchant data to WePay. WePay will validate and verify merchant data, and respond with a provisional MID immediately and simultaneously forward it to Chase Merchant Services to activate the MID. Once the MID has been processed by Chase Merchant Services, WePay will provide a notification event containing the MID's activation status.

SubmerchantFull Liability SubmitterWePaySign up on Partner Center to receive API credentialsSubscribe to recommended notificationsSubmerchant enters the required information through FLS' platformPOST /legal_entities{legal_entity_object}POST /payout_methods{payout_methods_object}POST /account{account_object} with MID in pending stateListen to notifications on accounts.capabilities.updated and legal_entities.verifications.updated topic to handle errant fieldsCheck for errant fieldsFulfill errant fieldsNotification event on account.capabilities.updated topic for the MID statusCommunicate with merchant appropriatelySubmerchantFull Liability SubmitterWePay

Step 1: Get API Credentials

First, register your platform following the directions found here.

Next, be sure to use the Pre-Release version 3.0.rc.1.1 in the Version header parameter for your requests to the following endpoints:

  • /accounts
  • /accounts/id
  • /accounts/id/capabilities

The API specification for requests with version 3.0.rc.1.1 in the header can be found here.

Other endpoints that you'll use for your integration will be the 3.0 specification, although you can pass either 3.0 or 3.0.rc.1.1 in the Version header. These endpoints include:

  • /legal_entities
  • /legal_entities/id/verifications
  • /payout_methods
  • /notifications

Step 2: Subscribe to Notifications

WePay API Notifications are webhooks sent by the WePay system to you, the platform. Notifications will enable you to understand a submerchant's onboarding progression. For example, a notification will update you about a submerchant's entered KYC data, and whether more information needs to be supplied. Finally, you'll be notified if a submerchant ID (MID) is activated via notifications.

Find out how WePay API Notifications work here. Be sure to follow the minimum required subscriptions:

  • accounts.capabilities.updated -- This API Notification will alert you to:
    • any change in MID status
    • errant fields on the Account, and some Legal Entity attributes
  • legal_entities.verifications.updated -- This API Notification will alert you to:
    • requests from WePay for merchant identity verification documents
    • errant fields on the Legal Entity

Subscribe to these recommended notifications in order to listen for asynchronous responses:

  • accounts.created
  • accounts.updated
  • legal_entities.created
Note

Either 3.0.rc.1.1 or 3.0 can be used in the Version header.

Validate Notifications

Use Notification Signatures to validate that API Notifications have been sent from WePay, and not a malicious actor.

Questions? Need help? Visit our support page!