Creates an Account

post http://localhost:8080/v1/accounts

Responses

Response body

object

accountHayId

uuid

Unique identifier (UUID) of the Account

accountHolderId

uuid

Unique identifier (UUID) of the account holder

accountHolderType

string

The type of object that is the account holder. Possible values:

CUSTOMER: The account holder is a Customer, accountHolderId contains a Customer ID
GROUP: The account holder is a Group, accountHolderId contains a Group ID

CUSTOMER GROUP

accountNumber

string

Account number, 5-9 digits in length

availableBalance

number

Total balance available for use on Account. Funds that are held, locked and allocated to a Stack will not be available. Value to 2 decimal places.

blockedBy

string

The type of entity that is responsible for the blocked account. Possible values:

CLIENT: The account was blocked by the Client.
PLATFORM: The account was blocked by the Platform

CLIENT PLATFORM

bsb

string

BSB (Bank State Branch) of Account, 6 digits in length

closedDateTimeUtc

date-time

DateTime in UTC format when the Account was closed

creationDateTimeUtc

date-time

DateTime in UTC format when the Account was created

currency

string

Account currency as three letter code as per ISO 4217.

AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BOV BRL BSD BTN BWP BYN BZD CAD CDF CHF CLP CNH CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LYD MAD MDL MGA MKD MMK MNT MOP MRU MUR MVR MWK MXN MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD SSP STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD UYU UZS VES VND VUV WST XAF XCD XOF XPF YER ZAR ZMW ZWL

customData

object

required

Contains custom metadata stored with the Account

Has additional fields

heldBalance

number

Total value of all authorised but not yet cleared transactions for all Cards on Account. Positive value to 2 decimal places.

lockedBalance

number

The value that has been locked and unavailable for use, typically as a result of an operations team action. Positive value to 2 decimal places.

overdraftBalance

number

Total value of overdraft used where an overdraft limit exists on the Account. Positive value to 2 decimal places.

overdraftLimit

number

Total value of the overdraft limit applied to Account. Positive value to 2 decimal places.

productId

uuid

Unique identifier (UUID) of the Product

stacksBalance

number

Total value current held against any Stack(s) on the Account. Positive value to 2 decimal places.

status

string

Current Account status. Possible values:

ACTIVE: Account is approved and has had a transactional action performed on it
ACTIVE_IN_ARREARS: Account balance is in a negative position beyond the total deposits / overdraft limit on the Account
APPROVED: Account is approved and ready for use
CLOSED: Account is closed
DORMANT: Account is dormant due to inactivity on Account for a specific period of time
LOCKED: Account is blocked
PENDING_APPROVAL: Account is created but not yet approved (Note: Accounts created through this API are automatically set as APPROVED)

PENDING_APPROVAL APPROVED ACTIVE LOCKED DORMANT CLOSED ACTIVE_IN_ARREARS

technicalOverdraftBalance

number

Total value that is in a negative position beyond the total deposits / overdraft limit on the Account. Value to 2 decimal places.

totalBalance

number

Total value of all funds on the Account (this amount will also include unused overdraft limit and Stacks, held and locked value). Value to 2 decimal places.

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url http://localhost:8080/v1/accounts \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "accountHolderType": "CUSTOMER"
8
}
9
'

Choose an example:

application/json

200Success

400Bad Request

403Forbidden

422Unprocessable Entity

500Internal Server Error

501Not Implemented