Important announcement: API v3 launch! Review the changes and update your integrations by Dec 1, 2025 before old API shutdown
API guide v3
LogoLogo
Release notesHomepageTry demo
  • Welcome to B2BINPAY docs
  • Get started
    • Quick start guide
    • Explore the Web interface
  • User guide
    • Wallet management
      • Wallets
      • Transfers
      • Deposits
      • Payouts
      • Events
      • Callbacks
    • Custody
      • Wallets
      • Requests
      • History
    • Staking
      • TRX staking
    • Rates
    • Swaps
      • Wallets
      • Swap
      • History
  • How-tos
    • Manage your profile and system
      • How to change your password
      • How to enable 2FA
      • How to whitelist IP addresses
      • How to access the API
      • How to enable additional AML check
    • Manage your wallets
      • How to create a wallet
      • How to grant access to your wallet
      • How to manage user roles
      • How to restrict access to your wallet
      • How to generate a report on wallet balances
      • How to set withdrawal thresholds
    • Manage your assets
      • How to create a deposit
      • How to create a payout
      • How to create a bank withdrawal
      • How to create an internal transfer
      • How to select the optimal blockchain fee
      • How to speed up your payout by changing the blockchain fee
      • How to whitelist a payout address
      • How to swap funds
      • How to top up or withdraw funds from your Custody wallet
  • API guide
    • API overview
    • Authentication
    • Wallet methods
    • Transfer methods
    • Deposit methods
    • Payout methods
    • Currency methods
    • Rate methods
  • API guide v2 [DEPRECATED]
    • API overview
    • Authentication
    • Wallet methods
    • Transfer methods
    • Deposit methods
    • Payout methods
    • Currency methods
    • Rate methods
  • References
    • Key terms
    • User roles
    • Transfer types
    • Currency codes
    • Block explorer list
    • Address types
    • Useful links
  • Troubleshooting
    • Error: No active account found with the given credentials
    • Error: Invalid 2FA code
    • Error: You IP is not whitelisted
    • Unresolved deposits
    • Missing deposits
    • Canceled transfers
    • Unconfirmed transfers
  • Release notes
Powered by GitBook
On this page
  • Payout list
  • Payout details

Was this helpful?

  1. User guide
  2. Wallet management

Payouts

PreviousDepositsNextEvents

Last updated 3 months ago

Was this helpful?

Payout are payments, withdrawals, and transfers made from your wallets.

Key points

  • The system supports payouts in crypto currencies. For denominated in fiat currencies, the system supports in fiat currencies with various options: one-time withdrawals and regular withdrawals of a fixed or floating amount.

  • For , the payment currency must always match the wallet currency. For Merchant wallets, the payment currency may differ from the wallet currency.

  • Payouts involving Enterprise wallets are always . Payouts between B2BINPAY Merchant wallets can be .

  • Internal transfers are possible between Merchant wallets denominated in the same currency and belonging to the same Owner. The internal transfers are executed off-chain, no commission is charged.

  • Each on-chain transaction requires a certain number of blockchain . This number is specified for each currency in the B2BINPAY Back Office. Until the required number of confirmations is received, the transfer is assigned the Unconfirmed status. When creating a payout, you can overwrite this setting by specifying the Required block confirmations value. In this case, the payment is assigned the Confirmed status once the specified number is achieved.

  • The processing speed of a transaction on the blockchain depends on the amount. You can choose the fee amount when creating a payout.

  • Information about new transfers associated with a payout can be sent to your system via a .

  • Each payout can be assigned a special identifier by which the related transactions can be tracked in an external system.

  • You can save frequently used addresses to the Address book to save up time when creating regular payouts.

Payout list

On this page, you can view a list of all payout from your wallets.

The following information is provided about each payout:

ID

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

This value is generated automatically at the moment of payout creation and can’t be changed.


Created

The date and time when a payout was created.


Label

The tag or name assigned to a payout for easier locating it in the system.

This value is set when creating a payout and can be changed anytime.


Wallet type

The type of a wallet from which the payout was made.


