MMOB
Environment:
MMOB
Environment:

Accounts

Download Spec

Get User Accounts

get /users/{tpp_user_id}/accounts

Accessible to TPP companies.

Retrieve the list of accounts available for a given user

Authentication

API Key ApiKey

X-API-Key found in header

tpp_user_id

string

required

page

integer

Default
0

size

integer

Default
50

Responses

Response: application/json

items

array[object (TppUserAccount)]

required

TppUserAccount

object (TppUserAccount)

TppUserAccountRequest

description

string

external_key

string

id

string

required

name

string

required

page

integer

required

size

int

required

total

integer

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Create User Account

post /users/{tpp_user_id}/accounts

Authentication

API Key ApiKey

X-API-Key found in header

tpp_user_id

string

required

application/json

description

string

external_key

string

name

string

required

Responses

Response: application/json

description

string

external_key

string

id

string

required

name

string

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Get User Account

get /users/{tpp_user_id}/accounts/{tpp_user_account_id}

Accessible to TPP companies.

Retrieve the details of an account.

Authentication

API Key ApiKey

X-API-Key found in header

tpp_user_id

string

required

tpp_user_account_id

string

required

Responses

Response: application/json

description

string

external_key

string

id

string

required

name

string

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Update User Account

post /users/{tpp_user_id}/accounts/{tpp_user_account_id}

Authentication

API Key ApiKey

X-API-Key found in header

tpp_user_id

string

required

tpp_user_account_id

string

required

application/json

description

string

external_key

string

name

string

required

Responses

Response: application/json

description

string

external_key

string

id

string

required

name

string

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Get Latest Account Balance

get /users/{tpp_user_id}/accounts/{tpp_user_account_id}/current_balance

Accessible to TPP companies.

Retrieve the latest available balance of an TPP user account.

Authentication

API Key ApiKey

X-API-Key found in header

tpp_user_account_id

string

required

Responses

Response: application/json

amount

int

required

currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

id

string

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Get Account Balances

get /users/{tpp_user_id}/accounts/{tpp_user_account_id}/balances

List all the historical balances for a given account

Authentication

API Key ApiKey

X-API-Key found in header

tpp_user_account_id

string

required

page

integer

Default
0

size

integer

Default
50

Responses

Response: application/json

items

array[object (TppUserAccountBalance)]

required

TppUserAccountBalance

object (TppUserAccountBalance)

TppUserAccountRequest

amount

int

required

currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

id

string

required

page

integer

required

size

int

required

total

integer

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Create Account Balance

post /users/{tpp_user_id}/accounts/{tpp_user_account_id}/balances

Create a new balance entry for an account

Authentication

API Key ApiKey

X-API-Key found in header

tpp_user_account_id

string

required

application/json

amount

int

required

currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

Responses

Response: application/json

amount

int

required

currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

id

string

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Was this page helpful?