Attributes
- idstring
- Unique identifier for the object
- objectstring, value is "payment"
- A string representing the object’s type. Objects of the same type share the same value.
- amountinteger
- The amount this Payment captures.
- createdAttimestamp
- Time at which the object was created. Measured in milliseconds since the Unix epoch.
- currencyenum
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- descriptionstring
- An arbitrary - ideally descriptive - long form explanation of the Payment, meant to be displayed to the customer.
- lineItemslist of string
- A list of the IDs of the Line Items of the original order this Payment captures.
- metadatahash
- Set of key-value pairs that you can attach to the Payment object.
- orderstring
- The ID of the original Order this Payment was captured from.
- referencestring
- A - ideally unique - string to reference the Payment (e.g. a customer ID, a cart ID, etc.) which can be used to reconcile the Payment with your internal systems.
- statusenum
- The status of the Payment.
Possible enum values
-
processedThe payment was created successfully.
-
refundedThe payment was fully refunded.
-
- testboolean
- A flag with a value
falseif the object exists in live mode ortrueif the object exists in test mode. - updatedAttimestamp
- Time at which the object was last updated. Measured in milliseconds since the Unix epoch.