PaymentIntentCreateRequest

amount
Type: integer · amountWithCurrencyPrecisionFormat: int64
required

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

ISO 4217 currency codes (alpha3) supported for payments
capture_method
Type: stringenum

Controls when funds are captured. Use automatic to capture after a successful authorization. Use manual to authorize during confirmation and capture later with the Capture Payment Intent endpoint.
values
- automatic
  
  Paypercut automatically captures funds when the customer authorizes the payment.
- manual
  
  Place a hold on the funds when the customer authorizes the payment, but don't capture the funds until later.
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

Indicates that the customer is not actively in your checkout flow during this payment attempt. Use true or one_off for customer-not-present unscheduled reuse, and recurring for scheduled recurring reuse of an eligible saved payment method. This parameter can only be used with confirm=true.
Type: boolean

Indicates that the customer is not actively in your checkout flow during this payment attempt. Use true or one_off for customer-not-present unscheduled reuse, and recurring for scheduled recurring reuse of an eligible saved payment method. This parameter can only be used with confirm=true.
payment_method
Type: string · PaymentMethodId

Payment method to attach to this Payment Intent. The payment method must either belong to the same customer or be a single-use payment method created by an Elements or Express Checkout tokenization flow. If the Payment Intent is created without confirmation, the provided payment method is returned on the Payment Intent and can be used when confirming later.
payment_method_data
- type
  enum
  const:
  card
  required
  values
  card
- billing_details
  Type: object · BillingDetails
  
  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 · CardThreeDSecureUsage
  
  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 | null · SetupFutureUsageenum

Indicates that you intend to make future payments with the Payment Intent's payment method. Use on_session when future payments will be made while the customer is present in your checkout flow. Use off_session when future payments may happen while the customer is not present, such as subscriptions or saved-card charges. If the Payment Intent has a customer, Paypercut can attach and promote a single-use payment method to that customer after the Payment Intent is confirmed and the customer completes any required authentication. When this value is provided during confirmation, it takes precedence over the value stored on the Payment Intent.
values
- off_session
- on_session