Settlement Wallet API

API for settlement wallet

PreviousRate API NextFiat withdrawal API

Get a wallet

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

POST /api/v1/settlement/wallet HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "address": "text"
  }
}

{
  "name": "text",
  "address": "text",
  "blockchain": "text",
  "balances": [
    {
      "currency": "text",
      "amount": 1,
      "token": true
    }
  ]
}

Get transactions

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

POST /api/v1/settlement/wallet/transactions HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "walletAddress": "text",
    "addressTo": "text",
    "opcodes": [
      "WITHDRAWAL"
    ],
    "currency": "text",
    "pageNumber": 1,
    "pageSize": 1,
    "sort": "ASC",
    "properties": "text"
  }
}

{
  "result": [
    {
      "amount": 1,
      "currency": "text",
      "opCode": "WITHDRAWAL",
      "addressTo": "text",
      "serviceFee": 1,
      "serviceFeeCurrency": "text",
      "networkFee": 1,
      "networkFeeCurrency": "text",
      "transactionHash": "text",
      "createdDate": "2025-05-23T18:46:44.901Z"
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}

Rename wallet

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

400

Bad Request

*/*

500

Internal Server Error

*/*

post

POST /api/v1/settlement/wallet/rename HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "address": "text",
    "name": "text"
  }
}

No content

Get available operation codes

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

POST /api/v1/settlement/wallet/opcodes HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "account": "text",
  "timestamp": 1
}

{
  "opCodes": [
    "WITHDRAWAL"
  ]
}

Create a wallet

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

POST /api/v1/settlement/wallet/create HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "name": "text",
    "blockchain": "text"
  }
}

{
  "name": "text",
  "address": "text",
  "blockchain": "text",
  "balances": [
    {
      "currency": "text",
      "amount": 1,
      "token": true
    }
  ]
}

Archive wallet

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

400

Bad Request

*/*

500

Internal Server Error

*/*

post

POST /api/v1/settlement/wallet/archive HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "address": "text"
  }
}

No content

Get wallets

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

POST /api/v1/settlement/wallet/all HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "blockchain": "text",
    "currency": "text",
    "nameOrAddress": "text",
    "pageNumber": 1,
    "pageSize": 1,
    "sort": "ASC",
    "properties": "text"
  }
}

{
  "result": [
    {
      "name": "text",
      "address": "text",
      "blockchain": "text",
      "balances": [
        {
          "currency": "text",
          "amount": 1,
          "token": true
        }
      ]
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}