Create Merchant Account

Creates a merchant (client) record. No bank account is opened by this call.

POST /merchant/account

Request Body

Field Name	Type	Required	Description
officeId	Long	FALSE	Defaults to 1
legalFormId	Long	FALSE	1 for a person (default), 2 for an entity
firstname	String	TRUE	Up to 50 characters
lastname	String	TRUE	Up to 50 characters
emailAddress	String	FALSE	Contact email
mobileNo	String	FALSE	Up to 50 characters, must be unique
externalId	String	FALSE	BVN of the merchant. Up to 100 characters, must be unique
nin	String	FALSE	NIN of the merchant. Must be unique
dateFormat	String	FALSE	Format of the dates below. Defaults to `dd MMMM yyyy`
locale	String	FALSE	Defaults to `en`
active	Boolean	FALSE	Defaults to true. When true `activationDate` is required
submittedOnDate	String	TRUE	Submission date, in `dateFormat`
activationDate	String	TRUE when active	Activation date, in `dateFormat`

Response

Field Name	Type	Description
clientId	Long	Identifier of the new merchant
nuban	String	Empty, no account is opened by this call
subLedgerActivated	Boolean	Always false for a new merchant

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Body Params application/json

Example

{
  "officeId": 1,
  "legalFormId": 1,
  "firstname": "Ada",
  "lastname": "Example",
  "emailAddress": "ada.example@example.com",
  "mobileNo": "08000000000",
  "externalId": "22000000000",
  "nin": "12345678901",
  "dateFormat": "dd MMMM yyyy",
  "locale": "en",
  "active": true,
  "submittedOnDate": "05 January 2025",
  "activationDate": "05 January 2025"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "clientId": 18,
  "nuban": "",
  "subLedgerActivated": false
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Create Merchant Account