For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create account

This command is to create an account (payment wallet) for a specific customer. Creates a new account with the specified currency and owner. Returns the newly created account details, including balance

Endpoint

POST/v2/account

Link

Request

Headers

Key
Value
Required

Authorization

Bearer <JWT>

Yes

Content-Type

application/json

Yes

Accept

application/json

Yes

Request Body (JSON)

Field
Type
Description & Requirements
Example

customerId

string

ID of the customer who owns this account.

"DqCsgSE-4e95-ViYbNI"

name

string

Account name (e.g., "Business USD Account").

"Savings Account"

currencyIso

string

Currency code (ISO 4217, e.g., USD, EUR). Required.

"EUR"

Example Request Body:

json


Response (200 OK)

Returns the created Account entity v2 object in JSON format.

Response Fields

Field
Type
Description & Values
Example

id

string

Unique account identifier.

"UhcPVBEpjmtR"

customer

object

Customer details: - id: Customer ID - name: Full name - email: Contact email - phone: Phone number - status: Customer status (NEW, ACCEPT, etc.)

{ "id": "DqCsgSE-4e95-ViYbNI", "status": "NEW" }

isDefault

boolean

Whether this is the user’s default account (true/false).

false

name

string

Account name (matches request).

"Main Business Account"

status

string

Initial account status: - NEW: Newly created - PRE_MODERATION: Pending review - MODERATION: Under review

"NEW"

balance

object

Balance details (initially zero): - balance: Available funds - hold: Restricted funds (see Money Object below)

currencyIso

string

Account currency (matches request).

"USD"

requisites

array

Bank/payment details (empty by default).

[]

createdAt

string

Creation timestamp (ISO 8601).

"2024-05-20T10:30:00Z"

updatedAt

string

Last update timestamp (matches createdAt initially).

"2024-05-20T10:30:00Z"

Money Object

Nested under balance and hold:

Field
Type
Description
Example

currencyCode

string

3-letter ISO currency code.

"USD"

units

string

Whole units (e.g., dollars). Initially "0".

"0"

nanos

integer

Fractional units (1 nano = 10^-9 units). Initially 0.

0

Error Cases

  1. Missing currencyIso:

    json

  2. Invalid Currency Code:

    json

  3. Customer Not Found:

    json


Notes

  • Initial Status: New accounts typically start with NEW status. If needed, the status can be changed to MODERATION status

  • Balances: Initialized to 0 in the specified currency.

  • Requisites: Added later via separate API calls (e.g., /v2/account/{id}/requisites).

Examples

Real request

Real response

Last updated