On this page
No Headings
The payment details of the invoice. Includes payment type, method, date, discount, and transaction type.
objecttypeobject"PAYPAL", "EXTERNAL"The payment type. Can be PayPal or an external payment. Includes cash or a check.
The payment type in an invoicing flow which can be PayPal or an external cash or check payment.
payment_idstring^[\S\s]*$The ID for a PayPal payment transaction. Required for the PAYPAL payment type.
payment_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The date when the invoice was paid, in Internet date and time format. For example, yyyy-MM-dd z.
payment_date_timeobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The date-time when the invoice was paid. For example, yyyy-MM-dd T HH: mm: ss z. The time zone will be UTC.
methodrequiredstring"BANK_TRANSFER", "CASH", "CHECK", "CREDIT_CARD", "DEBIT_CARD", "PAYPAL", "WIRE_TRANSFER", "OTHER"The payment mode or method through which the invoicer can accept the payments.
notestring^[\S\s]*$A note associated with an external cash or check payment.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The payment amount to record against the invoice. If you omit this parameter, the total invoice amount is marked as paid. This amount cannot exceed the amount due.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.shipping_infoobjectThe contact information of the user. Includes name and address.
The recipient's shipping information. Includes the user's contact information, which includes name and address.