input ChargePaymentMethodInput
Details of a payment to run against a stored payment method. The currency must match the currency the method was stored under.
| Field | Type | Description |
|---|---|---|
orgId | ID! | Organization that owns the payment method. |
paymentMethodId | ID! | Id of the stored payment method to charge, as returned in PaymentMethod.id. |
amount | Amount! | Amount to charge. Ex. 100.10. Must be greater than zero. |
currency | Currency! | Three letter ISO currency code. Ex. USD |
recurringProcessingModel | RecurringProcessingModel | How this payment is declared to the card networks. Defaults to UnscheduledCardOnFile, which covers a payment you initiate that follows no fixed schedule. Use Subscription when the payments run on a fixed interval, whatever the amount, and CardOnFile when the customer is present and started this payment themselves from your own checkout. The choice decides how the payment is treated for Strong Customer Authentication, so it should describe the arrangement you actually have with the customer. |
callbackUrl | URL | URL to receive payment events for the resulting payment. |
transactionRef | String | Optional merchant supplied reference ID for the transaction external to the platform. |
invoiceIds | [String!] | Optional array of invoice IDs this charge settles. You cannot provide both invoiceIds and invoiceRefs. |
invoiceRefs | [PaymentSessionInvoiceRefInput!] | Optional array of invoice references this charge settles. You cannot provide both invoiceIds and invoiceRefs. |
idempotencyKey | String | Optional caller-supplied key that makes the charge idempotent. Repeating a call with the same key and org returns the payment created by the first call instead of charging again. Strongly recommended: without it a retried request charges the customer twice. |