PaymentLinkCreateRequest

  • Request parameters for creating a new payment link.

    • amount
      Type: integerFormat: int64
      required

      Amount charged in smallest currency unit

    • currency
      Type: string · CurrencyCode
      required

      ISO 4217 currency codes (alpha3) supported for payments

    • after_completion
      Type: object · AfterCompletion

      After completion behavior for the Checkout Session.

    • billing_address_collection
      Type: string · BillingAddressCollectionenum

      Specify whether Checkout should collect the customer's billing address. Defaults to auto.

      values
      • auto

        Checkout will only collect the billing address when necessary.

      • required

        Checkout will always collect the customer's billing address.

    • client_customer_id
      Type: string | null

      An identifier of the customer in the merchant's system. Used to associate the Checkout and corresponding payments created from the Checkout. Required for SEPA payments - this will ensure that your customer is given a virtual iban that is unique to them and will enable Paypercut to reconcile the payment.

    • client_reference_id
      Type: string | null

      A free-form reference from the merchant's system. Typically used to identify the checkout in the merchant's system. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.

    • description
      Type: string | null

      A free-form reference to describe the checkout

    • expires_at
      Type: stringFormat: date-time

      Expiry time for the payment link. After this time, the payment link will no longer be available for payment. Defaults to 24h after creation.

    • line_items
      Type: array object[] | null · LineItem[]

      Details about the products sold or services provided

    • livemode
      Type: boolean

      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • mode
      Type: string · CheckoutSessionModeenum

      The mode of the Checkout Session.

      values
      • payment

        Standard one-time payment.

      • setup

        Set up a payment method for future use.

      • subscription

        Coming soon. Not available yet.

      • bnpl

        Buy now, pay later.

    • on_behalf_of
      Type: string
      max length:  
      100

      The account on behalf of which to charge.

    • payment_method_configuration
      Type: string | null

      Reference to the payment method configuration for the types that customers can use.

    • redirect_url
      Type: string | null
      max length:  
      1000

      URL to which the customer should be sent after the payment. Any payment results will use this URL.

    • restrictions
      Type: object · PaymentLinkRestrictions

      Settings that restrict the usage of a payment link.