# InvoicePaymentDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Read DTO for an invoice payment record.

## Fields
- `id` (string(uuid))
- `transactionId` (string(uuid)): (nullable)
- `amount` (number(double)): The amount applied against the invoice balance: the invoiced base, never a fee-inclusive  total. Fees the payer was charged on top ride the members below.
- `convenienceFeeAmount` (number(double)): The convenience fee charged on top of `amount`, in the invoice currency, when one was  assessed. (nullable)
- `surchargeAmount` (number(double)): The credit-card surcharge charged on top of `amount`, in the invoice currency, when one  was assessed. (nullable)
- `chargedTotal` (number(double)): The total the payer was actually charged, when known. (nullable)
- `paymentMethod` (string): (nullable)
- `status` ([InvoicePaymentStatus](https://devportal.demo.winkpg.io/docs/api/models/InvoicePaymentStatus.md)): Status of a payment attempt against an invoice.
  Values:
  - `Pending`: Payment is pending processing.
  - `Succeeded`: Payment succeeded.
  - `Declined`: Payment was declined by the processor.
  - `Returned`: Payment was returned (e.g., ACH return).
  - `Refunded`: Payment was refunded.
  - `Indeterminate`: The attempt reached the processor but produced no answer the invoice can act on: a referral the merchant has to resolve by voice, a pending or submitted authorization, a partial approval whose approved base cannot be derived, or a status the platform does not recognize. Nothing is credited against the balance and the attempt is not a decline; the row exists so the invoice shows that someone tried and what came back.
- `declineReasonCode` (string): (nullable)
- `appliedAt` (string(date-time))
- `notes` (string): (nullable)
- `recordedBy` (string): (nullable)

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.