On this page
No Headings
The details about a payment method override configured for the invoice via payment method overrides object.
objectpayment_method_typestring"PAY_BY_BANK", "ACH"The payment method types that can be configured in the payment method overrides object for invoice payments.
Note: To usePAY_BY_BANK, you must first complete the onboarding process. Visit the onboarding page to get started. Once onboarding is complete, you can configurePAY_BY_BANKas a payment method.
enabledbooleanIndicates whether the specified payment method is enabled for the invoice. When set to true, the payment method is available for the buyer to use. When set to false, the payment method is disabled.
rulesarrayThe list of payment method override rules applied to the invoice via payment method overrides object. Each rule defines a specific restriction or behavior for the payment method, such as making it the exclusive payment option when the invoice total exceeds a system-defined threshold.
itemsobjectThe details about a payment method override rule applied to the invoice via payment method overrides object.
rule_typerequiredstring"EXCLUSIVE_ABOVE_AMOUNT_THRESHOLD", "ALLOW_ONLY_ACH"The type of rule that can be applied to a payment method configured via payment method overrides object on an invoice. Each rule controls how a payment method behaves based on the invoice total.
System-defined threshold limits by payment method:
- PAY_BY_BANK - $1000
rule_valuerequiredstring^[a-zA-Z0-9\s,.]+$The value associated with the payment method override rule. For the EXCLUSIVE_ABOVE_AMOUNT_THRESHOLD rule type, set this to true to enable the rule or false to disable it.