Settlement Payout API | Calypso Finance Docs

Get a payout

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

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "id": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "id": "text",
  "account": "text",
  "depositAddress": "text",
  "amount": 1,
  "currency": "text",
  "calypsoFee": 1,
  "calypsoFeePercentage": 1,
  "calypsoFeeCurrency": "text",
  "blockchainFee": 1,
  "blockchainFeeCurrency": "text",
  "state": "CREATION_IN_PROGRESS",
  "createdDate": "2025-07-20T06:09:22.822Z",
  "transactionHash": "text",
  "comment": "text",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "errors": {
    "withdrawalErrors": [
      {
        "withdrawalId": "text",
        "errors": [
          {
            "id": 1,
            "status": "SUCCESS",
            "errorResolved": true,
            "errorMessage": "text"
          }
        ]
      }
    ]
  },
  "cancellation": {
    "canceledByUserId": "text",
    "canceledByFirstname": "text",
    "canceledByLastname": "text",
    "cancelMessage": "text"
  }
}

Get a withdrawal

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

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

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

{
  "id": "text",
  "account": "text",
  "withdrawalId": 1,
  "amount": 1,
  "currency": "text",
  "state": "DRAFT",
  "calypsoFee": 1,
  "calypsoFeeCurrency": "text",
  "blockchainFee": 1,
  "blockchainFeeCurrency": "text",
  "transactionHash": "text",
  "depositAddress": "text",
  "comment": "text",
  "createdDate": "2025-07-20T06:09:22.822Z",
  "withdrawalErrors": [
    {
      "id": 1,
      "status": "SUCCESS",
      "errorResolved": true,
      "errorMessage": "text"
    }
  ]
}

Get withdrawals

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

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "stateNames": [
      "DRAFT"
    ],
    "pageNumber": 1,
    "pageSize": 10,
    "dealId": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "result": [
    {
      "id": "text",
      "account": "text",
      "withdrawalId": 1,
      "amount": 1,
      "currency": "text",
      "state": "DRAFT",
      "calypsoFee": 1,
      "calypsoFeeCurrency": "text",
      "blockchainFee": 1,
      "blockchainFeeCurrency": "text",
      "transactionHash": "text",
      "depositAddress": "text",
      "comment": "text",
      "createdDate": "2025-07-20T06:09:22.822Z",
      "withdrawalErrors": [
        {
          "id": 1,
          "status": "SUCCESS",
          "errorResolved": true,
          "errorMessage": "text"
        }
      ]
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}

Get a mass payout

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

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "id": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "id": "text",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "state": "CREATION_IN_PROGRESS",
  "comment": "text",
  "name": "text",
  "currency": "text",
  "totalWithdrawalAmount": 1,
  "totalCalypsoFee": 1,
  "totalCalypsoFeePercentage": 1,
  "calypsoFeeCurrency": "text",
  "blockchainFee": 1,
  "blockchainFeeCurrency": "text",
  "errors": {
    "withdrawalErrors": [
      {
        "withdrawalId": "text",
        "errors": [
          {
            "id": 1,
            "status": "SUCCESS",
            "errorResolved": true,
            "errorMessage": "text"
          }
        ]
      }
    ]
  }
}

Create a mass payout

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

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "withdrawalAddress": "text",
    "currency": "text",
    "name": "text",
    "comment": "text",
    "massAddresses": [
      {
        "depositAddress": "text",
        "amount": 1,
        "comment": "text"
      }
    ],
    "executionDate": "2025-07-20T06:09:22.822Z",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "text"
  }
}

{
  "id": "text",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "state": "CREATION_IN_PROGRESS",
  "comment": "text",
  "name": "text",
  "currency": "text",
  "totalWithdrawalAmount": 1,
  "totalCalypsoFee": 1,
  "totalCalypsoFeePercentage": 1,
  "calypsoFeeCurrency": "text",
  "blockchainFee": 1,
  "blockchainFeeCurrency": "text",
  "errors": {
    "withdrawalErrors": [
      {
        "withdrawalId": "text",
        "errors": [
          {
            "id": 1,
            "status": "SUCCESS",
            "errorResolved": true,
            "errorMessage": "text"
          }
        ]
      }
    ]
  }
}

Cancel mass payout

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

POST /api/v1/settlement/payout/mass/cancel HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "dealId": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "message": "text"
  }
}

