Skip to content

Payout Invoice


There are three types of outgoing transactions that occur in

  • Payout

    A Payout is a low-level operation that initiates a financial transaction in the defined payment provider using the specified payout method, it simply provides communication with an external provider and the mapping of statuses. Payout refers to the financial return or monetary disbursement of investment or annuity.

  • Request

    A Payout Request is an operation with rich functionality that initiates one or many payouts depending on the conditions set in the routing and exchange rate schemes.

  • Invoice

    A Payout Invoice is a high-level operation that initiates accompanying Payout Request and Ledger account transactions.

The Payout Invoice includes information on the amount, currency, service, commission, exchange rate and other properties.

In contradistinction to Payment Invoice — Payout Invoice has AUTOPROCESS property. It means that this type of commerce operations can be processed as automaticaly as manualy.


The full list of properties can be found in the API Reference launch .


Payout Invoice Flow

New UI

Status list

Below is a list of statuses and it's descriptions:

Code Final Description
created No Initial status after a Payout Invoice is created, processing has not started. If will not return response 201 (Created) HTTP status code on your request, you should consider that the payout invoice was failed to be created
expired Yes Means the Payout Invoice hit the lifetime limit (configurable in the 'Invoice lifetime' property) without being successfully processed, but also did not either cancelled or terminated, e.g. your customer has abandoned the payout
terminated Yes Means that the payout process was terminated by a payer prior to the payout invoice lifetime limit
processing No Signifies that the payout invoice is processing by but its processing is not finished and there will be further status updates
process_pending No Means that the result of the payout process still being unknown and may not be known for an extended period of time
processed No Confirms the payout has been processed successfully. This isn't a final status since the payout can be canceled for different reasons
partially_processed No Means that the actual amount is less than the payout invoice amount and that amount is successfully processed
process_error No
process_failed Yes Signifies that the Payout Invoice processing has failed, may be set when an error occurs and the corresponding payout request has failed. This status is considered final due to the maximum number of attempts has been reached (default – 5 attempts)
canceling No Means the payout invoice is canceling and the result of the payout invoice canceling still being unknown
cancel_pending No Means that the result of the payout canceling still being unknown and may not be known for an extended period of time
partially_canceled Yes Means that the amount canceled is less than the payout invoice amount and that amount is successfully canceled.
canceled Yes Means the payout invoice is successfully canceled in full
cancel_error No
cancel_failed Yes Means that the payout invoice canceling has been failed or cannot be completed


Payout Invoice is located in Operations section. This entity includes List, Overview and Creating screens.


This screen contains an enumeration of transactions with main properties, such as Commerce account, Payout Method, Amount, Currency, Current status, Resolution, Created time.

It also contains filters and search features to facilitate use.

Payout Invoice Overview

Payout Invoice


This action consists of 3 stages:

  • Create : this stage requires the setting of Invoice proerties and parameters. It contains basic properties and options.


    Hover over the option label to see info tooltip!

    Payout Invoice Creating: Create

    Payout Invoice

    Payout Invoice

  • Confirm : this stage is intended to get user ensured that all data is correct and functionality for manual process

    Payout Invoice Creating: Confirm

    Payout Invoice

  • Result : contains processing data

    Payout Invoice Creating: Result

    Payout Invoice


Overview page is intended to display detailed info about:

  • Operation states
  • Amounts
  • Service, Method, Provider
  • Related entities etc.

Payout Invoice Overview

Payout Invoice


To configure the payout invoice set necessary properties at Commerce Account Payout options page:

  1. Navigate to the Commerce accounts
  2. Go to the Setting of neccessary one
  3. Find Payout Options section
  4. Set property value

Payout Options

Payout Invoice


Do not forget to Save changes!

Payout options table

Option Description
Public Zero-Fee badge Wheather to give a sign "without commission" for each service through the Public API.
Public fee details Wheather to give detailed commission values for each service through the Public API.
Moderation required Do not perform an operation without manual moderation
Allow partially Partial processing allowed
Parallel mode Parallel or sequential processing strategy
Split mode Allow the splitting of operation when exceeding the amount limit
Include commission Put the commission in the payout amount and calculate it from the amount of the write-off
Expose internal callback data Expose internal callback data
Invoice lifetime Set operation expiration time based on creation. Expires = created + lifetime
Attempts limit How many times processor will try to create new operation based on failed status
Descriptor template Operation descriptor generation template for processing provider