• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
InvoicePaymentRequest BETA

Describes a specific payment request in an invoice.

You can have up to nine payment requests for an invoice.

Properties

Name Description
uid
string

Read only The Square-generated ID of the payment request in an invoice.

Max Length 255 Min Length 1
request_method
string

Indicates how Square processes the payment request.

request_type
string

Identifies the payment request type. This type defines how the payment request amount is determined.

due_date
string

The due date (in the invoice location's time zone) for the payment request. After this date, the invoice becomes overdue.

fixed_amount_requested_money
Money

If the payment request specifies DEPOSIT or INSTALLMENT as the request_type, this indicates the request amount. You cannot specify this when request_type is BALANCE or when the payment request includes the percentage_requested field.

percentage_requested
string

Specifies the amount for the payment request in percentage:

  • When the payment request_type is DEPOSIT, it is the percentage of the order total amount.
  • When the payment request_type is INSTALLMENT, it is the percentage of the order 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.

tipping_enabled
boolean

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.

card_id
string

If the request method is CHARGE_CARD_ON_FILE, this field provides the card to charge.

Max Length 255 Min Length 1
reminders
InvoicePaymentReminder [ ]

A list of one or more reminders to send for the payment request.

computed_amount_money
Money

Read only The payment request amount, computed using the order amount and information from the various payment request fields (invoice_request_type, fixed_amount_requested_money, and percentage_requested).

total_completed_amount_money
Money

Read only The amount of money already paid for the specific payment request. This amount might include a rounding adjustment if the most recent invoice payment was in cash in a currency that rounds cash payments (such as, CAD or AUD).

rounding_adjustment_included_money
Money

Read only If the most recent payment was a cash payment in a currency that rounds cash payments (such as, CAD or AUD) and the payment is rounded from computed_amount_money in the payment request, then this field specifies the rounding adjustment applied. This amount might be negative.

Share Feedback

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