PublicInvoicePaymentSummaryDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Public-facing payment summary: excludes internal transaction IDs and recorded-by info.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
amount
required |
number (double) | The amount applied against the invoice balance: the invoiced base. Unchanged in meaning;
any fee the payer was charged on top is reported separately below.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
convenienceFeeAmount
required |
number (double) | The convenience fee this payment carried on top of `amount`, in the invoice currency,
when one was assessed. New and optional: `amount` and every invoice-level amount on the
parent view keep their existing base-only meaning.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
surchargeAmount
required |
number (double) | The credit-card surcharge this payment carried, in the invoice currency, when one was assessed.
New and optional; see
`convenienceFeeAmount`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
chargedTotal
required |
number (double) | The total the payer was actually charged, when known. New and optional.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
paymentMethod
required |
string |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
status
required |
InvoicePaymentStatus InvoicePaymentStatus | Status of a payment attempt against an invoice.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
appliedAt
required |
string (date-time) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.