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.
Payment model
You initiate a payout by sending a payout request to the payment platform, opening the payment form in the Payout mode, or selecting the corresponding action in the Payouts section of the Dashboard interface. Once the payment platform receives the payout 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 currently not supported for alternative payment methods.
If a payment system or a provider assigns the payout the success status but for some reason the customer's account cannot be credited, a reversal of the payout is initiated in the payment platform after receiving a callback with information about crediting failure. The reversal is performed manually by the 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 the payout. More information about processing payouts using payment card is provided in the Payment Page, Gate, and Dashboard sections, while the information about processing payouts with the use of alternative payment instruments is provided in the Payment methods section.
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 and reattempt to perform the payment. |
awaiting payout completion |
Payment processing has been initiated, awaiting the payout confirmation by the customer. | Intermediate status |
processing |
Payment is being processed. | Intermediate status |
awaiting clarification |
Operation processing is suspended until the payment platform receives the additional information from the customer. If the payment platform does not receive the required information 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. | 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.
awaiting payout completion |
Operation processing has been initiated, awaiting the payout confirmation by the customer. | Intermediate status |
processing |
Operation is being processed. | Intermediate status |
awaiting clarification |
Operation processing is suspended until the payment platform receives the additional information from the customer. If the payment platform does not receive the required information 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. | Final status |