PaymentMethodResponse

PaymentMethod response object. Response-specific fields model API serialization details such as nullable fields and expandable references.

  • billing_address
    nullable
    required

    Billing address associated with the PaymentMethod, if one exists.

    • city
      Type: string | null
      max length:  
      100

      City, district, suburb, town, or village.

    • country
      Type: string | null
      max length:  
      2

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

    • line1
      Type: string | null
      max length:  
      100

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

    • line2
      Type: string | null
      max length:  
      100

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

    • postal_code
      Type: string | null
      max length:  
      100

      ZIP or postal code.

    • state
      Type: string | null
      max length:  
      100

      State, county, province, or region.

  • created
    Type: stringFormat: date-time
    required

    Unix timestamp when refund was created

  • customer
    nullable
    required

    ID of an existing Customer, if one exists, or the expanded Customer object when expand=customer is requested.

    • Type: string · Customer ID
      max length:  
      100

      ID of an existing Customer, if one exists, or the expanded Customer object when expand=customer is requested.

  • id
    Type: string
    max length:  
    100
    required

    Unique identifier for the object.

  • 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.

  • type
    enum
    const:  
    card
    required

    The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

    values
    • card
  • billing_details
    Type: object

    Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

    • address

      The customer's address.

    • email
      Type: string | null
      max length:  
      100

      Billing email address.

    • name
      Type: string | null
      max length:  
      100

      Billing full name.

    • phone
      Type: string | null
      max length:  
      100

      Billing phone number (including extension).

  • card
    Type: object

    PaymentMethodCard

    • brand
      Type: string
      max length:  
      100
      required

      Card brand. Can be mastercard, visa or unknown.

    • exp_month
      Type: integer
      required

      Two-digit number representing the card's expiration month.

    • exp_year
      Type: integer
      required

      Four-digit number representing the card's expiration year.

    • funding
      Type: string
      max length:  
      100
      required

      Card funding type. Can be credit, debit, prepaid, or unknown.

    • last4
      Type: string
      max length:  
      100
      required

      The last four digits of the card.

    • cardholder_name
      Type: string | null
      max length:  
      100

      The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on with Apple Pay and Google Pay.

    • country
      Type: string | null
      max length:  
      100

      Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.

    • display_brand
      Type: string | null
      max length:  
      100

      The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be american_express, diners_club, discover, interac, jcb, mastercard, union_pay, visa, or other and may contain more values in the future.

    • fingerprint
      Type: string | null
      max length:  
      100

      Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

    • iin
      Type: string
      max length:  
      100

      Issuer identification number of the card.

    • issuer
      Type: string | null
      max length:  
      100

      Issuing bank name.

    • segment
      Type: string
      max length:  
      100

      Card segment type. Can be commercial, consumer or unknown.

    • three_d_secure_usage
      Type: object

      Contains details on how this Card may be used for 3D Secure authentication.

    • wallet
      Type: object · PaymentMethodCardWallet

      If this Card is part of a card wallet, this contains the details of the card wallet.

  • metadata

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • propertyName
      Type: string