Settlement Report API

API for getting settlement reports

Get outgoing report

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

*/*
post
/api/v1/settlement/report/outgoing
POST /api/v1/settlement/report/outgoing HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "firstDate": "2025-10-24T05:16:51.545Z",
    "lastDate": "2025-10-24T05:16:51.545Z",
    "blockchainList": "text",
    "currencyList": "text",
    "zoneOffset": "text"
  }
}
{
  "data": {}
}

Get incoming report

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

*/*
post
/api/v1/settlement/report/incoming
POST /api/v1/settlement/report/incoming HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "firstDate": "2025-10-24T05:16:51.545Z",
    "lastDate": "2025-10-24T05:16:51.545Z",
    "blockchainList": "text",
    "currencyList": "text",
    "zoneOffset": "text"
  }
}
{
  "data": {}
}

Get balance report

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

*/*
post
/api/v1/settlement/report/balance
POST /api/v1/settlement/report/balance HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "firstDate": "2025-10-24T05:16:51.545Z",
    "lastDate": "2025-10-24T05:16:51.545Z",
    "blockchainList": "text",
    "currencyList": "text",
    "zoneOffset": "text"
  }
}
{
  "data": {}
}

Get all transactions report

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

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "firstDate": "2025-10-24T05:16:51.545Z",
    "lastDate": "2025-10-24T05:16:51.545Z",
    "blockchainList": "text",
    "currencyList": "text",
    "zoneOffset": "text"
  }
}
{
  "data": {}
}

Last updated