Get wallet by ID

Request

Path Params

id

string

required

Wallet id

Header Params

Authorization

string

required

Example:

Bearer {{access_token}}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

A wallet represents a store of value for a specific holder.

id

string <uuid>

required

The unique identifier of the wallet.

external_id

string | null

required

An external reference ID for the wallet.

created_at

string <date-time>

required

The timestamp when the wallet was created.

updated_at

string <date-time>

required

The timestamp when the wallet was last updated.

holder_id

string <uuid>

required

The unique identifier of the wallet holder.

asset

enum<string>

required

The type of asset held in the wallet.

Allowed value:

AUD

asset_class

enum<string>

required

The class of the asset.

Allowed value:

CURRENCY

status

enum<string>

required

The current status of the wallet.

Allowed values:

ACTIVEINACTIVESUSPENDED

partner_product

enum<string>

required

The partner product associated with the wallet.

Allowed value:

KOBBLE_AUD_1

total_amount

number <float>

required

The total amount of the asset in the wallet.

amount

number <float>

required

The available amount of the asset in the wallet.

reserved_amount

number <float>

required

The reserved amount of the asset in the wallet.

Example

{
    "id": "c907159f-96bb-4bf3-9cfd-f3944a33304f",
    "external_id": "11111",
    "created_at": "2025-01-14T16:57:15.372Z",
    "updated_at": "2025-01-14T16:57:15.374Z",
    "holder_id": "e4edb795-1626-4543-aefe-5f5c587044ed",
    "asset": "AUD",
    "asset_class": "CURRENCY",
    "status": "INACTIVE",
    "partner_product": "KOBBLE_AUD_1",
    "total_amount": 1,
    "amount": 1,
    "reserved_amount": 0
}