Payment status description
Payment status description
You can confirm the status of a payment by calling the inquiryPayment API. If the payment does not exist, the error code ORDER_NOT_EXIST
is returned by the API. If the payment exists, the parameter paymentStatus indicates the payment status.
The value of paymentStatus can be SUCCESS
, FAIL
, PROCESSING
, CANCELLED
, or PENDING
(which is triggered by few payment methods). The following flow chart illustrates the processing logic of the payment status:
When you initiate a payment by calling the pay API and the API call succeeds, regardless of whether a cashier page is invoked, the payment status changes to PROCESSING
. If the payment is successful, the payment status changes to SUCCESS
. If the payment is timed out, the payment is automatically closed 14 minutes after the API is called, and the payment status changes to FAIL
.
If an buyer chooses Sofort to pay, when the payment is completed, the payment status changes to PENDING
. After Sofort confirms the payment result (which usually takes 1-3 days, 7 days maximum), the payment status changes to SUCCESS
if a successful payment is confirmed, and the payment status changes to FAIL
if a failed payment is confirmed.
Regardless of whether a payment is completed, a buyer can use the cancel API to cancel the payment on T day before T+1 00:15. After the payment is canceled, the payment status changes to CANCELLED
. If the payment is completed before or after the payment is canceled, a full refund is issued to the buyer.
Notes:
- A payment that has been refunded cannot be canceled, and the error code
PROCESS_FAIL
is returned in this case.- A payment whose payment status is
FAIL
can be canceled. In this case, the status codeSUCCESS
is returned while the payment status remainsFAIL
instead of changing toCANCELLED
.
If a payment is successful, you can issue a refund by calling the refund API within a year. The refund amount cannot exceed the total payment amount. Partial refunds are allowed, and the amount of each refund must be no less than the minimum refund amount. After multiple partial refunds or a full refund, the payment status remains SUCCESS
.