Checkout

Checkout session for processing payments

  • id
    Type: string
    required

    Unique identifier for the checkout session

  • url
    Type: stringFormat: uri
    required

    URL where the customer can complete the payment

  • amount
    Type: amountWithCurrencyPrecisionFormat: int64

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

  • currency
    Type: Currency

    Three-letter ISO currency code

    Properties: 2
  • on_behalf_of
    Type: string

    Account ID to which the payment will be credited

  • payment_method_configuration
    Type: string

    Reference to a payment profile specifying the payment methods which should be available on the Checkout and their configurations. Required if more than one payment profile exists.

  • payment_status
    Type: "no_payment_required" or "paid" or "unpaid"enum
    required

    The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required. You can use this value to decide when to fulfill your customer's order.

  • status
    Type: "complete" or "expired" or "open"enum

    The status of the Checkout Session, one of open, complete, or expired.

  • expires_at
    Type: stringFormat: date-time
    required

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

  • client_reference_id
    Type: string

    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.

  • client_customer_id
    Type: string

    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.

  • description
    Type: string

    A free-form reference to describe the checkout

  • line_items
    Type: array of LineItem

    Details about the products sold or services provided

    Properties: 4
  • created
    Type: stringFormat: date-time
    required

    Time at which the object was created. Measured in seconds since the Unix epoch.