Invoice Payment object
Invoice payments represent payments made by customers of a business. Payments may be made at any time and applied to any outstanding (sent, but not fully paid) invoice.
Attributes
Unique identifier for the payment.
Unique ID of the invoice payment in an external system for linking and idempotency.
Timestamp when the payment was completed.
Payment method. Possible values are: CASH
, CHECK
, CREDIT_CARD
, ACH
,
CREDIT_BALANCE
, OTHER
Fee paid by business for processing of payment in positive cents.
Customer payment amount, in cents.
Processor used to make the payment, if any. Any processor name can be provided and will be tracked.
Timestamp when the payment was imported into Layer.
List of Dedicated Refunds to create with this payment
Invoice allocations allow specifying a payment to be for multiple invoices. Most commonly the full payment will be allocated to a single invoice, but any number of allocations are allowed. The sum of all allocations must be equal to the payment amount.
Memo for any text you would like to associate with the invoice payment (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 10KB.
Any (typically user-visible) identifier you would like to associate with the invoice payment. Can be used to filter when listing invoice payment.