Payment

Payment snapshot for payment.succeeded and payment.failed events. Use status and the captured and paid fields to reconcile the payment outcome.

  • status
    Type: stringenum
    required

    Payment status at the time of the event.

    values
    • failed

      The payment failed; inspect failureCode and failureMessage.

    • pending

      The payment is still pending; wait for its outcome.

    • succeeded

      The payment succeeded; inspect captured and amountCaptured for the capture result.

  • id
    Type: string
    required

    Payment ID.

  • created
    Type: stringFormat: date-time

    Time the Payment was created.

  • updated
    Type: stringFormat: date-time

    Time the Payment was last updated.

  • amount
    Type: integerFormat: int64
    required

    Payment amount. Expressed in the smallest currency unit.

  • currency
    Type: string
    required

    Three-letter currency code.

  • currencyScale
    Type: integer

    Number of decimal places used for amounts in this currency.

  • paid
    Type: boolean

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

  • captured
    Type: boolean

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

  • amountCaptured
    Type: integerFormat: int64

    Amount already captured. Expressed in the smallest currency unit.

  • refunded
    Type: boolean

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

  • amountRefunded
    Type: integerFormat: int64

    Amount already refunded. Expressed in the smallest currency unit.

  • accountId
    Type: string
    required

    Account associated with the Payment.

  • paymentIntentId
    Type: string | null

    Related Payment Intent ID.

  • paymentMethodId
    Type: string | null

    Related Payment Method ID.

  • customerId
    Type: string | null

    Related Customer ID.

  • failureCode
    Type: string

    Failure code when the Payment failed.

  • failureMessage
    Type: string

    Description of the payment failure.

  • clientReferenceId
    Type: string | null

    Your reference for this Payment.

  • description
    Type: string | null

    Description attached to the Payment.

  • liveMode
    Type: boolean

    Whether the resource belongs to live mode or test mode.

  • metadata

    Metadata attached to the resource.

    Metadata attached to the resource.

    • propertyName
      additionalPropertyType: string