Onboard Customer via Banking as a Service (redirect model)

General Information

To start using Banking as a Service functionality, your DevApp should include Banking as a Service API product.

To make onboard payments on behalf of your clients (BaaS Clients), list of BaaS clients and their accounts must be taken.

Postman collection of Banking as a Service API is BaaS Postman collection.

The user of the Banking as a Service APIs - is called Platform, which will onboard their clients which will be called BaaS Clients.

Onboard Customer: Standard account

The user of the Banking as a Service APIs - is called Platform, which will onboard their clients which will be called BaaS Clients. Get Banking as a Service Clients and Their Account list | Developer Portal | ConnectPay 

Standard accounts are fully functioning ConnectPay Customer’s account. Platform users will be opened an account at ConnectPay and will create a user and credentials within ConnectPay. Platform users will be able to log in to ConnectPay and view their balance, statement, initiate payments, order card and etc.

 

Initiate Onboarding Application

Initiate onboarding Application allows Platforms (BaaS Partners) to:

  1. Initiate ConnectPay User registrations and Onbaording sessions for their Clients
    ConnectPay APIs

  2. Redirect Platforms users to ConnectPay user interface

  3. Get onboarding application status updates
    ConnectPay APIs

  4. Receive status updates/callbacks regarding their customer onboarding to their registered webhooks 
    ConnectPay APIs

 

To Initiate the Onboarding application:

  1. API Auth
    to access Onboarding APIs, API consumer must present Access Token with onboarding-baas scope. 
  2. POST Initiate Onboarding Application: ConnectPay APIs


 

 

Key

Explanation

Constraints

Example value

sessionId

A unique string for verification process (will be passed as a url parameter when redirecting a client to verification platform).

  • Length <= 40

"3FA5TFPA2ZE3LMPGGS1EGOJNJE"

externalReference

A unique string identifying the end user on client’s application

  • Not null

  • Max length 100

"ZxqYWaZVLw"

 

Undefined