Payment

The Payment object represents a single attempt to move money into your account. Checkout confirmation is the most common way to create Payment.

  • id
    Type: string
    required

    Unique identifier for the transaction

  • created
    Type: stringFormat: date-time
    required

    Unix timestamp when payment was created

  • amount
    Type: integerFormat: int64
    required

    Amount charged in smallest currency unit

  • currency
    Type: Currency
    required

    Three-letter ISO currency code

    Properties: 2
  • status
    Type: "failed" or "pending" or "succeeded"enum
    required

    The status of the payment is either succeeded, pending, or failed.

  • metadata

    Metadata attached to the Payment. For Payments created from a Payment Intent or Checkout Session, this starts as the initial metadata snapshot copied at Payment creation time.

    • propertyName
      additionalPropertyType: string
  • balance_transaction
    Type: BalanceTransaction

    Balance transactions represent funds moving through your account.

    Properties: 7
  • formatted_amount
    Type: string

    Human-readable amount in the currency's standard unit format. This represents the actual monetary value that would be displayed to end users (e.g., "20.00" for $20.00 USD, "2000" for ¥2000 JPY, "2000" for 2000 HUF). Use this for display purposes; use the 'amount' field for calculations and API requests.

  • amount_captured
    Type: integerFormat: int64

    Amount in cents (or local equivalent) captured (can be less than the amount attribute on the payment if a partial capture was made).

  • amount_refunded
    Type: integerFormat: int64

    Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the payment if a partial refund was issued).

  • latest_status
    Type: string
    required

    Latest status of the payment

  • captured
    Type: boolean

    If the payment was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.

  • updated
    Type: stringFormat: date-time

    When the transaction was last updated

  • outcome
    Type: payment_outcomenullable

    Details about whether the payment was accepted, and why.

    Properties: 5
  • failure_code
    Type: string | null
    max length:  
    5000

    Failure code, only set if status is failed.

  • failure_message
    Type: string | null
    max length:  
    5000

    Detailed failure message, only set if status is failed.

  • paid
    Type: boolean

    true if the charge succeeded, or was successfully authorized for later capture.

  • payment_method
    Type: string

    Payment method used

  • payment_method_details
    Type: payment_method_details

    Details about the payment method at the time of the payment.

    Properties: 1
  • customer

    ID of the customer this charge is for if one exists.

    • Type: Customer ID
      max length:  
      100

      ID of the customer this charge is for if one exists.

  • payment_intent

    ID of the PaymentIntent associated with this charge, if one exists.

    • Type: IntentId
      max length:  
      100

      ID of the PaymentIntent associated with this charge, if one exists.

  • checkout_id
    Type: string | null

    ID of the checkout that created this transaction

  • account_id
    Type: string
    deprecated

    Account ID

  • account
    Type: Account
    deprecated
    nullable

    Details about the account that is holding the funds.

    Properties: 18
  • merchant_account_id
    Type: string
    deprecated

    Merchant account ID

  • latest_operation
    Type: string

    The most recent operation performed on this payment.

  • refunded
    Type: boolean

    Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.

  • disputed
    Type: boolean

    Whether the charge has been disputed.

  • fraud_details
    Type: payment_fraud_detailsnullable

    Information on fraud assessments for the payment.

    Properties: 2
  • client_reference_id
    Type: string | null
    max length:  
    100

    A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the Session with your internal systems.

  • statement_descriptor
    Type: string | null
    max length:  
    100

    For a non-card payment, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor.

  • fee
    Type: integerFormat: int64

    Fees (in cents) paid for this transaction. Represented as a positive integer when assessed.

  • fee_details
    Type: array of Fee

    Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.

    Properties: 13
  • livemode
    Type: boolean
    required

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.