createPaymentIntentForPaymentOnAccount

Creates an unconfirmed Stripe PaymentIntent that becomes a payment on account after successful payment.

createPaymentIntentForPaymentOnAccount(
  patientId: ID!
  amount: Float!
  date: Date
  comment: String
  metadata: [PaymentOnAccountIntentMetadataInput!]
  storeCardDetails: Boolean
): CreatePaymentIntentForPaymentOnAccountPayload!

Arguments

createPaymentIntentForPaymentOnAccount.patientId ● ID! non-null scalar

createPaymentIntentForPaymentOnAccount.amount ● Float! non-null scalar

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

createPaymentIntentForPaymentOnAccount.date ● Date scalar

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

createPaymentIntentForPaymentOnAccount.comment ● String scalar

Comment stored on the resulting payment.

createPaymentIntentForPaymentOnAccount.metadata ● [PaymentOnAccountIntentMetadataInput!] list input

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

createPaymentIntentForPaymentOnAccount.storeCardDetails ● Boolean scalar

Set to true to save the successfully used card for future payments. When false or omitted, the card is not saved. The implementor is responsible for ensuring the cardholder has given explicit consent for card details to be stored and used for future payments.

Type

CreatePaymentIntentForPaymentOnAccountPayload object