Token Create Order - Merchant Initiated

Using our Token flow you can complete orders without the need for any customer interactions.

Not all payment methods support this flow. Please confirm it is supported before enabling it. A 'Not Supported' Error will be thrown when attempting to use tokenisation with an unsupported provider

This flow uses the same endpoint as Create Order and is controlled through the following two fields on the payload.

1. Create a traditional order that gets the customer to complete the checkout flow with the getToken field set to True

2. Pass the token that is returned via the webhook notification for the initial order to any future Create Order calls that you want to use those tokenised payment details to process (as seen in the flow below)

Payload - Create Order fields required to implement a Merchant Initiated Transaction

Name	Type	Description
getToken	boolean	Specifies whether you would like to create a token of the payers data to be used in future merchant initiated transactions. Defaults to False.
token	string	This is the token returned via web hook when a payment is completed with getToken set to True. It will then proceed with the payment without customer interaction.

The merchant or integrator must confirm that the customer consented when initiating a token transaction. Optty does not take any liability for the customer's consent to token transactions.

The flow to get the status of the order after it has been initiated via the Create Order endpoint with a token passed in is the same as a non-token payment. A valid web hook with the same structure will be returned when the status is updated, and the structure of the Get Order endpoint will remain the same.

The only variation here is the functionality of the redirect URL. For a customer present transaction it will not redirect a customer to a checkout page, it will instead immediately redirect the customer to the dynamicRedirectURL with the status of the payment in the same format of URL parameters as a non-token payment. Allowing the merchant to use the same implementation for displaying the status to the customer for tokenised and non-tokenised payments.

For a customer not present transaction, there is no need to do anything with the Redirect URL, there is no payment processing done when redirected.