PaymentIntentCreateRequest

  • amount
    Type: amountWithCurrencyPrecisionFormat: int64
    required

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

  • currency
    Type: CurrencyCode
    required

    ISO 4217 currency codes (alpha3) supported for payments

  • payment_method
    Type: 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: PaymentMethodData
    Properties: 3
  • payment_method_options
    Type: PaymentMethodOptions

    Payment method-specific configuration for this PaymentIntent.

    Properties: 2
  • customer
    Type: Customer ID
    max length:  
    100
  • 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.

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

  • setup_future_usage
    Type: 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_sessionon_session
  • metadata

    Metadata to attach to the Payment Intent. When the first Payment is created from this Payment Intent, this metadata is copied onto the Payment as its initial metadata snapshot.

    • propertyName
      additionalPropertyType: string