Payouts
General information
Clients can withdraw funds from their wallets by creating payout requests.
A payout request is accepted or declined. The request can be declined due to the following reasons: the blockchain fee is too low, the debiting address is incorrect, the client has no permission to make payouts, and others.
If the payout request meets all the requirements, it is accepted, and the payout transaction is created.
On the Payouts page, you can find information about all payouts made in the system.
To filter the page data, click the down arrow located at the top of the table and adjust the following filter parameters:
ID — the system identifier of a payout.
Address — the payout address.
Wallet — the name of the wallet from which a payout was made.
Label — the payout name in the system.
Currency — the payout currency.
Tracking id — the payout identifier specified by the client to track the payout in the client’s system.
Company — the name of the company of the client who made the payout.
Created at from — specify the starting date of the range.
to — specify the end date of the range.
Click the check mark icon to apply the filters. To reset filters, click the cross icon.
On the Adminisitrative > Payouts tab, the following information is provided about each payout:
- ID
The system identifier of a payout.
- Label
The payout name in the system.
- Amount
The amount withdrawn by a client.
- Fee
The payout fee. Additionally, the field indicates whether the fee is included in the payout amount.
- Currency
The payout currency.
- Address
The payout address.
- Wallet
The name of the wallet from which a payout was made. This is a link to the wallet’s details.
- Tracking ID
The payout identifier specified by the client to track the payout transaction in the client’s system.
- Status
The payout status. Possible values:
Approved — a payout request is approved.
Waiting for approve — a payout request is waiting for approval. For example, this status applies to payout transactions created by the clients assigned the Withdrawals with approval role.
Canceled — a payout request is declined.
- Created at
The date and time when the payout request was created.
- Export payouts
Click this button to download the up-to-date payouts report or subscribe to automatically receive scheduled reports. For more details, see Reports and Subscriptions.
Payout details
To view the detailed information about a specific payout, click the payout ID.
The details page is divided into the Info, Transfers, and Operating log tabs. To navigate between them, click the menu button (☰) displayed in the right part of the page.
Info tab
On this tab, you can find general information about the payout.
On the left part of the Info tab, you can view and update the following information:
- Label
The payout name in the system.
- Tracking ID
The payout identifier specified by the client to track the payout transaction in the client’s system.
- Callback url
The URL address for sending notifications about payout updates to a client.
- Number of confirmations to send additional callback
The number of block confirmations specified by a client. After the transaction receives the specified number of confirmations, the client gets an additional callback.
If you updated any of the fields, click Save to apply the changes.
On the right part of the Info tab, you can view the payout address, identifier, status, currency, and indication of whether the payout fee is included in the payment. You can copy the payout address by clicking the copy icon. To navigate to the explorer, click the link icon.
Here, you can also view the following essential information about the payout:
- Commission
The amount of the commission for a payout operation.
- Charged pending
The amount that was charged from a client’s wallet but hasn’t yet been confirmed.
- Blockchain fees
The amount of the blockchain fee.
- Amount
The amount withdrawn from a client’s wallet.
- Charged from the wallet
The total amount withdrawn from a client’s wallet including the blockchain fee.
In the lower part of the page you can find general information about the payout:
- Created at
The date and time when the payout request was created.
- Updated at
The date and time when the payout request was updated.
- Wallet
A link to the wallet details.
- Applicant
The email of a client who made the payout.
- Requested rate [TBD](Requested rate VS rate?)
The rate at which the payout was made.
- Requested fee rate
The rate of the blockchain fee.
- Rate [TBD]
The rate at which the payout was made.
Transfers tab
On this tab, you can find the same information as at the left part of the Info tab.
Operation log tab
On this tab, in addition to the general payout information, you can view the log of event notifications related to the selected payout.
Each notification indicates the event name, the reason why the notification was sent, the event initiator, as well as the date and time when the event occurred.
Create a new payout
Create a new payout as follows:
Click the New button located in the top right corner of the page.
Fill in the following fields.
For enterprise clients:
Label — specify a short name for the payout.
Wallet — select the wallet from the list.
Address — specify the wallet address.
Amount — specify the payout amount.
Callback URL — specify the URL for sending notifications about payout updates to a client.
For merchant clients:
Label — specify a short name for the payout.
Wallet — select the wallet from the list.
Invoice - select the invoice from the list.
Currency — select the currency from the list.
Address — specify the wallet address.
Amount — specify the payout amount.
Callback URL — specify the URL for sending notifications about payout updates to a client.
Click Save.