One-time one-step purchase

Notice: This article provides a general description of processing one-time one-step purchases 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 processing one-time one-step purchases:

One-step purchase—an article that covers processing one-time one-step purchases 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 processing one-time one-step purchases via Gate with the focus on the specific features of the payment method used and information about relevant requests and callbacks.

Overview

One-time one-step purchase is a payment type which uses only one request to make a one-time transfer of funds from customer to merchant. This is the most basic purchase type in which the customer card or account is immediately debited for the amount of the purchase, for example to pay for an item of goods.

Payment model

You initiate one-step purchase by sending a sale request to the payment platform. Once the payment platform receives the request, it creates a sale operation which eventually results in debiting the customer card or account.

A one-step purchase may require the merchant to send the following additional requests:

If the payment requires customer to be authenticated by using the 3‑D Secure technology, the payment platform sends to the web service a callback that contains the data required to generate a request to the issuer, suspends the purchase processing, and waits until the web service submits a 3ds_result request with the authentication results.
If the payment requires customer to be authenticated by the payment system on merchant's request, the payment platform receives a callback from the payment system and sends to the web service a callback with notification that authentication is required, and then suspends the payment processing and waits until the web service submits the following two merchant_auth requests: the start request—after customer confirms payment and finish—after customer enters validation code.
If any payment stakeholder requests additional information (for example, the payment system may request cardholder address which was missing from the initial request), the payment platform sends to the web service a callback that lists the requested parameters, suspends the purchase processing, and waits until the web service submits a clarification request with the requested information.

If the payment method supports the capability of confirming that the funds were transferred to the payment recipient, then, after the sale operation has been completed, the payment confirmation operation is initiated in the payment platform. It results in receiving such a confirmation from the provider.

If the payment method supports refunds, after completing a one-time one-step purchase you can return your customers their money, if needed. You initiate a refund by sending a refund request to the payment platform. Refund is performed by using one of the following operations:

reversal—this operation is used when refund is performed on the same day as the initial purchase.
refund—this operation is used when refund is performed after the business day of the initial purchase is closed.

In addition, the reversal operation can be initiated when the purchase is assigned the success status following the confirmation from the payment system or the provider, but the funds cannot be transferred to the payment recipient.

Figure 1. State diagram for one-time one-step purchase

The rest of this section describes any possible statuses of a one-time one-step purchase and operations related with the purchase. For more information about how to perform one-time one-step purchases with payment cards, see One-step purchase. For more information about how to perform one-time one-step purchases by using alternative payment instruments, see Methods.

Payment statuses

The following table describes the statuses of a one-time one-step purchase.


`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 3ds result`	Payment processing is suspended until the web service submits a `3ds_result` request with the authentication result. If the payment platform does not receive this request within the required timeout time, then the payment status is set to `decline`. Normally, the timeout is 30 minutes, but it may differ depending on provider. For more information about specific timeouts, contact technical support at support@ecommpay.com.	Intermediate status
`awaiting merchant auth`	Payment processing is suspended until the web service submits a `merchant_auth` request—if the payment requires customer to be authenticated by the payment system on merchant's request—with the `type` parameter that is set to `finish`.	Intermediate status
`awaiting redirect result`	Payment processing is suspended until the payment system submits a callback with the result to the payment platform. Depending on the result that the payment system submitted the status is set to `success` or `decline`. When processing of the payment only one of the following statuses can be used: either `awaiting redirect result` or `awaiting customer action`.	Intermediate status
`awaiting customer action`	Payment processing is suspended until a customer interacts with a payment system that submits the results of this interaction. Depending on the result that the payment system submitted the status is set to `success` or `decline`. When processing of the payment only one of the following statuses can be used: either `awaiting redirect result` or `awaiting customer action`.	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 (for more information, see Submission of additional payment information). If the payment platform does not receive this request within 30 minutes, the status is set to `decline`.	Intermediate status
`awaiting confirmation`	Payment processing is suspended until the payment platform receives the confirmation from the payment system or the provider that the funds have been transferred to the payment recipient.	Intermediate status
`awaiting customer`	Payment processing is suspended until one of additional attempts to perform this payment is successfully completed—the status is set to `success`—or the maximum amount of the additional attempts has been exceeded—the status is set to `decline`. For more information about the Try again payments, see Payment retries.	Intermediate status
`decline`	Payment could not be completed.	Final status
`success`	Payment has been completed successfully.	Final status. Additionally the payment refund is supported.
`partially refunded`	The partial amount of payment has been returned to a customer.	Final status. Additionally a partial refund can be cancelled.
`refunded`	The the total amount of payment was returned to a customer after the business day the initial purchase had been completed. This status is used if the total amount of payment is returned in one refund or if the total amount of the partial refunds is equal to the total amount of payment.	Final status. Additionally a refund can be cancelled.
`partially reversed`	The partial amount of payment has been returned to a customer.	Final status
`reversed`	The total amount of payment was returned to a customer on the same business day the initial payment had been completed.	Final status

Statuses of the sale operation

The following table describes the statuses of the sale operation.


`processing`	Operation is being processed.	Intermediate status
`awaiting 3ds result`	Operation processing is suspended until the web service submits a `3ds_result` request with the authentication result. If the payment platform does not receive this request within the required timeout time, then the payment status is set to `decline`. Normally, the timeout is 30 minutes, but it may differ depending on provider. For more information about specific timeouts, contact technical support at support@ecommpay.com.	Intermediate status
`awaiting merchant auth`	Operation processing is suspended until the web service submits a `merchant_auth` request—if the payment requires customer to be authenticated by the payment system on merchant's request—with the `type` parameter that is set to `finish`.	Intermediate status
`awaiting redirect result`	Operation processing is suspended until the payment system submits a callback with the result to the payment platform. Depending on the result that the payment system submitted the status is set to `success` or `decline`.	Intermediate status
`awaiting customer action`	Operation processing is suspended until a customer interacts with a payment system that submits the results of this interaction. Depending on the result that the payment system submitted the status is set to `success` or `decline`.	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 (for more information, see Submission of additional payment information). 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

Statuses of the payment confirmation operation

The following table describes the statuses of the payment confirmation operation.


`processing`	Operation is being processed.	Intermediate status
`decline`	Operation could not be completed.	Final status
`success`	Operation has been completed successfully.	Final status

Statuses of the reversal and refund operations

The following table describes the statuses of the reversal or the refund 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 (for more information, see Submission of additional payment information). 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