Get Account

The Get Account API allows you to retrieve a sub-account's information.

Header Request

Name
Type
Mandatory
Description

Authorization

String

M

Represents Basic Authentication.

e.g. Basic dW5kZWZpbmVkOnBhc3N3b3Jk

Content-Type

String

M

Content of you request body e.g. application/json

accept

String

M

Mandatory header to specify the response format. Must be set to application/json so the server returns the response in JSON format.

Body Request

No
Name
Type
Mandatory
Min Length
Max Length
Description

1

email

String

M

5

552

Email address to be registered as the account. e.g.[email protected]

2

type

String

M

1

15

Type of account to be created. e.g. "OWNED"` Valid values: [ MANAGED, OWNED]

3

public_profile

Object

M

-

-

Detail of Public profile account

4

public_profile.business_name

String

M

1

512

Business name to be displayed. e.g.Owned Business Account

Sample Request

Content-type: application/json 
Authorization: Basic gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a" 
accept: application/json
{
  "email": "[email protected]",
  "type": "OWNED",
  "public_profile": {
    "business_name": "Owned Business Account"
  }
}

Body Response

No
Name
Type
Mandatory
Min Length
Max Length
Description

1

responseCode

String

M

1

7

responseCode

2

responseMessage

String

M

1

150

responseMessage

3

partnerReferenceNo

String

M

1

512

4

referenceNo

String

M

1

512

5

additionalInfo

Object

M

1

255

6

additionalInfo.remark

String

M

1

512

Sample Response

Sample Response (Negative)

Create Account Status

No
Status

1

REGISTERED

Already registered

2

AWAITING_DOCS

Not applicable for Managed account type

3

LIVE

4

SUSPENDED

If suspended or blocked

5

INVITED

Not applicable for Managed account type

Create Account HTTP Status Code

No
HTTP Status Code
Description

1

200

Success with Response Body Message

2

400

[ DESTINATION_ACCOUNT_NOT_FOUND, DATA_NOT_FOUND, CALLBACK_AUTHENTICATION_TOKEN_NOT_FOUND_ERROR ]

Last updated