Payment Link Lifecycle

The payment link lifecycle on the PortOne platform consists of several states that track the status of payment links from creation through to completion or cancellation. This document outlines each state, its purpose, and the actions required by merchants.

1. Created State

Description:
When a payment link is initially created, it is in the "Created" state. This is the initial state of the link before any payment actions occur.

Actions:

• Merchant: Generate the payment link and share it with the customer.
• Customer: Receive the payment link and initiate the payment process.

Transition:

• The link transitions from "Created" to "Processing" or other relevant states based on the payment method selected and the status of the transaction.

2. Processing State

Description:
The "Processing" state is used primarily for transactions where the customer has chosen Cash on Delivery as the payment method. This state allows merchants to track these transactions until the payment is completed.

Actions:

• Merchant:
  • Monitor the transaction in the PortOne Admin Console.
  • Once the payment is completed, call the API to change the state from "Processing" to "Success."
• Customer: Make the payment upon delivery.

Transition:

• The link transitions from "Processing" to "Success" upon successful payment.
• If the payment fails, the link remains in the "Processing" state until a successful payment is made or the link is otherwise invalidated.

Note: For more information on using the API for Payment Links, refer to the API section.

3. Success State

Description:
The "Success" state indicates that the customer has successfully paid the full amount using the provided link. Once the link is in this state, it cannot be reused.

Actions:

• Merchant:
  • Confirm the successful payment.
  • Update records and reconcile payments.
• Customer: Complete the payment.

Transition:

• The link remains in the "Success" state after payment and cannot transition to any other state.
• If the payment fails initially, the link remains in the "Processing" state until payment is successful.

4. Expired State

Description:
The "Expired" state indicates that the payment link has expired because the customer missed the deadline set by the merchant during the creation of the link.

Actions:

• Merchant:
  • Review expired links.
  • Optionally, issue new payment links if necessary.
• Customer: Attempt to pay before the expiration, or contact the merchant for a new link if needed.

Transition:

• The link cannot transition back from the "Expired" state. It must be recreated if further action is needed.

5. Cancelled State

Description:
The "Cancelled" state indicates that the payment link has been canceled by the merchant and no longer accepts payments.

Actions:

• Merchant:
  • Cancel the link as needed.
  • Issue new payment links or update records.
• Customer: The link will not be functional for payment.

Transition:

• The link remains in the "Cancelled" state and cannot transition to any other state.

Summary

Understanding the lifecycle of payment links helps merchants manage payment collections effectively. By monitoring and taking appropriate actions based on the state of each link, merchants can ensure smooth transactions and efficient payment management.

For further details on API usage and other functionalities, please refer to the respective sections in the documentation.