Exchange API

API for exchanges

Pre-calculate the exchange

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

OK

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

POST /api/v1/exchange/pre-calculate HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "sourceCurrency": "text",
    "destinationCurrency": "text",
    "amount": 1
  }
}

{
  "sourceCurrency": "text",
  "destinationCurrency": "text",
  "amount": 1
}

Get currency pairs

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

OK

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

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

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

{
  "currencyPairs": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "name": "text",
        "feeCurrencyName": "text",
        "coinId": "text",
        "networkData": {
          "frontName": "text",
          "type": "text"
        },
        "scale": 1,
        "blockchainScale": 1,
        "garbageAmount": 1,
        "crypto": true,
        "blockchainName": "text",
        "contract": "text",
        "enabled": true,
        "active": true
      }
    ]
  }
}

Get upper exchange limit by currency

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

OK

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

POST /api/v1/exchange/limit HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "sourceCurrency": "text",
    "destinationCurrency": "text"
  }
}

{
  "sourceCurrency": "text",
  "destinationCurrency": {
    "name": "text",
    "feeCurrencyName": "text",
    "coinId": "text",
    "networkData": {
      "frontName": "text",
      "type": "text"
    },
    "scale": 1,
    "blockchainScale": 1,
    "garbageAmount": 1,
    "crypto": true,
    "blockchainName": "text",
    "contract": "text",
    "enabled": true,
    "active": true
  },
  "minLimit": 1,
  "maxLimit": 1
}

Get exchange

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

OK

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

POST /api/v1/exchange/get HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 51

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

{
  "id": 1,
  "account": "text",
  "sourceCurrency": "text",
  "sourceAmount": 1,
  "destinationCurrency": "text",
  "destinationAmount": 1,
  "state": "IN_PROGRESS",
  "createdDate": "2025-05-23T18:48:34.739Z"
}

Find exchange by filter

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

OK

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

POST /api/v1/exchange/filter HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 269

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "createdDate": {
      "period": {
        "firstDate": "2025-05-23T18:48:34.739Z",
        "secondDate": "2025-05-23T18:48:34.739Z"
      },
      "date": "2025-05-23T18:48:34.739Z"
    },
    "state": [
      "IN_PROGRESS"
    ],
    "pageNumber": 1,
    "pageSize": 1,
    "sort": "ASC",
    "properties": "text"
  }
}

{
  "result": [
    {
      "id": 1,
      "account": "text",
      "sourceCurrency": "text",
      "sourceAmount": 1,
      "destinationCurrency": "text",
      "destinationAmount": 1,
      "state": "IN_PROGRESS",
      "createdDate": "2025-05-23T18:48:34.739Z"
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}

Create exchange

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

OK

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "sourceCurrency": "text",
    "destinationCurrency": "text",
    "amount": 1
  }
}

{
  "id": 1,
  "account": "text",
  "sourceCurrency": "text",
  "sourceAmount": 1,
  "destinationCurrency": "text",
  "destinationAmount": 1,
  "state": "IN_PROGRESS",
  "createdDate": "2025-05-23T18:48:34.739Z"
}

Get average rate for currency pair

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

OK

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

POST /api/v1/exchange/average-rate HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "sourceCurrency": "text",
    "destinationCurrency": "text"
  }
}

{
  "rate": 1
}