PaymentIntentCreateRequest

  • amount
    Type: integerFormat: int64
    required

    Integer amount in minor units (e.g. cents) specific to the currency. Example: 100 for €1.00

  • currency
    Type: string
    required

    ISO 4217 currency codes (alpha3) supported for payments

  • confirm
    Type: boolean

    Set to true to attempt to confirm this PaymentIntent immediately. This parameter defaults to false. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the Confirm API.

  • customer
    Type: string · Customer ID
    max length:  
    100
  • off_session

    Set to true to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and charge them later. This parameter can only be used with confirm=true.

    • Type: boolean

      Set to true to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and charge them later. This parameter can only be used with confirm=true.

  • payment_method
    Type: string

    ID of the payment method to attach to this PaymentIntent.

  • payment_method_data
    • type
      enum
      const:  
      card
      required
      values
      • card
    • billing_details
      Type: object

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

    • card
      Type: object · card

      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.

      • token_id
        Type: string

        Confirmation token.

      • token_intent_id
        Type: string

        Ephemeral token intent.

      • wallet
        Type: object · PaymentMethodCardWallet

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

  • payment_method_options

    Payment method-specific configuration for this PaymentIntent.

    • type
      enum
      const:  
      card
      required
      values
      • card
    • card
  • setup_future_usage
    Type: string | nullenum

    Indicates that you intend to make future payments with this PaymentIntent's payment method. If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still attach the payment method to a Customer after the transaction completes. When processing card payments, Paypercut uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

    values
    • off_session
    • on_session