Single Payout

Single payouts allow you to send funds to your clients or to your own blockchain addresses. This feature also includes pre-calculated fees and enabled confirmations for increased security of your funds and transactions.

Process description

1

Check account balance and ensure enough funds for payouts are available by using the method - [POST] account

2

You can pre-calculate commissions using a special feature - Commission pre-calculation

3

Create the payout by using the method - [POST] payout/create

• After creating a payout request, you will receive a webhook - PAYOUT_CHANGE_STATUS (state: CREATED)

4

If you have payout verification enabled, you will receive a webhook - PAYOUT_CHANGE_STATUS (state: PENDING_CONFIRMATION)

• Once the payout is confirmed, you will receive a webhook - PAYOUT_CONFIRMED

• If your payout was declined, you will receive a webhook - PAYOUT_CHANGE_STATUS (state: CANCELED)

5

Once your payout request is processed, you will receive a webhook - PAYOUT_CHANGE_STATUS (state: IN_PROGRESS)

• If these payout are not validated before being created on the network, you will receive a webhook - PAYOUT_VALIDATION_ERROR

• If there are any issues with the payout and it is not processed, you will receive a webhook - PAYOUT_CHANGE_STATUS (state: FAILED)

6

After a successful payment, you will receive a webhook - PAYOUT_CHANGE_STATUS (state: COMPLETED)

7

Get the data on the payout and its status by using the method - [POST] payout

Sequence

Names of requests on the scheme indicate certain payout API methods.

Payout statuses

Diagram nodes indicate payout statuses, arrows indicate processes a successful completion of which transfers a payout from one status to another.

Status	Description
CREATED	A payout is created.
PENDING_CONFIRMATION	A payout is created via UI and is awaiting confirmation from other process participants.
CONFIRMED	• A payout is created via UI and confirmed by other process participants. • A payout created via API is automatically created with this status.
CANCELED	A payout has been canceled by merchant.
IN_PROGRESS	• Transaction for a payout is created and is awaiting to be sent to the network. •Transaction for a payout is sent to the network to be sent to a block and is awaiting confirmation from nodes.
FAILED	An error occurred when sending funds. There can be many reasons of the error. You may follow these remediation steps: 1. Wait a while and create a new similar payout. 2. Contact our technical support.
COMPLETED	Funds are successfully credited to destination wallet.

Request examples

New Payout - [POST] payout/create

Request:

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "depositAddress": "text",
    "amount": 1,
    "currency": "text",
    "comment": "text",
    "executionDate": "2025-10-29T11:20:32.438Z",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "text"
  }
}

Response 200 OK:

{
  "id": "text",
  "account": "text",
  "depositAddress": "text",
  "amount": 1,
  "currency": "text",
  "calypsoFee": 1, - [deprecated]
  "fee": 1,
  "calypsoFeePercentage": 1, - [deprecated]
  "feePercentage": 1,
  "state": "CREATION_IN_PROGRESS",
  "createdDate": "2025-11-17T09:55:55.567Z",
  "transactionHash": "text",
  "comment": "text",
  "executionDate": "2025-11-17T09:55:55.567Z",
  "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"
  },
  "belongingType": "INTERNAL"
}