Settlement Payout API

API for settlement payout

Get a payout

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 with payout data

idstringRequired

Payout id

accountstringRequired

Merchant account ID

depositAddressstringRequired

Crypto address for deposit

amountnumberRequired

Withdrawal amount

currencystringRequired

This is the currency associated with the amount field

feenumberRequired

Service fee for the payout

feePercentagenumberRequired

Service fee in percentages

feeCurrencystringRequired

Service fee currency for the payout

blockchainFeenumberOptional

Blockchain fee

blockchainFeeCurrencystringOptional

Blockchain fee currency

statestring · enumRequired

Represents status of the payout

Possible values:

createdDatestring · date-timeRequired

Time of payout creation

transactionHashstringOptional

Hash of the transaction in blockchain

commentstringOptional

Comment for the payout

idempotencyKeystring · uuidOptional

The external id that can be generated by user while creating the payout in the uuid format

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/settlement/payout

HTTPcURLJavaScriptPython

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",
  "fee": 1,
  "feePercentage": 1,
  "feeCurrency": "text",
  "blockchainFee": 1,
  "blockchainFeeCurrency": "text",
  "state": "CREATION_IN_PROGRESS",
  "createdDate": "2026-02-27T17:15:18.910Z",
  "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

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 with withdrawal data

idstringRequired

Id of the payout includes this transaction

accountstringRequired

Merchant account ID

withdrawalIdinteger · int64Optional

Transaction id

amountnumberRequired

Withdrawal amount

currencystringRequired

This is the currency associated with the amount field

statestring · enumRequired

Represents status of the withdrawal

Possible values:

feenumberRequired

Service fee for the withdrawal

feeCurrencystringRequired

Service fee currency for the withdrawal

blockchainFeenumberOptional

Blockchain fee

blockchainFeeCurrencystringOptional

Blockchain fee currency

transactionHashstringOptional

Transaction hash

depositAddressstringRequired

Recipient's crypto-address

commentstringOptional

Comment for the transaction

createdDatestring · date-timeRequired

Time of payout creation

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/settlement/payout/withdrawals

HTTPcURLJavaScriptPython

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",
  "fee": 1,
  "feeCurrency": "text",
  "blockchainFee": 1,
  "blockchainFeeCurrency": "text",
  "transactionHash": "text",
  "depositAddress": "text",
  "comment": "text",
  "createdDate": "2026-02-27T17:15:18.910Z",
  "withdrawalErrors": [
    {
      "id": 1,
      "status": "SUCCESS",
      "errorResolved": true,
      "errorMessage": "text"
    }
  ]
}

Get withdrawals

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/settlement/payout/withdrawals/all

HTTPcURLJavaScriptPython

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",
      "fee": 1,
      "feeCurrency": "text",
      "blockchainFee": 1,
      "blockchainFeeCurrency": "text",
      "transactionHash": "text",
      "depositAddress": "text",
      "comment": "text",
      "createdDate": "2026-02-27T17:15:18.910Z",
      "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

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 with mass payout data

idstringRequired

Payout id

idempotencyKeystring · uuidRequired

The external id in the uuid format that can be generated by user while creating the payout

companyIdstring · uuidRequired

Id of the company created mass payout

accountstringRequired

Merchant account ID

statestring · enumRequired

Represents status of the payout

Possible values:

commentstringRequired

Comment for the payout

namestringOptional

Name of the payout

currencystringOptional

Payout currency

totalWithdrawalAmountnumberOptional

Total amount of all transactions in a mass payout

totalFeenumberOptional

Total service fee for the mass payout

totalFeePercentagenumberOptional

Total service fee for the mass payout in percentages

feeCurrencystringOptional

Service fee currency

blockchainFeenumberOptional

Blockchain fee

blockchainFeeCurrencystringOptional

Blockchain fee currency

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/settlement/payout/mass

HTTPcURLJavaScriptPython

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,
  "totalFee": 1,
  "totalFeePercentage": 1,
  "feeCurrency": "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

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 with mass payout data

idstringRequired

Payout id

idempotencyKeystring · uuidRequired

The external id in the uuid format that can be generated by user while creating the payout

companyIdstring · uuidRequired

Id of the company created mass payout

accountstringRequired

Merchant account ID

statestring · enumRequired

Represents status of the payout

Possible values:

commentstringRequired

Comment for the payout

namestringOptional

Name of the payout

currencystringOptional

Payout currency

totalWithdrawalAmountnumberOptional

Total amount of all transactions in a mass payout

totalFeenumberOptional

Total service fee for the mass payout

totalFeePercentagenumberOptional

