Skip to main content

payOnAccountWithSavedCard

Charges one of the patient's saved cards and records the payment on account in the same request. Only the given card is charged. When the charge fails, no payment on account is created. If the card requires authentication (3D Secure), the charge fails; use createPaymentIntentForPaymentOnAccount with the patient present instead.

payOnAccountWithSavedCard(
patientId: ID!
savedCardId: ID!
amount: Float!
chargeType: SavedCardChargeType!
date: Date
comment: String
metadata: [PaymentOnAccountIntentMetadataInput!]
): PayOnAccountWithSavedCardPayload!

Arguments​

payOnAccountWithSavedCard.patientId ● ID! non-null scalar​

payOnAccountWithSavedCard.savedCardId ● ID! non-null scalar​

A card id returned by patientSavedCards for the same patient.

payOnAccountWithSavedCard.amount ● Float! non-null scalar​

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

payOnAccountWithSavedCard.chargeType ● SavedCardChargeType! non-null enum​

How the charge is authorised by the patient.

payOnAccountWithSavedCard.date ● Date scalar​

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

payOnAccountWithSavedCard.comment ● String scalar​

Comment stored on the payment.

payOnAccountWithSavedCard.metadata ● [PaymentOnAccountIntentMetadataInput!] list input​

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

Type​

PayOnAccountWithSavedCardPayload object​