PaymentMethodCreateRequest

  • Type: object

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

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

    • card
      Type: PaymentMethodCard

      PaymentMethodCard

      Properties: 15
    • billing_details
      Type: BillingDetails

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

      Properties: 4
    • 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
        additionalPropertyType: string
    • customer
      Type: string
      max length:  
      100

      ID of an existing Customer, if one exists.

    • confirmation_token

      Provide one of token OR token_intent_id

      Provide one of token OR token_intent_id

      • token_id
        Type: string
        required

        Confirmation token.

      • token_intent_id
        Type: string

        Ephemeral token intent.