Optty Direct Sessions

Sessions can also be created via the UPP by navigationg to Optty Direct on the sidebar and selecting Create New. This is a great way to take manual payments, or to test the functionality before completing an API integration.

Session Overview

An Optty direct session refers to each Optty Direct link that has been created. Within each session only a single payment can be made, such that a maximum of one Successful order will be associated with any Optty Direct Session. It is possible to have a Order decline and a customer retry the payment, in this case after reaching the status page, it will show a declined state with an option to retry the payment.

Sessions are referred to by their invoice number which is unique and specified on creation of a session.

Retrying Payments

Each Optty Direct session can only have a single payment request in progress at any time, this is to prevent two payments being in progress and getting completed at the same time, hence if a customer begins the flow and proceeds past payment provider selection and an order is initiated, they will have to complete that order, either cancelling or being declined before they can access the link and attempt another payment. If there is a payment in progress and they access the session they will be faced with a message to complete existing payment, with the option to cancel it if they wish to proceed.

Sharing of Session Link and Status

When a link is created the customer email specified will be sent an email from Optty, this email sender and styling can be customised whitelabeled, if you wish to do so please reach out to Optty at [email protected].

This email will include the details of the order along with the link to the payment page for them to complete their payment. The email received by the customer can be disabled when created via API by passing false the emailCustomer customer field. Creating a Session

If the session was created via the UPP the user who creates it will also receive a confirmation email once a successful payment has been completed for that session confirming the user has successfully made their payment.

Webhooks

When a payment is completed from a session, a webhook will be sent for the related order with a reference to the invoiceNumber of the associated session in the metadata field and initiator will be specified as payment-link .

{
  "event": "ORDER_ASYNC_CALLBACK",
  "data": {
    "data"...
    "initiator": "payment-link",
    "metadata": {
      "invoiceNumber": "000098"
    }
  }
}