Skip to main content

startTerminalPaymentForBooking

Creates a card-present PaymentIntent and sends it to a registered Stripe Terminal reader.

startTerminalPaymentForBooking(
  bookingId: ID!
  terminalId: ID!
  storeCardDetails: Boolean
): BookingTerminalPaymentPayload!

Arguments​

startTerminalPaymentForBooking.bookingId ● ID! non-null scalar​

startTerminalPaymentForBooking.terminalId ● ID! non-null scalar​

startTerminalPaymentForBooking.storeCardDetails ● Boolean scalar​

Set to true to save the card used on the terminal for future payments. When false or omitted, the card is not saved. Returns an error if the practice cannot save cards from a terminal. The implementor is responsible for ensuring the cardholder has given explicit consent for card details to be stored and used for future payments.

Type​

BookingTerminalPaymentPayload object​