Exchange API

API for exchanges

Pre-calculate the exchange

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

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

*/*

Response to pre-calculate exchange

sourceCurrencystringRequired

Source currency

destinationCurrencystringRequired

Destination currency

amountnumberRequired

Destination amount

directionstring · enumRequired

Exchange direction

Possible values:

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/exchange/pre-calculate

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: 129

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

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

Get currency pairs

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

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

*/*

Currency pairs

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/exchange/pairs

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": [
      "text"
    ]
  }
}

Get upper exchange limit by currency

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

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

*/*

Exchange limit by currency

sourceCurrencystringRequired

Exchange currency

destinationCurrencystringRequired

minLimitnumberRequired

Minimum amount

maxLimitnumberRequired

Maximum amount

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/exchange/limit

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": "text",
  "minLimit": 1,
  "maxLimit": 1
}

Get exchange

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

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

*/*

Exchange

idinteger · int64Required

Exchange id

accountstringRequired

Account

sourceCurrencystringRequired

Source currency

sourceAmountnumberRequired

Source amount

destinationCurrencystringRequired

Destination currency

destinationAmountnumberOptional

Destination amount

statestring · enumRequired

Exchange state

Possible values:

createdDatestring · date-timeRequired

Exchange creation date

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/exchange/get

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": "2026-02-27T20:12:16.834Z"
}

Find exchange by filter

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

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

*/*

Object with page details

pageinteger · int32Required

Numeric value indicating the page number

sizeinteger · int32Required

Numeric value indicating the page size

totalinteger · int32Required

Total number of pages matching the query

totalElementsinteger · int64Required

Total number of objects matching the query

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/exchange/filter

HTTPcURLJavaScriptPython

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "createdDate": {
      "period": {
        "firstDate": "2026-02-27T20:12:16.834Z",
        "secondDate": "2026-02-27T20:12:16.834Z"
      },
      "date": "2026-02-27T20:12:16.834Z"
    },
    "state": [
      "IN_PROGRESS"
    ],
    "pageNumber": 1,
    "pageSize": 10,
    "sort": "ASC",
    "properties": "text"
  }
}

{
  "result": [
    {
      "id": 1,
      "account": "text",
      "sourceCurrency": "text",
      "sourceAmount": 1,
      "destinationCurrency": "text",
      "destinationAmount": 1,
      "state": "IN_PROGRESS",
      "createdDate": "2026-02-27T20:12:16.834Z"
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}

Create exchange

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

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

*/*

Exchange

idinteger · int64Required

Exchange id

accountstringRequired

Account

sourceCurrencystringRequired

Source currency

sourceAmountnumberRequired

Source amount

destinationCurrencystringRequired

Destination currency

destinationAmountnumberOptional

Destination amount

statestring · enumRequired

Exchange state

Possible values:

createdDatestring · date-timeRequired

Exchange creation date

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/exchange/create

HTTPcURLJavaScriptPython

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "sourceCurrency": "text",
    "destinationCurrency": "text",
    "amount": 1,
    "direction": "SOURCE",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "id": 1,
  "account": "text",
  "sourceCurrency": "text",
  "sourceAmount": 1,
  "destinationCurrency": "text",
  "destinationAmount": 1,
  "state": "IN_PROGRESS",
  "createdDate": "2026-02-27T20:12:16.834Z"
}

Get average rate for currency pair

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

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

*/*

Average rate

ratenumberRequired

Rate

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/exchange/average-rate

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
}