Aggregator and Sub-merchants

This API allows you to be profiled as an aggregator and also create sub-merchants dynamically under your account.

With this, you are able to initiate transactions from a central point for all businesses or sub merchants under you using the same API keys.

note

Authorization Any request made without the authorization key (secret key) will fail with a 401 (Unauthorized) response code.

info

The authorization key is sent via the request header as Bearer Token Authorization

Example: Authorization: Bearer sandbox_sk_94f2b798466408ef4d19e848ee1a4d1a3e93f104046f

Create Sub-merchants.

This API is used to create a sub-merchant, the sub-merchant will have its own ID and will automatically have its own view on the dashboard.

POST

https://sandbox-api-d.squadco.com/merchant/create-sub-users

Parameters

Body

display_name*

String

Name of sub-merchant

account_name*

String

Sub-merchant's settlement bank account name

account_number*

String

Sub-merchant's settlement account number

bank_code*

String

Sub-merchant's settlement bank code. e.g 058

bank*

String

Name of sub-merchant's settlement bank e.g GTBank

Responses

200:OK

Success

{
      "status": 200,
      "success": true,
      "message": "Success",
      "data": {
          "account_id": "AGGERYG8WF34"
      }
}

400:Bad Request

Error in request payload

{
      "status": 400,
      "success": false,
      "message": ""account_number" is required",
      "data": {}
}

401:Unauthorized

No Authorization

{
      "success": false,
      "message": "",
      "data": {}
}

403:Forbidden

Wrong/Invalid API Keys

{
      "success": false,
      "message": "Merchant authentication failed",
      "data": {}
}