ZAzahlo
Checkout

Retrieve a checkout session

Retrieve a checkout session. Use the response status and request ID to decide whether to retry, reconcile, or ask the customer for action.

get/api/v1/checkout-sessions/{id}

Request

  • Base URL
    https://merchant.zahlo.eu
  • Auth
    HTTP bearer

Path parameters

idstring required

The resource identifier returned by the merchant API.

Response

Successful response

idstring required
object'checkout_session' required
livemodeboolean
createdAtstring date-time
type'payment' | 'setup' | 'subscription' required
mode'hosted' | 'embedded' required
status'open' | 'complete' | 'expired' | 'failed' required
paymentStatus'unpaid' | 'paid' | 'no_payment_required' required
urlstring uri nullable

Hosted only, while open: redirect the customer here.

clientTokenstring nullable

Embedded only, while open: pass it to the browser SDK.

detailsRequiredboolean

Embedded only: true until the payer completed Zahlo's details step (the browser SDK mounts it first); embedUrl is null meanwhile.

embedUrlstring uri nullable
expiresAtstring date-time required
currencystring required
amountSubtotalinteger
amountDiscountinteger
amountShippinginteger

The chosen shipping option, inside amountTotal; 0 without one.

amountTotalinteger required
customerIdstring nullable
setupFutureUsage'off_session' nullable

Set when the session saves the card for off-session charges.

customerEmailstring nullable
couponIdstring nullable
paymentIdstring nullable
subscriptionIdstring nullable
referencestring nullable
allowPromotionCodesboolean
submitType'auto' | 'pay' | 'book' | 'donate'
successUrlstring
cancelUrlstring
localestring
paymentMethodTypesstring[]
metadataobject

Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

Changes

No recorded changes to this operation across all 1 revision of this API.