Settlement Report API
API for getting settlement reports
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
POST /api/v1/settlement/report/outgoing HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 705
{
"account": "text",
"timestamp": 1,
"payload": {
"firstDate": "2025-07-05T17:07:08.997Z",
"lastDate": "2025-07-05T17:07:08.997Z",
"blockchainList": "text",
"zoneOffset": {
"totalSeconds": 1,
"id": "text",
"rules": {
"fixedOffset": true,
"transitions": [
{
"overlap": true,
"duration": {
"seconds": 1,
"zero": true,
"nano": 1,
"negative": true,
"units": [
{
"durationEstimated": true,
"timeBased": true,
"dateBased": true
}
]
},
"gap": true,
"dateTimeAfter": "2025-07-05T17:07:08.997Z",
"dateTimeBefore": "2025-07-05T17:07:08.997Z",
"instant": "2025-07-05T17:07:08.997Z"
}
],
"transitionRules": [
{
"month": "JANUARY",
"timeDefinition": "UTC",
"dayOfWeek": "MONDAY",
"dayOfMonthIndicator": 1,
"localTime": {
"hour": 1,
"minute": 1,
"second": 1,
"nano": 1
},
"midnightEndOfDay": true
}
]
}
}
}
}{
"data": {}
}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
POST /api/v1/settlement/report/incoming HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 705
{
"account": "text",
"timestamp": 1,
"payload": {
"firstDate": "2025-07-05T17:07:08.997Z",
"lastDate": "2025-07-05T17:07:08.997Z",
"blockchainList": "text",
"zoneOffset": {
"totalSeconds": 1,
"id": "text",
"rules": {
"fixedOffset": true,
"transitions": [
{
"overlap": true,
"duration": {
"seconds": 1,
"zero": true,
"nano": 1,
"negative": true,
"units": [
{
"durationEstimated": true,
"timeBased": true,
"dateBased": true
}
]
},
"gap": true,
"dateTimeAfter": "2025-07-05T17:07:08.997Z",
"dateTimeBefore": "2025-07-05T17:07:08.997Z",
"instant": "2025-07-05T17:07:08.997Z"
}
],
"transitionRules": [
{
"month": "JANUARY",
"timeDefinition": "UTC",
"dayOfWeek": "MONDAY",
"dayOfMonthIndicator": 1,
"localTime": {
"hour": 1,
"minute": 1,
"second": 1,
"nano": 1
},
"midnightEndOfDay": true
}
]
}
}
}
}{
"data": {}
}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
POST /api/v1/settlement/report/balance HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 705
{
"account": "text",
"timestamp": 1,
"payload": {
"firstDate": "2025-07-05T17:07:08.997Z",
"lastDate": "2025-07-05T17:07:08.997Z",
"blockchainList": "text",
"zoneOffset": {
"totalSeconds": 1,
"id": "text",
"rules": {
"fixedOffset": true,
"transitions": [
{
"overlap": true,
"duration": {
"seconds": 1,
"zero": true,
"nano": 1,
"negative": true,
"units": [
{
"durationEstimated": true,
"timeBased": true,
"dateBased": true
}
]
},
"gap": true,
"dateTimeAfter": "2025-07-05T17:07:08.997Z",
"dateTimeBefore": "2025-07-05T17:07:08.997Z",
"instant": "2025-07-05T17:07:08.997Z"
}
],
"transitionRules": [
{
"month": "JANUARY",
"timeDefinition": "UTC",
"dayOfWeek": "MONDAY",
"dayOfMonthIndicator": 1,
"localTime": {
"hour": 1,
"minute": 1,
"second": 1,
"nano": 1
},
"midnightEndOfDay": true
}
]
}
}
}
}{
"data": {}
}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
POST /api/v1/settlement/report/all HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 705
{
"account": "text",
"timestamp": 1,
"payload": {
"firstDate": "2025-07-05T17:07:08.997Z",
"lastDate": "2025-07-05T17:07:08.997Z",
"blockchainList": "text",
"zoneOffset": {
"totalSeconds": 1,
"id": "text",
"rules": {
"fixedOffset": true,
"transitions": [
{
"overlap": true,
"duration": {
"seconds": 1,
"zero": true,
"nano": 1,
"negative": true,
"units": [
{
"durationEstimated": true,
"timeBased": true,
"dateBased": true
}
]
},
"gap": true,
"dateTimeAfter": "2025-07-05T17:07:08.997Z",
"dateTimeBefore": "2025-07-05T17:07:08.997Z",
"instant": "2025-07-05T17:07:08.997Z"
}
],
"transitionRules": [
{
"month": "JANUARY",
"timeDefinition": "UTC",
"dayOfWeek": "MONDAY",
"dayOfMonthIndicator": 1,
"localTime": {
"hour": 1,
"minute": 1,
"second": 1,
"nano": 1
},
"midnightEndOfDay": true
}
]
}
}
}
}{
"data": {}
}