Squad API Documentation
  • Home
  • Payments
    • Initiate Payment
    • Direct API Integration
    • Squad Payment Modal
    • Verify Transaction
    • Aggregator and Sub-merchants
  • Verify Transaction
  • Webhook & Redirect URL
    • Signature validation
  • Virtual Accounts
  • Test Cards
  • Payment Link
  • Refund API
  • Squad Woo Commerce Plugin
  • Disputes & Chargebacks
  • Wallet Balance
  • Transfer API
  • Squad POS
    • Getting Started
    • API Documentation
  • VALUE ADDED SERVICES
    • AIRTIME AND DATA
    • SMS
      • BUCKET
      • TEMPLATES
      • MESSAGES
    • Utilities
      • Cable Subscription
      • Electricity Subscription
Powered by GitBook
On this page
  • Create Sub-merchants.
  • Create Sub-merchants (Aggregator)

Was this helpful?

  1. Payments

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.

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

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.

Create Sub-merchants (Aggregator)

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

Request Body

Name
Type
Description

display_name*

String

Name of sub-merchant

account_name*

String

Sub-merchant's settlement bank account name

bank_code*

String

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

account_number*

String

Sub-merchant's settlement account number

bank*

String

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

{
    "status": 200,
    "success": true,
    "message": "Success",
    "data": {
        "account_id": "AGGERYG8WF34"
    }
}
{
    "status": 400,
    "success": false,
    "message": "\"account_number\" is required",
    "data": {}
}
{
    "success": false,
    "message": "",
    "data": {}
}
{
    "success": false,
    "message": "Merchant authentication failed",
    "data": {}
}

PreviousVerify TransactionNextVerify Transaction

Last updated 1 year ago

Was this helpful?