Creating payment interactions

Note: For an example of the interactions required in a bot that handles payments, see Overview of Apple Pay payment interactions.

To create a payment for Apple Pay:

  1. Go to Designer, drag a Payment interaction onto the canvas.
  2. Fill in the basic details on the Details tab.
    Name The name for the payment interaction.
    Intention Select an intention. The intention defines the general range of responses that you expect users to enter in order to trigger a payment.

    Selecting an intention means that the user will be able to go to this interaction from anywhere in the conversation where they can enter one of the words or phrases in the intention. Leave this field empty if you want the user to only go to this interaction from the previous linked interaction.

    When we receive For the responses that you expect the user to enter in order to trigger the payment. The intention defines the common responses that are available globally to all the interactions in the tenant (company account). If there is an extra response that applies just to this interaction then enter the response directly in this field.

    Entering text in When we receive means that the user will be able to go to this interaction from anywhere in the conversation where they can enter one of the words or phrases in this field. Leave this field empty if you want the user to only go to this interaction from the previous linked interaction.

    Send to user The message that's shown to the user immediately before the payment bubble displays. You can include initial payment details as variables in this message. For details of how to do this, see Payment variables.
    Payment data variable The variable that contains the payment data. This variable must also be set in all the REST actions which makes an API call to obtain either initial payment details or updated payment details. For more details about this variable, see Creating actions for Payment interactions.
  3. Fill in the details of the actions on the Advanced tab:
    Success action Select the interaction that is triggered when payment is successful. This can be any interaction type, such as an Action or Message. This is optional.
    Note: Messages can include details from the final payment. See Payment variables.
    Failure action Select the interaction that is triggered if the payment fails. This is optional.
    Payment method update action

    Shipping contact update action

    Shipping method update action

    These optional REST actions run after a user changes their payment method, shipping method or shipping contact details. The relevant action sends the update to the client's system and receives updated payment data.

    For more details, see Creating actions for Payment interactions.

    Order tracking URL action This optional REST action runs after the payment succeeds.
    Note: To include final payment data in messages sent to the user, you need to access the data through the variable given below the field.