Description
The Payment object represents a payment made for an Order.
ℹ️ Note
This object supports custom data via the data attribute.
Attributes
| Attribute | Type | Description |
|---|---|---|
account_credit_path |
String | Returns the url path to the AccountCredit used for this Payment (if any) |
amount |
Number | Returns the payment amount |
amount_tendered |
Number | Returns the Cash amount tendered for this Payment |
change_given |
Number | Returns the change given in Cash for this Payment |
currency_code |
String | Returns the currency code for this Payment |
description |
String | Returns the a description of the payment method used |
id |
String | Returns the unique id for this Payment |
instructions_content |
String | Returns the value of the Instructions attribute as rich text |
invoice_reference |
String | Returns the invoice reference number for this Payment |
invoice_url |
String | Returns the a url to the invoice for this Payment |
order |
Order | Returns the Order that this Payment belongs to |
paid_at |
Timestamp | Returns timestamp of this Payment |
payment_method |
String | Returns the payment method used |
payment_provider |
PaymentProvider | Returns the PaymentProvider used for this Payment |
points_amount |
Number | Returns the points payment amount |
status |
String | Returns the status of this Payment |
surcharge_amount |
Number | Returns the surcharge amount included in this Payment |
transaction_number |
String | Returns a transaction reference number for this Payment |
wallet_type |
String | Returns the wallet type used (e.g., \ |