CheckoutSession
Hosted checkout session returned by the online transaction service.
sessionIdstringrequired
checkoutUrlstring<uri>required
Shopper-facing URL to open for this checkout session.
locationIdstringrequired
statusCheckoutSessionStatus (string)required
Possible values: [PENDING, COMPLETED, CANCELLED, EXPIRED]
expiresAtstring<date-time>required
sessionTokenstringnullable
amountinteger<int64>nullable
currencystringnullable
descriptionstringnullable
customerEmailstring<email>nullable
organizationIdstringnullable
merchantNamestringnullable
merchantLogoUrlstring<uri>nullable
merchantPrimaryColorstringnullable
successUrlstring<uri>nullable
cancelUrlstring<uri>nullable
transactionIdstringnullable
lineItems object[]nullable
Array [
idstringrequired
namestringrequired
descriptionstringnullable
quantityintegerrequired
unitPriceinteger<int64>required
totalPriceinteger<int64>required
priceIdstringnullable
imageUrlstring<uri>nullable
]
allowedPaymentMethodsstring[]nullable
metadata objectnullable
property name*anynullable
createdAtstring<date-time>nullable
shippingOptions object[]nullable
Array [
idstringrequired
namestringrequired
amountintegerrequired
Possible values: >= 0
estimatedDaysMinintegernullable
estimatedDaysMaxintegernullable
]
selectedShippingRateIdstringnullable
shippingCostinteger<int64>nullable
discountAmountinteger<int64>nullable
promotionCodestringnullable
promotionCodes object[]nullable
Array [
codestringrequired
discountAmountinteger<int64>required
ordinalintegerrequired
]
amountTotalinteger<int64>nullable
totalTaxinteger<int64>nullable
taxBreakdown object[]nullable
Array [
jurisdictionTypestringrequired
jurisdictionCodestringrequired
jurisdictionNamestringnullable
rateBpsintegernullable
taxAmountinteger<int64>required
sourceConfigIdstringrequired
]
tokenizationModestringrequired
Possible values: [DIRECT, CARDPOINTE_IFRAME]
cardPointeTokenizerSitestringnullable
giftCardEnabledbooleanrequired
paymentCapabilities objectrequired
ach objectrequired
availablebooleanrequired
statusstringrequired
reasonstringrequired
payerAuthentication objectrequired
availablebooleanrequired
statusstringrequired
reasonstringrequired
agenticCheckout objectnullable
availabilitystringrequired
Possible values: [UNAVAILABLE, NOT_REQUESTED, STEP_UP_REQUIRED, READY]
CheckoutSession
{
"sessionId": "string",
"checkoutUrl": "string",
"locationId": "string",
"status": "PENDING",
"expiresAt": "2024-07-29T15:51:28.071Z",
"sessionToken": "string",
"amount": 0,
"currency": "string",
"description": "string",
"customerEmail": "[email protected]",
"organizationId": "string",
"merchantName": "string",
"merchantLogoUrl": "string",
"merchantPrimaryColor": "string",
"successUrl": "string",
"cancelUrl": "string",
"transactionId": "string",
"lineItems": [
{
"id": "string",
"name": "string",
"description": "string",
"quantity": 0,
"unitPrice": 0,
"totalPrice": 0,
"priceId": "string",
"imageUrl": "string"
}
],
"allowedPaymentMethods": [
"string"
],
"metadata": {},
"createdAt": "2024-07-29T15:51:28.071Z",
"shippingOptions": [
{
"id": "string",
"name": "string",
"amount": 0,
"estimatedDaysMin": 0,
"estimatedDaysMax": 0
}
],
"selectedShippingRateId": "string",
"shippingCost": 0,
"discountAmount": 0,
"promotionCode": "string",
"promotionCodes": [
{
"code": "string",
"discountAmount": 0,
"ordinal": 0
}
],
"amountTotal": 0,
"totalTax": 0,
"taxBreakdown": [
{
"jurisdictionType": "string",
"jurisdictionCode": "string",
"jurisdictionName": "string",
"rateBps": 0,
"taxAmount": 0,
"sourceConfigId": "string"
}
],
"tokenizationMode": "DIRECT",
"cardPointeTokenizerSite": "string",
"giftCardEnabled": true,
"paymentCapabilities": {
"ach": {
"available": true,
"status": "string",
"reason": "string"
},
"payerAuthentication": {
"available": true,
"status": "string",
"reason": "string"
}
},
"agenticCheckout": {
"availability": "UNAVAILABLE"
}
}