Get Wallet By Id

GET 
/api/v2/wallets/:id

Get Wallet By Id

Request

Path Parameters

id uuidrequired

Wallet id

Responses

200

Successful Response

application/json

Schema

Schema

id uuidrequired

Wallet id

code Coderequired

More readable wallet id.

balance object
currencyCode CurrencyCodeEnumrequired
Possible values: [USD]
ISO currency code
available Availablerequired
total Totalrequired
reserved Reservedrequired
pending Pendingrequired
deposit Depositrequired
spent Spentrequired
return Returnrequired
purpose object

An enumeration.

status object

An enumeration.

ownerId Ownerid

Id of the wallet owner.

name Name

Wallet name or alias for the wallet

user object
id uuidrequired
User id
role TeamUserRolerequired
Possible values: [ADMIN, BUYER, TEAM_LEAD, FINANCIER]
User role
status TeamUserStatusrequired
Possible values: [ACTIVE, PENDING, FROZEN, DELETED, SANDBOX]
User status
firstName Firstnamerequired
User first name
lastName Lastnamerequired
User last name
nickname Nicknamerequired
User nickname
email emailrequired
User email
balance objectrequired
User balance information
currencyCode CurrencyCodeEnumrequired
Possible values: [USD]
ISO currency code
available Availablerequired
total Totalrequired
reserved Reservedrequired
pending Pendingrequired

Example (from schema)

{
  "id": "a2d1b4db-30ba-479c-8898-6a74b894271b",
  "code": "string",
  "balance": {
    "currencyCode": "USD",
    "available": 0,
    "total": 0,
    "reserved": 0,
    "pending": 0,
    "deposit": 0,
    "spent": 0,
    "return": 0
  },
  "purpose": "GENERAL",
  "status": "ACTIVE",
  "ownerId": "d73adfcc-3577-4392-a862-c747013647c0",
  "name": "USD wallet for campaigns",
  "user": {
    "id": "d73adfcc-3577-4392-a862-c747013647c0",
    "role": "BUYER",
    "status": "ACTIVE",
    "firstName": "John",
    "lastName": "Doe",
    "nickname": "johndoe",
    "email": "johndoe@example.com",
    "balance": {
      "currencyCode": "USD",
      "available": 0,
      "total": 0,
      "reserved": 0,
      "pending": 0
    }
  }
}

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
MOD1
string
MOD2
integer
]
msg Messagerequired
type Error Typerequired
]

Example (from schema)

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

Loading...