{
  "id": "text",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "state": "CREATION_IN_PROGRESS",
  "comment": "text",
  "name": "text",
  "currency": "text",
  "totalWithdrawalAmount": 1,
  "totalCalypsoFee": 1,
  "totalCalypsoFeePercentage": 1,
  "calypsoFeeCurrency": "text",
  "blockchainFee": 1,
  "blockchainFeeCurrency": "text",
  "errors": {
    "withdrawalErrors": [
      {
        "withdrawalId": "text",
        "errors": [
          {
            "id": 1,
            "status": "SUCCESS",
            "errorResolved": true,
            "errorMessage": "text"
          }
        ]
      }
    ]
  }
}

Get mass payouts

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

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "stateNames": [
      "CREATION_IN_PROGRESS"
    ],
    "pageNumber": 1,
    "size": 10
  }
}

{
  "result": [
    {
      "id": "text",
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "account": "text",
      "state": "CREATION_IN_PROGRESS",
      "comment": "text",
      "name": "text",
      "currency": "text",
      "totalWithdrawalAmount": 1,
      "totalCalypsoFee": 1,
      "totalCalypsoFeePercentage": 1,
      "calypsoFeeCurrency": "text",
      "blockchainFee": 1,
      "blockchainFeeCurrency": "text",
      "errors": {
        "withdrawalErrors": [
          {
            "withdrawalId": "text",
            "errors": [
              {
                "id": 1,
                "status": "SUCCESS",
                "errorResolved": true,
                "errorMessage": "text"
              }
            ]
          }
        ]
      }
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}

Create a payout

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

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "withdrawalAddress": "text",
    "depositAddress": "text",
    "amount": 1,
    "currency": "text",
    "comment": "text",
    "executionDate": "2025-07-20T06:09:22.822Z",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "text"
  }
}

{
  "id": "text",
  "account": "text",
  "depositAddress": "text",
  "amount": 1,
  "currency": "text",
  "calypsoFee": 1,
  "calypsoFeePercentage": 1,
  "calypsoFeeCurrency": "text",
  "blockchainFee": 1,
  "blockchainFeeCurrency": "text",
  "state": "CREATION_IN_PROGRESS",
  "createdDate": "2025-07-20T06:09:22.822Z",
  "transactionHash": "text",
  "comment": "text",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "errors": {
    "withdrawalErrors": [
      {
        "withdrawalId": "text",
        "errors": [
          {
            "id": 1,
            "status": "SUCCESS",
            "errorResolved": true,
            "errorMessage": "text"
          }
        ]
      }
    ]
  },
  "cancellation": {
    "canceledByUserId": "text",
    "canceledByFirstname": "text",
    "canceledByLastname": "text",
    "cancelMessage": "text"
  }
}

Cancel payout

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

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "dealId": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "message": "text"
  }
}

{
  "id": "text",
  "account": "text",
  "depositAddress": "text",
  "amount": 1,
  "currency": "text",
  "calypsoFee": 1,
  "calypsoFeePercentage": 1,
  "calypsoFeeCurrency": "text",
  "blockchainFee": 1,
  "blockchainFeeCurrency": "text",
  "state": "CREATION_IN_PROGRESS",
  "createdDate": "2025-07-20T06:09:22.822Z",
  "transactionHash": "text",
  "comment": "text",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "errors": {
    "withdrawalErrors": [
      {
        "withdrawalId": "text",
        "errors": [
          {
            "id": 1,
            "status": "SUCCESS",
            "errorResolved": true,
            "errorMessage": "text"
          }
        ]
      }
    ]
  },
  "cancellation": {
    "canceledByUserId": "text",
    "canceledByFirstname": "text",
    "canceledByLastname": "text",
    "cancelMessage": "text"
  }
}

Get payouts

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

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "stateNames": [
      "CREATION_IN_PROGRESS"
    ],
    "pageNumber": 1,
    "size": 10
  }
}

{
  "result": [
    {
      "id": "text",
      "account": "text",
      "depositAddress": "text",
      "amount": 1,
      "currency": "text",
      "calypsoFee": 1,
      "calypsoFeePercentage": 1,
      "calypsoFeeCurrency": "text",
      "blockchainFee": 1,
      "blockchainFeeCurrency": "text",
      "state": "CREATION_IN_PROGRESS",
      "createdDate": "2025-07-20T06:09:22.822Z",
      "transactionHash": "text",
      "comment": "text",
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "errors": {
        "withdrawalErrors": [
          {
            "withdrawalId": "text",
            "errors": [
              {
                "id": 1,
                "status": "SUCCESS",
                "errorResolved": true,
                "errorMessage": "text"
              }
            ]
          }
        ]
      },
      "cancellation": {
        "canceledByUserId": "text",
        "canceledByFirstname": "text",
        "canceledByLastname": "text",
        "cancelMessage": "text"
      }
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}