Skip to main content

startTerminalPaymentOnAccount

Starts an asynchronous card-present payment that becomes a payment on account after webhook persistence.

startTerminalPaymentOnAccount(
  patientId: ID!
  amount: Float!
  terminalId: ID!
  date: Date
  comment: String
  metadata: [PaymentOnAccountIntentMetadataInput!]
  storeCardDetails: Boolean
): PaymentOnAccountTerminalPayload!

Arguments​

startTerminalPaymentOnAccount.patientId ● ID! non-null scalar​

startTerminalPaymentOnAccount.amount ● Float! non-null scalar​

Amount to charge in major currency units. Must be at least 1.

startTerminalPaymentOnAccount.terminalId ● ID! non-null scalar​

startTerminalPaymentOnAccount.date ● Date scalar​

Payment date stored on the resulting payment on account. Defaults to now.

startTerminalPaymentOnAccount.comment ● String scalar​

Comment stored on the resulting payment.

startTerminalPaymentOnAccount.metadata ● [PaymentOnAccountIntentMetadataInput!] list input​

Partner metadata copied to Stripe and the resulting payment-on-account record.

startTerminalPaymentOnAccount.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​

PaymentOnAccountTerminalPayload object​