Payout

Notice: This article provides a general description of processing payouts in the ecommpay payment platform and covers information about operations utilised to execute a payment of this type and statuses that are assigned to the payment and the operations performed within it.

In addition, use the following materials to gain a fuller understanding of performing payouts:

Payouts—an article that covers performing payouts via Gate and describes requests and callbacks that are used in case of card payments.
articles of the Payment methods section containing a description of performing payouts via Gate with the focus on the specific features of the payment method used and information about relevant requests and callbacks.

Overview

Payout is a payment type which uses one request to make a one-time transfer of funds from merchant to customer.

Basically, the payment platform performs payouts on demand (one-time payments); though, you can implement bulk payouts by using Dashboard. In the latter case, you can have the required payouts generated automatically. For more information about bulk payouts, see Monitoring and performing payments.

Payment model

You initiate a payout by sending a payout request to the payment platform. Once the payment platform receives the request, it creates a payout operation which eventually results in crediting the funds to the customer card or account.

In some cases, a payout may require you to send another request to submit additional information requested by one of the stakeholders, for example to provide cardholder address which is missing from the initial request. In this case, the payment platform sends to the web service a callback with the names of the missing parameters, suspends the payout processing, and waits until the web service submits a clarification request with the values for the missing parameters. The procedure is not currently supported for alternative payment methods.

If the payment system or provider assign the payout the success status but for some reason customer account cannot be credited, a reversal of the payout is initiated within the payment platform after receiving a callback with information about crediting failure. The reversal is performed manually by ecommpay technical support specialists or, for some payment methods, automatically. The reversal is performed by initiating the payout reversal operation.

The rest of this section describes any possible statuses of a payout and operations related with payouts. For more information about how to perform payouts to accounts associated with payment cards, see Payouts. For more information about how to handle payouts by using alternative payment instruments, see Methods.

Payment statuses

The following table describes payout statuses.


`error`	Error occurred when request processing. Payment is not performed.	Final status. The request can be resent with the same payment identifier.
`processing`	Payment is being processed.	Intermediate status
`awaiting clarification`	Payment processing is suspended until the web service submits a `clarification` request—to continue the payment processing—with the required data. If the payment platform does not receive this request within 30 minutes, the status is set to `decline`.	Intermediate status
`decline`	Payment could not be completed.	Final status
`success`	Payment has been completed successfully (confirmed by the payment system or the provider).	Final status. Additionally the payment refund is supported.
`reversed`	Payment has been reversed.	Final status.

The payout operation statuses

The following table describes the statuses of any payout operation.


`processing`	Operation is being processed.	Intermediate status
`awaiting clarification`	Operation processing is suspended until the web service submits a `clarification` request—to continue the payment processing—with the required data. If the payment platform does not receive this request within 30 minutes, the status is set to `decline`.	Intermediate status
`decline`	Operation could not be completed.	Final status
`success`	Operation has been completed successfully.	Final status

The payout reversal operation statuses

The following table describes the statuses of any payout reversal operation.


`processing`	Operation is being processed.	Intermediate status
`decline`	Operation is declined.	Final status
`success`	Operation is completed successfully.	Final status