Transactions

Download Spec

Get Transactions

get /users/{tpp_user_id}/accounts/{account_id}/transactions

API Key ApiKey

tpp_user_id

string

required

account_id

string

required

page

integer

Default
0

size

integer

Default
50

Response

Examples Schema

Successful Response

{
  "items": [
    {
      "amount": 123,
      "currency": null,
      "type": null,
      "external_key": "string",
      "meta": {},
      "description": "string",
      "id": "string",
      "tpp_id": "string",
      "tpp_user_id": "string",
      "tpp_user_account_id": "string"
    }
  ],
  "total": null,
  "page": null,
  "size": 123
}

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

items

array[object (TppUserAccountTransaction)]

required

TppUserAccountTransaction

object (TppUserAccountTransaction)

amount

int

required

currency

required

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

type

required

Transaction types

external_key

string

required

meta

object (meta)

description

string

id

string

required

tpp_id

string

required

tpp_user_id

string

required

tpp_user_account_id

string

required

total

integer

required

page

integer

required

size

int

required

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Create User Transaction

post /users/{tpp_user_id}/accounts/{account_id}/transactions

Create User transaction

API Key ApiKey

tpp_user_id

string

required

account_id

string

required

amount

int

required

currency

required

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

type

required

Transaction types

external_key

string

required

meta

object (meta)

description

string

Request

{
  "amount": 123,
  "currency": null,
  "type": null,
  "external_key": "string",
  "meta": {},
  "description": "string"
}

Response

Examples Schema

Successful Response

{
  "amount": 123,
  "currency": null,
  "type": null,
  "external_key": "string",
  "meta": {},
  "description": "string",
  "id": "string",
  "tpp_id": "string",
  "tpp_user_id": "string",
  "tpp_user_account_id": "string"
}

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

amount

int

required

currency

required

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

type

required

Transaction types

external_key

string

required

meta

object (meta)

description

string

id

string

required

tpp_id

string

required

tpp_user_id

string

required

tpp_user_account_id

string

required

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Get Transaction

get /users/{tpp_user_id}/accounts/{account_id}/transactions/{transaction_id}

API Key ApiKey

tpp_user_id

string

required

account_id

string

required

transaction_id

string

required

Response

Examples Schema

Successful Response

{
  "amount": 123,
  "currency": null,
  "type": null,
  "external_key": "string",
  "meta": {},
  "description": "string",
  "id": "string",
  "tpp_id": "string",
  "tpp_user_id": "string",
  "tpp_user_account_id": "string"
}

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

amount

int

required

currency

required

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

type

required

Transaction types

external_key

string

required

meta

object (meta)

description

string

id

string

required

tpp_id

string

required

tpp_user_id

string

required

tpp_user_account_id

string

required

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Was this page helpful?