--- updatedAt: 2025-05-20T20:21:08.000Z agentTools: projectIndex: https://dev.caxton.io/llms.txt --- # Retrieve the Balance for a Specific Wallet. By using the corresponding WalletId, this endpoint displays the balance for any given Wallet. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "v1", "title": "Caxton API", "description": "The Caxton API" }, "paths": { "/api/wallets/wallet/{walletId}/balances": { "get": { "tags": [ "Multi Wallet" ], "summary": "Retrieve the Balance for a Specific Wallet.", "description": "By using the corresponding WalletId, this endpoint displays the balance for any given Wallet.", "operationId": "MultiWalletApi_GetWalletBalances", "parameters": [ { "name": "walletId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "UserApiToken", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Base.Model.FirebirdApiResponseModelBase_2_CaxtonFx.FirebirdApi.Models.Valitor.Response.GetWalletBalancesApiResponse-CaxtonFx.FirebirdApi.Models.Valitor.Model.GetWalletBalancesApiModel_" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Base.Model.FirebirdApiResponseModelBase_2_CaxtonFx.FirebirdApi.Models.Valitor.Response.GetWalletBalancesApiResponse-CaxtonFx.FirebirdApi.Models.Valitor.Model.GetWalletBalancesApiModel_" } } } } } } } }, "servers": [ { "url": "https://sandbox.caxton.io" } ], "components": { "schemas": { "CaxtonFx.FirebirdApi.Base.Model.AuthorisedClientModel": { "description": "Authorised Client", "type": "object", "properties": { "ClientId": { "format": "uuid", "description": "This is a GUID created at the time of first registration.", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "ClientRef": { "description": "This is a unique string created for the API client at the time of first registration.", "type": "string", "readOnly": true }, "UserId": { "description": "The Client's CXTN platform Id. This is a unique Id created at the time of first registration.", "type": "string", "readOnly": true }, "TokenStartDate": { "format": "date-time", "description": "The date from when the token is valid. This is set to 30 days until the TokenEndDate, but also configurable.", "type": "string", "readOnly": true }, "TokenEndDate": { "format": "date-time", "description": "The date the token expires. This is set to 30 days from the TokenStartDate, but also configurable.", "type": "string", "readOnly": true } } }, "CaxtonFx.FirebirdApi.Base.Model.AuthorisedUserModel": { "description": "Authorised User", "type": "object", "properties": { "UserId": { "description": "The User's CXTN platform Id. This is a unique Id created at the time of first registration.", "type": "string", "readOnly": true }, "AppVersion": { "description": "", "type": "string", "readOnly": true }, "TokenStartDate": { "format": "date-time", "description": "Timestamp assigned when the token becomes valid. This is set to 30 days until the TokenEndDate, but also configurable.", "type": "string", "readOnly": true }, "TokenEndDate": { "format": "date-time", "description": "Timestamp assigned when the token expires. This is set to 30 days from the TokenStartDate, but also configurable.", "type": "string", "readOnly": true }, "LoginTimestamp": { "format": "date-time", "description": "The timestamp created upon User login. Indicates the time and date the User logged in.", "type": "string", "readOnly": true }, "ApiLoginType": { "description": "Describes the type of user account currently logged in.", "enum": [ "UserApiToken", "ClientApiTokenWrapped", "UserApiTokenOverridden" ], "type": "string", "readOnly": true } } }, "CaxtonFx.FirebirdApi.Models.Error.FirebirdApiError": { "type": "object", "properties": { "ExpectedResponses": { "type": "array", "items": { "type": "string" }, "readOnly": true }, "AdditionalInfo": { "type": "object" }, "Exception": { "type": "object" }, "ApiStatusCode": { "type": "string", "readOnly": true }, "ApiStatus": { "type": "string", "readOnly": true }, "ApiStatusDescription": { "type": "string", "readOnly": true } } }, "CaxtonFx.Business.API.Entities.Valitor.WalletBalanceApiEntity": { "type": "object", "properties": { "CurrencyCode": { "description": "This value consists of a three-letter currency code as per [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). For Pots, this value is the name of the Pot.", "type": "string" }, "Description": { "description": "Describes the currency. E.g. US Dollar, British Pound Sterling, Euro, etc.", "type": "string" }, "Symbol": { "description": "The corresponding symbol for the currency.", "type": "string" }, "Balance": { "format": "double", "description": "The amount in credit or debit for the given currency.", "type": "number" }, "IsBalancePositive": { "description": "Set to 'true' when the balance is more than zero.", "type": "boolean" }, "NonZeroBalance": { "description": "Set to 'true' when the balance is more than, or less than zero.", "type": "boolean", "readOnly": true }, "HasNegativeBalance": { "description": "Set to 'true' when the balance on the account is negative.", "type": "boolean", "readOnly": true }, "FxSweepEnabled": { "description": "When set to 'true', payments in a given currency can be made using alternative funds available. E.g. A customer runs out of EUR when making a payment, but has a GBP balance in the Wallet, then the funds are converted from GBP to EUR and used to complete the payment.", "type": "boolean" } } }, "CaxtonFx.FirebirdApi.Base.Model.FirebirdApiResponseModelBase_2_CaxtonFx.FirebirdApi.Models.Valitor.Response.GetWalletBalancesApiResponse-CaxtonFx.FirebirdApi.Models.Valitor.Model.GetWalletBalancesApiModel_": { "type": "object", "properties": { "LoggedInUserName": { "type": "string", "readOnly": true }, "MainAccountHolderName": { "type": "string", "readOnly": true }, "Content": { "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Models.Valitor.Response.GetWalletBalancesApiResponse" }, "AuthorisedClientModel": { "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Base.Model.AuthorisedClientModel" }, "AuthorisedUserModel": { "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Base.Model.AuthorisedUserModel" }, "FirebirdApiError": { "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Models.Error.FirebirdApiError" } } }, "CaxtonFx.FirebirdApi.Models.Valitor.Response.GetWalletBalancesApiResponse": { "type": "object", "properties": { "Model": { "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Models.Valitor.Model.GetWalletBalancesApiModel" }, "ExpectedResponses": { "type": "array", "items": { "type": "string" } } } }, "CaxtonFx.FirebirdApi.Models.Valitor.Model.GetWalletBalancesApiModel": { "type": "object", "properties": { "WalletId": { "format": "int64", "description": "The WalletId is linked to the Card Holder and keeps record of the transactions made by all Cards stored within.", "type": "integer", "readOnly": true }, "Name": { "description": "The name given to the Wallet.", "type": "string", "readOnly": true }, "Balances": { "type": "array", "items": { "$ref": "#/components/schemas/CaxtonFx.Business.API.Entities.Valitor.WalletBalanceApiEntity" }, "readOnly": true }, "ApiStatusCode": { "type": "string", "readOnly": true }, "ApiStatus": { "type": "string", "readOnly": true }, "ApiStatusDescription": { "type": "string", "readOnly": true } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```