PaymentLink

  • A payment link is a shareable URL that will take your customers to a hosted payment page.

    • active
      Type: boolean
      required

      Whether the payment link's url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated.

    • amount
      Type: integerFormat: int64
      required

      Amount charged in smallest currency unit

    • created
      Type: stringFormat: date-time
      required

      Created time for the payment link.

    • currency
      Type: object · Currency
      required

      Three-letter ISO currency code

    • expires_at
      Type: stringFormat: date-time
      required

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

    • id
      Type: string
      required

      Unique identifier for the payment link

    • livemode
      Type: boolean
      required

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

    • on_behalf_of
      Type: string
      max length:  
      100
      required

      The account on behalf of which to charge.

    • status
      Type: string
      required

      Current lifecycle status of the payment link.

      • draft: The link has been created but is not yet available for customers. - open: The link is active and can be used by customers to initiate payments. - completed: The link has been fully paid and is no longer usable for new payments. - expired: The link has passed its expiration time and can no longer be used.
    • url
      Type: string
      max length:  
      1000
      required

      The public URL that can be shared with customers.

    • after_completion
      Type: object · AfterCompletion

      After completion behavior for the Checkout Session.

    • 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

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

      Details about the products sold or services provided

    • locale
      Type: string | null · Localeenum

      The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used.

      values
      • auto
      • bg
      • bg-BG
      • cs
      • cs-CZ
    • 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.

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