Create Account

Create Account

POST {{Environment_URL}}/mass-payments/v1/accounts

This endpoint allows for the creation of a new sub-account. A required name parameter must be provided, which will serve as a descriptive label for the new account.

The creation of this sub-account is an asynchronous process. Upon the request, the API will immediately return a unique Account Identifier (ID) (e.g., acc_01K87P082E1).

This ID must be stored as it will act as the central key for all future management and operations of the sub-account. The final account approval status will be communicated to your system via a webhook upon the completion of the asynchronous processing.

Headers

Name
Value

Authorization

Bearer <token>

Body

Name
Type
Description

name

string

Name of the account

Request Body

{
  "name": "Sub-Account-01"
}

Response

{
  "id": "acc-01...",
  "message": "Account reserved successfully",
  "status": "ACTIVE"
}

PreviousPIX-IN integrationNextGet Balance