Total service fee for the mass payout in percentages

feeCurrencystringOptional

Service fee currency

blockchainFeenumberOptional

Blockchain fee

blockchainFeeCurrencystringOptional

Blockchain fee currency

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/settlement/payout/mass/create

HTTPcURLJavaScriptPython

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": "2026-02-27T17:15:18.910Z",
    "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,
  "totalFee": 1,
  "totalFeePercentage": 1,
  "feeCurrency": "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

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 with mass payout data

idstringRequired

Payout id

idempotencyKeystring · uuidRequired

The external id in the uuid format that can be generated by user while creating the payout

companyIdstring · uuidRequired

Id of the company created mass payout

accountstringRequired

Merchant account ID

statestring · enumRequired

Represents status of the payout

Possible values:

commentstringRequired

Comment for the payout

namestringOptional

Name of the payout

currencystringOptional

Payout currency

totalWithdrawalAmountnumberOptional

Total amount of all transactions in a mass payout

totalFeenumberOptional

Total service fee for the mass payout

totalFeePercentagenumberOptional

Total service fee for the mass payout in percentages

feeCurrencystringOptional

Service fee currency

blockchainFeenumberOptional

Blockchain fee

blockchainFeeCurrencystringOptional

Blockchain fee currency

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/settlement/payout/mass/cancel

HTTPcURLJavaScriptPython

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,
  "totalFee": 1,
  "totalFeePercentage": 1,
  "feeCurrency": "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

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/settlement/payout/mass/all

HTTPcURLJavaScriptPython

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,
      "totalFee": 1,
      "totalFeePercentage": 1,
      "feeCurrency": "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

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 with payout data

idstringRequired

Payout id

accountstringRequired

Merchant account ID

depositAddressstringRequired

Crypto address for deposit

amountnumberRequired

Withdrawal amount

currencystringRequired

This is the currency associated with the amount field

feenumberRequired

Service fee for the payout

feePercentagenumberRequired

Service fee in percentages

feeCurrencystringRequired

Service fee currency for the payout

blockchainFeenumberOptional

Blockchain fee

blockchainFeeCurrencystringOptional

Blockchain fee currency

statestring · enumRequired

Represents status of the payout

Possible values:

createdDatestring · date-timeRequired

Time of payout creation

transactionHashstringOptional

Hash of the transaction in blockchain

commentstringOptional

Comment for the payout

idempotencyKeystring · uuidOptional

The external id that can be generated by user while creating the payout in the uuid format

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/settlement/payout/create

HTTPcURLJavaScriptPython

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": "2026-02-27T17:15:18.910Z",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "text"
  }
}

{
  "id": "text",
  "account": "text",
  "depositAddress": "text",
  "amount": 1,
  "currency": "text",
  "fee": 1,
  "feePercentage": 1,
  "feeCurrency": "text",
  "blockchainFee": 1,
  "blockchainFeeCurrency": "text",
  "state": "CREATION_IN_PROGRESS",
  "createdDate": "2026-02-27T17:15:18.910Z",
  "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

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 with payout data

idstringRequired

Payout id

accountstringRequired

Merchant account ID

depositAddressstringRequired

Crypto address for deposit

amountnumberRequired

Withdrawal amount

currencystringRequired

This is the currency associated with the amount field

feenumberRequired

Service fee for the payout

feePercentagenumberRequired

Service fee in percentages

feeCurrencystringRequired

Service fee currency for the payout

blockchainFeenumberOptional

Blockchain fee

blockchainFeeCurrencystringOptional

Blockchain fee currency

statestring · enumRequired

Represents status of the payout

Possible values:

createdDatestring · date-timeRequired

Time of payout creation

transactionHashstringOptional

Hash of the transaction in blockchain

commentstringOptional

Comment for the payout

idempotencyKeystring · uuidOptional

The external id that can be generated by user while creating the payout in the uuid format

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/settlement/payout/cancel

HTTPcURLJavaScriptPython

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",
  "fee": 1,
  "feePercentage": 1,
  "feeCurrency": "text",
  "blockchainFee": 1,
  "blockchainFeeCurrency": "text",
  "state": "CREATION_IN_PROGRESS",
  "createdDate": "2026-02-27T17:15:18.910Z",
  "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

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/settlement/payout/all

HTTPcURLJavaScriptPython

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",
      "fee": 1,
      "feePercentage": 1,
      "feeCurrency": "text",
      "blockchainFee": 1,
      "blockchainFeeCurrency": "text",
      "state": "CREATION_IN_PROGRESS",
      "createdDate": "2026-02-27T17:15:18.910Z",
      "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
}