The Payment Record object 

Attributes

• idstring

  Unique identifier for the object.

• amount_canceledobject

  The portion of the requested amount that has been canceled by the user, or that you no longer intend to collect.

  Hide child attributes

  • amount_canceled.currencyenum

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • amount_canceled.valueinteger

    A positive integer representing the amount in the smallest currency unit e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).

• amount_failedobject

  The portion of the requested amount that failed to be collected.

  Hide child attributes

  • amount_failed.currencyenum

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • amount_failed.valueinteger

    A positive integer representing the amount in the smallest currency unit e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).

• amount_guaranteedobject

  The portion of the requested amount that has been guaranteed by the payment provider.

  Hide child attributes

  • amount_guaranteed.currencyenum

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • amount_guaranteed.valueinteger

    A positive integer representing the amount in the smallest currency unit e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).

• amount_requestedobject

  The amount you intend to collect for this payment.

  Hide child attributes

  • amount_requested.currencyenum

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • amount_requested.valueinteger

    A positive integer representing the amount in the smallest currency unit e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).

• customer_detailsnullable object

  Customer information for this payment.

  Hide child attributes

  • customer_details.customernullable string

    ID of the Stripe Customer associated with this payment.

  • customer_details.emailnullable string

    The customer’s email address.

  • customer_details.namenullable string

    The customer’s name.

  • customer_details.phonenullable string

    The customer’s phone number.

• customer_presencenullable enum

  Indicates whether the customer was present in your checkout flow during this payment.

  Possible enum values

  off_session The customer was not present during the transaction.

  on_session The customer was present during the transaction.

• descriptionnullable string

  An arbitrary string attached to the object. Often useful for displaying to users.

• metadatanullable object

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• payment_method_detailsnullable object

  Information about the Payment Method debited for this payment.

  Hide child attributes

  • payment_method_details.billing_detailsnullable object

    The billing details associated with the method of payment.

    Hide child attributes

    • payment_method_details.billing_details.addressobject

      The billing address associated with the method of payment.

      Hide child attributes

      • payment_method_details.billing_details.address.citynullable string

        City, district, suburb, town, or village.

      • payment_method_details.billing_details.address.countrynullable string

        Two-letter country code (ISO 3166-1 alpha-2).

      • payment_method_details.billing_details.address.line1nullable string

        Address line 1 (e.g., street, PO Box, or company name).

      • payment_method_details.billing_details.address.line2nullable string

        Address line 2 (e.g., apartment, suite, unit, or building).

      • payment_method_details.billing_details.address.postal_codenullable string

        ZIP or postal code.

      • payment_method_details.billing_details.address.statenullable string

        State, county, province, or region.

    • payment_method_details.billing_details.emailnullable string

      The billing email associated with the method of payment.

    • payment_method_details.billing_details.namenullable string

      The billing name associated with the method of payment.

    • payment_method_details.billing_details.phonenullable string

      The billing phone number associated with the method of payment.

  • payment_method_details.customnullable object

    Information about the custom (user-defined) payment method used to make this payment.

    Hide child attributes

    • payment_method_details.custom.display_namestring

      Display name for the custom (user-defined) payment method type used to make this payment.

    • payment_method_details.custom.typenullable string

      The custom payment method type associated with this payment.

  • payment_method_details.payment_methodnullable string

    ID of the Stripe PaymentMethod used to make this payment.

  • payment_method_details.typeenum

    The type of Payment Method used for this payment attempt.

    Possible enum values

    custom A custom, user-defined Payment Method type.

• payment_referencenullable string

  An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.

• shipping_detailsnullable object

  Shipping information for this payment.

  Hide child attributes

  • shipping_details.addressobject

    The physical shipping address.

    Hide child attributes

    • shipping_details.address.citynullable string

      City, district, suburb, town, or village.

    • shipping_details.address.countrynullable string

      Two-letter country code (ISO 3166-1 alpha-2).

    • shipping_details.address.line1nullable string

      Address line 1 (e.g., street, PO Box, or company name).

    • shipping_details.address.line2nullable string

      Address line 2 (e.g., apartment, suite, unit, or building).

    • shipping_details.address.postal_codenullable string

      ZIP or postal code.

    • shipping_details.address.statenullable string

      State, county, province, or region.

  • shipping_details.namenullable string

    The shipping recipient’s name.

  • shipping_details.phonenullable string

    The shipping recipient’s phone number.

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• latest_payment_attempt_recordstring

  ID of the latest Payment Attempt Record attached to this Payment Record.

• livemodeboolean

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