OnBoard New Merchant

This endpoint allows merchants to create an account on the platform. It requires the following information.

Javascript

//A code snippet on how to consume the API

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "first_name": "Feranmi",
  "last_name": "Emmanuel",
  "user_type": "Merchant",
  "email": "[e-mail]",
  "password": "password",
  "password_confirmation": "password",
  "business_name": "BUSINESS",
  "phone": "08145986958",
  "bvn": "222211277",
  "bank_code": "044",
  "account_no": "0767474393",
  "settlement_bank_title": "Test",
  "bank_name": "Access Bank",
  "settlement_email": "[e-mail]"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://demo.backend.monicredit.com/core/auth/onboard-business", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

PHP

//A code snippet on how to consume the API

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://demo.backend.monicredit.com/core/auth/onboard-business',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "first_name": "Feranmi",
    "last_name": "Emmanuel",
    "user_type": "Merchant",
    "email": "[e-mail]",
    "password": "password",
    "password_confirmation": "password",
    "business_name": "BUSINESS",
    "phone": "08145986958",
    "bvn": "222211277",
    "bank_code": "044",
    "account_no": "0767474393",
    "settlement_bank_title": "Test",
    "bank_name": "Access Bank",
    "settlement_email": "[e-mail]"
}',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

POST {{BaseURL}}/core/auth/onboard

If the Onboarding is successful, the API will return a response with a 200 status code and a JSON object containing the data of the Merchant.

Request Body

Name	Type	Description
first_name*	String	Test
last_name*	String	Test
user_type*	String	Merchant
email*	String	[e-mail]
password*	String	password
password_confirmation*	String	password
business_name*	String	Business
phone*	String	00000000
bvn*	String	000000000
bank_code*	String	0000
account_no*	String	00000000
settlement_bank_title*	String	Test
bank_name*	String	Test
settlement_email*	String	[e-mail]

200: OK

{
    "success": true,
    "message": "Merchant Onboarding Successfull",
    "UserData": {
        "id": "US000000",
        "success": true,
        "message": "Account Created."
    },
    "AccountData": {
        "headers": {},
        "original": {
            "status": true,
            "message": "Account created succesfully",
            "data": {
                "id": "ACC000000",
                "user_id": "US000000",
                "name": "Test",
                "type": "MERCHANT",
                "tier": "test",
                "updated_at": "2022-09-13T16:28:20.000000Z",
                "created_at": "2022-09-13T16:28:20.000000Z"
            }
        },
        "exception": null
    }
}