Request to initiate a Hosted Checkout interaction, i.e. a Hosted Payment Page or Lightbox interaction that allows the payer to select their payment details and make the payment. See Implementing a Hosted Checkout Integration for details.
You can either initiate an interaction where you
- immediately redirect the payer to Hosted Checkout (checkoutMode=WEBSITE). In this case the gateway returns a session identifier (session.id) that you must include in the Checkout.configure() function or
- request a payment link (checkoutMode=PAYMENT_LINK). In this case the gateway returns a payment link (paymentLink.url) that you can include in your communication with the payer (e.g. email). Clicking on the link will take the payer to Hosted Checkout.
The gateway automatically expires the session.
Once a payment using a payment link has been completed the payment link can no longer be used.
UpdateYou can update the session using the UPDATE_SESSION operation.
The payment link cannot subsequently be updated.
DeletionThe gateway automatically deletes a payment link
- after the time you have specified in field paymentLink.expiryDateTime in the INITIATE_CHECKOUT request,
- after the number of failed attempts to make a payment using the link, as defined in field paymentLink.numberOfAllowedAttempts in the INITIATE_CHECKOUT request.
You can immediately delete the payment link using the DELETE_PAYMENT_LINK operation. You must delete the payment link if the payer completed the payment via a different channel (i.e. not using the payment link), to prevent duplicate payments.