Checkout
Retrieve a Checkout Session
Getting Started
Charge
Capabilities
Subaccount
Banking
Checkout
Retrieve a Checkout Session
Retrieve a Checkout Session and its details by Ivy id.
POST
/
api
/
service
/
checkout
/
session
/
details
curl --request POST \
--url https://api.sand.getivy.de/api/service/checkout/session/details \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"id": "<string>"
}'
{
"market": "AF",
"availableMarkets": [
"AF"
],
"id": "<string>",
"express": true,
"paymentMode": "settlement",
"handshake": true,
"guest": true,
"disableBankSelection": true,
"price": {
"total": 123,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"appId": "<string>",
"merchantAppId": "<string>",
"merchant": {
"id": "<string>",
"appId": "<string>",
"address": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF"
},
"legalName": "<string>"
},
"lineItems": [
{
"name": "<string>",
"referenceId": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"quantity": 123,
"image": "<string>",
"category": "<string>",
"EAN": "<string>"
}
],
"plugin": "<string>",
"prefill": {
"bankId": "<string>"
},
"locale": "de",
"required": {
"phone": true
},
"offsetProject": "<string>",
"expiresAt": 123,
"created": 123,
"impactOffsetProjects": [
"<string>"
],
"shopLogo": "<string>",
"shopName": "<string>",
"customer": {
"id": "<string>"
},
"incentiveMode": "white_label",
"shippingMethods": [
{
"id": "<string>",
"price": 123,
"name": "<string>",
"countries": [
"AF"
],
"reference": "<string>",
"timeFrame": "<string>",
"deliveryEstimate": {
"minimum": {
"unit": "hour",
"value": 123
},
"maximum": {
"unit": "hour",
"value": 123
}
}
}
],
"selectedShippingMethodId": "<string>",
"status": "open",
"mandate": {
"setup": true,
"referenceId": "<string>",
"accountHolderName": "<string>",
"userNotificationEmail": "<string>"
},
"referenceId": "<string>",
"displayId": "<string>",
"metadata": {},
"category": "<string>",
"abortReason": "<string>",
"billingAddress": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF"
},
"shippingAddress": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF"
},
"redirectUrl": "<string>",
"successCallbackUrl": "<string>",
"errorCallbackUrl": "<string>",
"quoteCallbackUrl": "<string>",
"completeCallbackUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"subaccountId": "<string>",
"paymentSchemeSelection": "<string>"
}
Authorizations
Body
application/json
Response
200 - application/json
Returns the external representation of the CheckoutSession
The response is of type object
.
curl --request POST \
--url https://api.sand.getivy.de/api/service/checkout/session/details \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"id": "<string>"
}'
{
"market": "AF",
"availableMarkets": [
"AF"
],
"id": "<string>",
"express": true,
"paymentMode": "settlement",
"handshake": true,
"guest": true,
"disableBankSelection": true,
"price": {
"total": 123,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"appId": "<string>",
"merchantAppId": "<string>",
"merchant": {
"id": "<string>",
"appId": "<string>",
"address": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF"
},
"legalName": "<string>"
},
"lineItems": [
{
"name": "<string>",
"referenceId": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"quantity": 123,
"image": "<string>",
"category": "<string>",
"EAN": "<string>"
}
],
"plugin": "<string>",
"prefill": {
"bankId": "<string>"
},
"locale": "de",
"required": {
"phone": true
},
"offsetProject": "<string>",
"expiresAt": 123,
"created": 123,
"impactOffsetProjects": [
"<string>"
],
"shopLogo": "<string>",
"shopName": "<string>",
"customer": {
"id": "<string>"
},
"incentiveMode": "white_label",
"shippingMethods": [
{
"id": "<string>",
"price": 123,
"name": "<string>",
"countries": [
"AF"
],
"reference": "<string>",
"timeFrame": "<string>",
"deliveryEstimate": {
"minimum": {
"unit": "hour",
"value": 123
},
"maximum": {
"unit": "hour",
"value": 123
}
}
}
],
"selectedShippingMethodId": "<string>",
"status": "open",
"mandate": {
"setup": true,
"referenceId": "<string>",
"accountHolderName": "<string>",
"userNotificationEmail": "<string>"
},
"referenceId": "<string>",
"displayId": "<string>",
"metadata": {},
"category": "<string>",
"abortReason": "<string>",
"billingAddress": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF"
},
"shippingAddress": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF"
},
"redirectUrl": "<string>",
"successCallbackUrl": "<string>",
"errorCallbackUrl": "<string>",
"quoteCallbackUrl": "<string>",
"completeCallbackUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"subaccountId": "<string>",
"paymentSchemeSelection": "<string>"
}