idstring required
Unique payment identifier.
numberinteger required
Sequential payment number within your organization (shown as "PAY-0001").
customerIdstring required
The customer this payment belongs to.
invoiceIdstring nullable required
The invoice this payment was collected for, when created by an automatic charge. Null for manually recorded payments.
orderIdstring nullable required
The order this payment relates to, when known.
amountinteger required
Payment amount in cents (minor currency units).
allocatedAmountinteger required
Portion of the amount already allocated to invoice lines, in cents.
balanceinteger required
Unallocated remainder of the payment, in cents.
currencystring required
Three-letter ISO currency code.
paymentDatestring date-time required
When the payment was made.
paymentTypestring required
How the payment was made, e.g. creditCard, bankTransfer, ach, cash, or check.
statusstring required
Payment status: draft, posted, processing, requiresAction, failed, or canceled.
metadataobject nullable required
Key-value metadata stored on the payment.
createdAtstring date-time required
updatedAtstring date-time required