Create Virtual Account

Request

Body Params application/json

AccountInput type

onBehalfOf

string | null

optional

Subclient UUID (only needed when creating account on behalf of a subclient)

currencyIso3Code

string

required

Account currency (required)

accountName

string

required

Account name (required)

<= 70 characters

Match pattern:

^[A-Za-z0-9\s().-]+$

uniqueRequestId

string

required

Unique id for idempotency

<= 100 characters

email

string

optional

email (optional), first request uses the email associated with the profile, subsequent request must include email in order to ensure new virtuaal account is created, else it will return the previously created virtual account

Example

{
    "onBehalfOf": null,
    "currencyIso3Code": "NGN",
    "accountName": "ABC Limited",
    "uniqueRequestId": "24d564a9-f45a-44d2-9b31-340bdb8d92a1",
    "email": "not_email@email.com"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/accounts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "onBehalfOf": null,
    "currencyIso3Code": "NGN",
    "accountName": "ABC Limited",
    "uniqueRequestId": "24d564a9-f45a-44d2-9b31-340bdb8d92a1",
    "email": "not_email@email.com"
}'

Responses

🟢200OK

application/json

success response

Body

message

string

required

account

object (AccountOutput)

required

AccountOutput type

entityId

string

required

Account id

currencyIso3Code

string

required

Account currency

accountName

string

required

Account name

fundingDetails

array [object {6}]

required

Account funding details (SSIs)

status

enum<string>

required

Account status

Allowed values:

processingactivedisconnecteddisabledfailed

availableBalance

number

required

Available balance

accountType

enum<string>

optional

Account type

Allowed values:

multigatelinked

Example

{
    "message": "account created",
    "account": {
        "entityId": "a3PEjoHafbKUrkGg4_JhK",
        "currencyIso3Code": "NGN",
        "accountName": "Test Account 1",
        "status": "active",
        "accountType": "multigate",
        "fundingDetails": [
            {
                "bankOrSortCode": "214",
                "accountNumber": "1000062929",
                "bankCountry": "NGA",
                "bankName": "FCMB",
                "bankAddress": null,
                "countryIso3Code": "NGA"
            }
        ]
    }
}

🟠400Bad Request

🟠401Unauthorized