invoice-payment-request.md

Invoice Payment Request

Represents a payment request for an invoice. Invoices can specify a maximum of 13 payment requests, with up to 12 INSTALLMENT request types. For more information, see Configuring payment requests.

Adding INSTALLMENT payment requests to an invoice requires an Invoices Plus subscription.

Structure

InvoicePaymentRequest

Fields

Name	Type	Tags	Description
uid	string | undefined	Optional	The Square-generated ID of the payment request in an invoice. Constraints: Minimum Length: 1, Maximum Length: 255
requestMethod	string | undefined	Optional	Specifies the action for Square to take for processing the invoice. For example, email the invoice, charge a customer's card on file, or do nothing. DEPRECATED at version 2021-01-21. The corresponding request_method field is replaced by the Invoice.delivery_method and InvoicePaymentRequest.automatic_payment_source fields.
requestType	string | undefined	Optional	Indicates the type of the payment request. For more information, see Configuring payment requests.
dueDate	string | undefined	Optional	The due date (in the invoice's time zone) for the payment request, in YYYY-MM-DD format. This field is required to create a payment request. If an automatic_payment_source is defined for the request, Square charges the payment source on this date. After this date, the invoice becomes overdue. For example, a payment due_date of 2021-03-09 with a timezone of America/Los_Angeles becomes overdue at midnight on March 9 in America/Los_Angeles (which equals a UTC timestamp of 2021-03-10T08:00:00Z).
fixedAmountRequestedMoney	Money | undefined	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
percentageRequested	string | undefined	Optional	Specifies the amount for the payment request in percentage: - When the payment request_type is DEPOSIT, it is the percentage of the order's total amount. - When the payment request_type is INSTALLMENT, it is the percentage of the order's total less the deposit, if requested. The sum of the percentage_requested in all installment payment requests must be equal to 100. You cannot specify this when the payment request_type is BALANCE or when the payment request specifies the fixed_amount_requested_money field.
tippingEnabled	boolean | undefined	Optional	If set to true, the Square-hosted invoice page (the public_url field of the invoice) provides a place for the customer to pay a tip. This field is allowed only on the final payment request and the payment request_type must be BALANCE or INSTALLMENT.
automaticPaymentSource	string | undefined	Optional	Indicates the automatic payment method for an invoice payment request.
cardId	string | undefined	Optional	The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer, call ListCards and include the customer_id of the invoice recipient. Constraints: Minimum Length: 1, Maximum Length: 255
reminders	InvoicePaymentReminder[] | undefined	Optional	A list of one or more reminders to send for the payment request.
computedAmountMoney	Money | undefined	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
totalCompletedAmountMoney	Money | undefined	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
roundingAdjustmentIncludedMoney	Money | undefined	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.

Example (as JSON)

{
  "uid": null,
  "request_method": null,
  "request_type": null,
  "due_date": null,
  "fixed_amount_requested_money": null,
  "percentage_requested": null,
  "tipping_enabled": null,
  "automatic_payment_source": null,
  "card_id": null,
  "reminders": null,
  "computed_amount_money": null,
  "total_completed_amount_money": null,
  "rounding_adjustment_included_money": null
}