Create a new wallet

Request

Header Params

Content-Type

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {{access_token}}

Body Params application/json

holder_id

string

required

asset_class

string

required

asset

string

required

partner_product

string

required

Example

{
    "holder_id": "81fd9a9e-5c0f-48ec-aa7d-0fb99f12b3b1",
    "asset_class": "CURRENCY",
    "asset": "AUD",
    "partner_product": "KOBBLE_AUD_1"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/customers/v1/wallets' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "holder_id": "81fd9a9e-5c0f-48ec-aa7d-0fb99f12b3b1",
    "asset_class": "CURRENCY",
    "asset": "AUD",
    "partner_product": "KOBBLE_AUD_1"
}'

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": "73557536-d005-4488-9d0c-aabe48705595",
    "external_id": "11111",
    "created_at": "2025-01-14T16:56:58.947Z",
    "updated_at": "2025-01-14T16:56:58.947Z",
    "holder_id": "db13f0b1-dbb8-4476-9e31-fb93bcb3ec33",
    "asset": "AUD",
    "asset_class": "CURRENCY",
    "status": "INACTIVE",
    "partner_product": "KOBBLE_AUD_1",
    "total_amount": 1,
    "amount": 1,
    "reserved_amount": 0
}