• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
Enum
You are viewing an old version of the API

InvoiceAutomaticPaymentSource

BETA

Indicates the automatic payment method for an invoice payment request.

Values

NONE

An automatic payment is not configured for the payment request.

CARD_ON_FILE

Use a card on file as the automatic payment method. On the due date, Square charges the card for the amount of the payment request.

For CARD_ON_FILE payments, the invoice delivery method must be EMAIL and card_id must be specified for the payment request before the invoice can be published.

BANK_ON_FILE

Use a bank account on file as the automatic payment method. On the due date, Square charges the bank account for the amount of the payment request.

This payment method applies only to recurring invoices that sellers create in the Seller Dashboard or other Square first-party application. The bank account is provided by the customer during the payment flow.

You cannot set BANK_ON_FILE as a payment method using the Invoices API, but you can change a BANK_ON_FILE payment method to NONE or CARD_ON_FILE. For BANK_ON_FILE payments, the invoice delivery method must be EMAIL.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?