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 Bulk 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.

In some cases, a COF purchase 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.

Figure: State diagram for payout

The rest of this section describes any possible statuses of a payout and operations related with the payout. For more information about how to perform payouts to accounts associated with payment cards, see Payout. 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 the statuses of any payout.

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 completed successfully. Final status. Additionally the payment refund is supported.

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 completed successfully. Final status

Related links

  • Interaction concepts—the general information about integration with the payment platform by using Gate.
  • Payout—the detailed description of payouts to accounts associated with payment cards.
  • Callbacks—the section about callbacks usage.
  • Information of operations performing—the section with the information about error codes in the payment platform.