Skip to main content
POST
/
v3
/
api
/
interchange
/
settlement
/
wallet
Retrieve settlement wallet for Venue
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/interchange/settlement/wallet \
  --header 'X-Signature: <api-key>'
{
  "id": "ZTEST-ISW-TBHJYXEFN4",
  "venueId": "<string>",
  "name": "Demo settlement wallet",
  "status": "ACTIVE",
  "companyId": "ZTEST",
  "balances": [
    {
      "currency": "BTC",
      "availableBalance": {
        "amount": "<string>",
        "amountUnit": "0.006414",
        "fiatValue": "0.006414",
        "fiatCurrency": "USD",
        "usdValue": "0.006414"
      },
      "ledgerBalance": {
        "amount": "<string>",
        "amountUnit": "0.006414",
        "fiatValue": "0.006414",
        "fiatCurrency": "USD",
        "usdValue": "0.006414"
      },
      "pendingOutBalance": {
        "amount": "<string>",
        "amountUnit": "0.006414",
        "fiatValue": "0.006414",
        "fiatCurrency": "USD",
        "usdValue": "0.006414"
      },
      "pendingInBalance": {
        "amount": "<string>",
        "amountUnit": "0.006414",
        "fiatValue": "0.006414",
        "fiatCurrency": "USD",
        "usdValue": "0.006414"
      },
      "feeBufferBalance": {
        "amount": "<string>",
        "amountUnit": "0.006414",
        "fiatValue": "0.006414",
        "fiatCurrency": "USD",
        "usdValue": "0.006414"
      },
      "subClientBalances": {}
    }
  ],
  "createdAt": "2021-05-11 04:43:43.056",
  "customProperties": {
    "clientReference": "ZodiaTest",
    "walletReference": 1223456
  },
  "createdBy": "SYS_SettlementFundManager",
  "updatedAt": "2021-05-11 04:43:43.056"
}

Authorizations

​
X-Signature
string
header
required

Response

OK

​
id
string
required

ID of the settlement wallet

Required string length: 1 - 40
Pattern: <companyId>-ISW-*
Example:

"ZTEST-ISW-TBHJYXEFN4"

​
venueId
string
required

ID of the venue to which the settlement wallet is linked

​
name
string
required

Display name of the settlement wallet

Required string length: 1 - 128
Example:

"Demo settlement wallet"

​
status
enum<string>
required

Current status of the settlement wallet

Available options:
ACTIVE,
DEACTIVATED
​
companyId
string
required

ID of the company

Required string length: 1 - 12
Example:

"ZTEST"

​
balances
object[]
required
​
createdAt
string<date-time>
required

Date/time (in UTC) of creation of the settlement wallet

Example:

"2021-05-11 04:43:43.056"

​
customProperties
object
​
createdBy
string

ID of the user who created the settlement wallet

Example:

"SYS_SettlementFundManager"

​
updatedAt
string<date-time>

Date/time (in UTC) of the settlement wallet's last update

Example:

"2021-05-11 04:43:43.056"