Payout

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.

The payment workflow

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. Any further attempts to make the payout, including cases when the payout amount is split, result in multiple operations generated within a single payment (details).

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.

Figure: State diagram for payout

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 Payments by using alternative 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 Payout retries are expected within the payment process. For details, see Payout retries. Intermediate status
awaiting retry 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
partially_paid_out Payment has been partially completed, with the amount split (for details, see Splitting payment amount). Final 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

Related links