The payment object

Attributes
id string
Unique identifier for the object
<dt>
  <span class="label">object</span>
  <span class="type">string, value is "payment"</span>
</dt>
<dd>A string representing the object’s type. Objects of the same type share the same value.</dd>

<dt>
  <span class="label">amount</span>
  <span class="type">integer</span>
</dt>
<dd>The amount this Payment captures.</dd>

<dt>
  <span class="label">createdAt</span>
  <span class="type">timestamp</span>
</dt>
<dd>Time at which the object was created. Measured in milliseconds since the Unix epoch.</dd>

<dt>
  <span class="label">currency</span>
  <span class="type">enum</span>
</dt>
<dd>Three-letter ISO currency code, in lowercase. Must be a supported currency.</dd>

<dt>
  <span class="label">description</span>
  <span class="type">string</span>
</dt>
<dd>An arbitrary - ideally descriptive - long form explanation of the Payment, meant to be displayed to the customer.</dd>

<dt>
  <span class="label">lineItems</span>
  <span class="type">list of string</span>
</dt>
<dd>A list of the IDs of the Line Items of the original order this Payment captures.</dd>

<dt>
  <span class="label">metadata</span>
  <span class="type">hash</span>
</dt>
<dd>Set of <a target="_self" href="/reference/metadata">key-value pairs</a> that you can attach to the Payment object.</dd>

<dt>
  <span class="label">order</span>
  <span class="type">string</span>
</dt>
<dd>The ID of the original Order this Payment was captured from.</dd>

<dt>
  <span class="label">reference</span>
  <span class="type">string</span>
</dt>
<dd>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.</dd>

<dt>
  <span class="label">status</span>
  <span class="type">enum</span>
</dt>
<dd>The status of the Payment.
  <div class="values-list-container">
    <div class="values-list-header">Possible enum values</div>
    <ul class="values-list">
      <li class="values-list-item">
        <span class="values-list-item-value"><code>processed</code></span>
        <p class="values-list-item-description">The payment was created successfully.</p>
      </li>
      <li class="values-list-item">
        <span class="values-list-item-value"><code>refunded</code></span>
        <p class="values-list-item-description">The payment was fully refunded.</p>
      </li>
    </ul>
  </div>
</dd>

<dt>
  <span class="label">test</span>
  <span class="type">boolean</span>
</dt>
<dd>A flag with a value <code>false</code> if the object exists in live mode or <code>true</code> if the object exists in test mode.</dd>

<dt>
  <span class="label">updatedAt</span>
  <span class="type">timestamp</span>
</dt>
<dd>Time at which the object was last updated. Measured in milliseconds since the Unix epoch.</dd>