CreateHppSessionRequest

Same shape as Create a Payment Intent: amount, currency, capture_method, and any other payment-intent field you include are forwarded and validated exactly as documented there. Only payment_method_types and billing_details are intercepted by Kort itself before forwarding.

amount
Type: integer
min:
1
required

Amount to charge, in the currency's smallest unit (e.g. cents for USD).
currency
Type: string
required

Three-letter ISO 4217 currency code.
apply_surcharge
Type: boolean

Whether to apply the account's surcharge rate to this payment intent. The final surcharge amount is calculated when the payment is captured or confirmed.
billing_details
Type:

Shaped like the billing_details object in Create a Payment Method. Kort stores it alongside the session so the hosted page can display it and attach it to the card payment method it creates when the customer confirms.

Properties: 4
capture_method
Type: "automatic" or "manual"enum

manual authorizes only, you capture later via the Payment automatic captures the charge immediately on confirmation; Intents API.
confirm
Type: boolean

Set to true to attempt to confirm the payment intent immediately.
level3
Type:

Level 2/3 card data. Supplying it can qualify B2B, card-not-present transactions for lower interchange rates.

Properties: 6
metadata
Type: object

Key-value pairs you can attach to the payment intent for your own structured record-keeping.

Properties: 1
occurrence_type
Type: "consumer_ad_hoc" or "merchant_ad_hoc" or "merchant_recurring"enum

Identifies authorization requests that use stored credentials, to improve authorization rates and reduce fraud. consumer_ad_hoc: ad hoc consumer-initiated request. merchant_ad_hoc: unscheduled merchant-initiated request. merchant_recurring: scheduled, merchant-initiated recurring request.
payment_method_id
Type: string

ID of an existing payment method to attach, instead of creating a new one via the hosted page.
payment_method_types
Type: array of "card" 1…1enum
const:
card

Fixed to ["card"] (the only method the hosted page supports today).
platform_fee_amount
Type: integer
min:
0

Amount of the platform fee, if any, to apply to the payment. Capped at the total payment amount.
statement_descriptor_suffix
Type: string
min length:
1
max length:
20

Appended to your account's statement descriptor prefix on the customer's statement. Maximum 20 characters for the concatenated descriptor.
propertyName
additionalPropertyType: anything

Create a session

Level3