Skip to main content

payInvoice

Pays an invoice by charging the patient's stored card token(s). Omit amount to charge the full outstanding balance, or pass a specific amount for a partial payment.

payInvoice(
  invoiceId: ID!
  amount: Float
  comment: String
): PayInvoicePayload

Arguments​

payInvoice.invoiceId ● ID! non-null scalar​

payInvoice.amount ● Float scalar​

Amount to charge in major units. Omit to charge the full outstanding balance.

payInvoice.comment ● String scalar​

Optional note stored as the payment's comment on the invoice (max 500 characters).

Type​

PayInvoicePayload object​

The result of paying an invoice via a stored card.