When initiating a payment, you will be asked to specify success and error URLs. Users will be appropriately redirected to these URLs based on the outcome of the payment attempt. Depending on the scenario, Banked appends banked-checkout-status={status} parameters to the success or error URL, enabling you to enhance the users experience and provide clear next steps. Below is a list of user redirect scenarios and their corresponding banked-checkout-status={status}:
| Redirect URL | banked-checkout-status | Scenario |
|---|---|---|
success_url | success | Reflects a completed transaction with the payment being successfully processed to a sent state. |
success_url | pending | The payment is in a pending state, which is not in a terminal state. The payment is currently being processed and an order confirmation will be sent to the user when the payment is sent. |
error_url | failure | The payment attempt failed and cannot be retried. |
error_url | user-cancelled | Indicates the user has opted to cancel the payment |
Handling Success and Error Redirects
1. Success URL
The user will be redirected here once they have successfully authorised a payment. It's important to note that you should not release any goods until you have received a sent webhook notification for a payment. As such, make sure your success URL page displays the following information:
- Order Details: Details about the order, such as the payment amount.
- Next Steps Information: Information about the next steps. For example, in case the payment is in a
pendingstate, state that the payment is being processed and an order confirmation will be sent to the user. - Branding Presence: Your branding, to ensure that the user is aware they are back to your website.
2. Error URL
The user will be redirected to the error url under two conditions. Either, there is bank rejection or user-initiated cancellation. This redirection serves as an opportunity to guide the user through alternative actions:
- Clear Next Steps: Offer alternative payment methods or the option to revisit their basket and attempt checkout again.
- Error Handling Guidance: Provide support resources or contact information for users encountering payment difficulties.