circle-dollarPayouts

Create and track on-chain withdrawals from your account, manage signatures, and monitor payout callbacks

A payout is an outgoing on‑chain transfer from your account. Payouts are created in the app and added to the queue with a specific nonce, signed by account members, and executed once the required signatures are collected.

Payout list

On this page, you can view a list of all payouts created for the selected account and network.

The following information is provided about each payout:

Payout ID

The unique system identifier of a payout. This is a link to payout details.

This value is generated automatically and can't be modified.


Created at

The date and time when the payout was created.


Updated at

The date and time of the most recent status change for the payout.


Amount

The payout amount, in the payment currency.


Currency

The payout currency.


Created by

The account name and address of the user who created the payout.


Receiver

The receiver’s address or saved contact name, shown in a short format.


Status

The current payout status.

Possible values:

  • Created: The payout has been initialized in the system but has not yet been signed.

  • Signed: The transaction has received the required number of signatures.

  • Sent: The signed transaction has been sent to the blockchain and is awaiting confirmation.

  • Executed: The transaction has been successfully confirmed on the blockchain and the payout is considered complete.

  • Failed: The transaction failed during signing, sending, or blockchain confirmation.

  • Canceled: The transaction was replaced, rejected, or deleted by a user.


Tracking ID

The user‑provided identifier assigned to the payout for easier locating related payments in external systems.

This value can be specified when creating a payout and can be modified anytime.

Payout details

To access payout details, click a payout ID in the payout list.

In the upper part of the page, you can find essential information about the payout — click the chevron icon to expand it:

  • The payout identifier and current status.

  • The address and name of the user who created the payout.

  • The payout currency.

  • The payout amount in the payment currency.

  • The created and updated timestamps.

  • The receiver name and address in short format.

  • The number of collected and required signatures, for example 3/3.

The information below is divided into tabs.

On this tab, you can view a list of account members that signed the payout.

Common use cases

The Payouts page helps create on‑chain withdrawals, coordinate signatures, and monitor payout callbacks. This section describes common scenarios step by step.

Create a new payout

Create a new payout.

1

Go to Payouts in the main menu.

2

Click Create payout in the upper‑right corner.

3

Fill in the Receiver info:

  • In the Receiver address field, enter the address where funds will be sent.

You can select a receiver from the Address book (if added).

4

Fill in the Payment details:

  • From the Payment currency dropdown, select an asset to be withdrawn.

  • In the Amount field, enter the payout amount in the selected currency.

5

Fill in the Advanced options:

  • In the Nonce field, specify the transaction nonce number used in the queue for this payout. By default, the field is prefilled with the next number in the queue.

circle-info
  • If you leave the value as is, the payout is added as the last transaction in the queue.

  • If you set a value higher than the latest nonce in the queue, the payout is added as a new transaction that will be executed after existing ones.

  • If you set the nonce to match an existing transaction, a replacement transaction is created and both transactions are treated as conflicting in the queue.

  • If you try to set a nonce lower than the first transaction in the queue, the Nonce cannot be lower than first transaction in the queue error appears and the payout can't be created.

  • In the Tracking ID field, optionally enter a payout identifier to track the payout-related transactions in external systems. It can be any combination of numbers and letters, chosen by you for ease of reference.

  • In the Callback URL field, optionally specify a URL for receiving callback notifications about payout events.

6

Click Create and confirm the payout details.

The newly created payout appears in the list with the Created status and is added to the Queue with the specified nonce.

View payout details

View full payout information, including signers and callbacks.

1

Go to Payouts in the main menu.

2

In the payout list, locate the required payout and click its ID to open details.

3

In the upper part of the page, review the payout status, the number of collected and required signatures signatures, and other details.

4

On the Signed by, view the list of members who have already signed the payout.

5

Switch to the Callbacks tab to review callback history.

6

Switch to the Settings tab to view or adjust Tracking ID and Callback URL.

Last updated

Was this helpful?