Wallet

The label or system identifier of a wallet from which the payout was made. This is a link to wallet details.


Receiver

The blockchain address (abridged) of a receiver’s wallet. This is a link to the explorer.


Receiver (full)

The blockchain address (full) of a receiver’s wallet. This is a link to the explorer.


Status

The current payout status. Possible values:

  • Waiting for approval: For a payout created by a user with the Withdrawal with approval role: the payout was created and awaits the approval.

  • Approved: The payout was approved.

  • Canceled: The payout was canceled.


Currency

The payment currency.

For Enterprise wallets, always the same as the wallet currency. For Merchant wallets, may differ from the wallet currency.


Tracking ID

The unique user-provided identifier assigned to a payout for easier locating it in external systems.

This value is set when creating a payout and can be changed anytime.


Amount

The payout amount, in the payment currency.


Charged amount

The payout amount, in the wallet currency, including commissions charged.


Updated

The date and time when the payout status was last updated.

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, label (if set), and current status.

  • The information about your wallet: the wallet identifier, label (if set), type (E for Enterprise and M for Merchant), and current balance.

  • The payment currency.

  • The paid amount in the payment currency.

  • The total commission amount charged for payout processing.

  • The destination address.

The information below is divided into tabs:

On this tab, you can access and change payout settings.

Label

The tag or name assigned to a payout for easier locating it in the system.


Tracking ID

The unique user-provided identifier assigned to a payout for easier locating it in external systems.


Callback URL

The URL for callback notifications on new transactions.


Required block confirmations for callback

The number of confirmations needed to receive an additional callback.

If this field is not empty, two callbacks are sent: upon receiving the number of confirmations specified here and upon receiving the number of confirmations specified in the system settings. The corresponding transaction is assigned the Confirmed status as soon as the number of confirmations specified in this field is received.


Receiver

The receiver type (natural or legal person) and name.


Address

The receiver’s address, as defined by postal services.

On this tab, you can find a list of transactions associated with the payout.

ID

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


Created

The date and time when a transaction was received by B2BINPAY.


TXID

The blockchain transaction identifier, the same as the transaction hash. This is a link to the explorer.


Status

The current status of a transfer. Possible values:

  • Canceled: The transfer was canceled due to security reasons or a transfer amount being too small.

  • Blocked: The transfer was considered suspicious during the AML check and is temporarily blocked until further Compliance verification.

  • Failed: The transfer has failed on the blockchain.

  • Created: The transfer has been created and is currently in the queue for processing, the status will be changed soon.

  • Unconfirmed: The transfer hasn’t yet received the required number of block confirmations.

  • Confirmed: The required number of block confirmations has been received and the transfer is completed.


Confirmations

The current number of received confirmations on the blockchain. Applicable only for on-chain transactions.


Amount

The transaction amount, in the payment currency.


Amount target

The transaction amount, in the wallet currency.


Rate target

If the payment currency differs from the wallet currency, this is the exchange rate of the payment currency to the wallet currency, valid at the moment of the transaction execution.

If the payment currency is the same as the wallet currency, this value is equal to 1.


Commission

The fee charged by B2BINPAY for transaction processing, in the payment currency.


Currency

The payment currency.

On this tab, you can view the payout history.

Created

The date and time of an action.


Initiator

The performer of an action. Possible values:

  • System: System actions, such as wallet creation or status changing.

  • API: Actions performed via the API.

  • Email address: Actions performed by a specific user via the user interface.


Reason

The action type. Possible values:

  • Created: The payout has been created.

  • Changed: The payout has been changed.

  • Deleted: The payout has been deleted.


Comment

The description of the action.


Field name

The field that has been changed as a result of the action.


Old value

The previous state of the field.


Actual value

The new state of the field.

See also:

Merchant wallets
Bank withdrawal
Enterprise wallets
on-chain
off-chain
confirmations
blockchain fee
callback
How to create a payout
How to create a bank withdrawal
How to create an internal transfer
How to select the optimal blockchain fee
How to speed up your payout by changing the blockchain fee