Accounts

Create Account

Call this end point to create an account on the platform by passing the wallet information.

post/connected-deposits/{version}/accounts/create

Request

Path parameters

versionstring required

Headers

IdempotencyKeystring uuid required

Request body

account_currenciesstring[] nullable

Currencies used in the account. Defaults to USD if none selected.

wallet_guidstring uuid

Wallet unique identifier.
required if person already has a wallet.

person_guidstring uuid

Persons unique identifier.
required if person does not yet have a wallet.

account_namestring nullable

A user defined name of the account.

Response

Returns the newly created Account

account_guidstring uuid

Unique identifier of the account on the platform.

wallet_guidstring uuid

Unique identifier of the wallet on the platform.

account_currencystring nullable

Currency of account in ISO-3 string format.

account_namestring nullable

Name of account provided by the API client.

account_type'GENERAL' | 'PROGFUND' | 'CHECK' | 'REVENUE' | 'COLLECTION' | 'PRINCIPAL' | 'SECURE' | 'CREDIT' | 'USERDEFINED' | 'ADVANCE' | 'PROG_DISBURSE' | 'EXCEPTION' | 'WRITEOFF' | 'SUSPENSE' | 'OMNI_OFFSET' | 'INTHOLD' | 'OPERATION'
available_balancenumber double
ledger_balancenumber double
suspense_balancenumber double
account_status'SYSTEM' | 'ACTIVE' | 'FREEZE' | 'CLOSED' | 'OPTOUT'
last_txn_guidstring uuid nullable
post_datestring date-time nullable
amountnumber double nullable
mask_account_numberstring nullable

Last four digits of account number

sys_utcinsertedstring date-time
status_change_nonmon_detailTxnNonmonDetail

Changes

No recorded changes to this operation across all 1 revision of this API.