We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.
Payment Detail
The payment details.
typeenumOptional
The payment type in an invoicing flow. The [record refund](/docs/api/invoicing/v1/#invoices_record-refund) method supports the `EXTERNAL` refund type. The `PAYPAL` refund type is supported for backward compatibility.
Value in"PAYPAL" | "EXTERNAL"
transaction_idstringOptional
The ID for a PayPal payment transaction. Required for the `PAYPAL` payment type.
transaction_typeenumOptional
The transaction type.
Value in"SALE" | "AUTHORIZATION" | "CAPTURE"
datestringOptional
The date when the invoice was paid, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
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 properties
2 properties
currencystringRequired
The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/).
valuestringRequired
The value, which might be:
An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.
For the required number of decimal places for a currency code, see [Currency codes - ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).