Retrieve a Checkout Session
curl --request POST \
--url https://api.getivy.de/api/service/checkout/session/details \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"id": "<string>"
}
'import requests
url = "https://api.getivy.de/api/service/checkout/session/details"
payload = { "id": "<string>" }
headers = {
"X-Ivy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Ivy-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: '<string>'})
};
fetch('https://api.getivy.de/api/service/checkout/session/details', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getivy.de/api/service/checkout/session/details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getivy.de/api/service/checkout/session/details"
payload := strings.NewReader("{\n \"id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getivy.de/api/service/checkout/session/details")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/checkout/session/details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"appId": "<string>",
"merchantAppId": "<string>",
"merchant": {
"id": "<string>",
"appId": "<string>",
"legalName": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
}
},
"lineItems": [
{
"name": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"referenceId": "<string>",
"quantity": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>",
"co2Grams": 1
}
],
"expiresAt": 123,
"created": 123,
"status": "open",
"referenceId": "<string>",
"displayId": "<string>",
"redirectUrl": "<string>",
"successCallbackUrl": "<string>",
"errorCallbackUrl": "<string>",
"market": "AF",
"availableMarkets": [
"AF"
],
"express": true,
"paymentMode": "direct",
"handshake": true,
"guest": true,
"disableBankSelection": true,
"plugin": "<string>",
"prefill": {
"bankId": "<string>"
},
"locale": "de",
"required": {
"phone": true
},
"offsetProject": "<string>",
"impactOffsetProjects": [
"<string>"
],
"shopLogo": "<string>",
"shopName": "<string>",
"customer": {
"id": "<string>"
},
"incentiveMode": "<string>",
"shippingMethods": [
"<unknown>"
],
"selectedShippingMethodId": "<string>",
"metadata": {},
"category": "<string>",
"abortReason": "<string>",
"billingAddress": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"shippingAddress": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"quoteCallbackUrl": "<string>",
"completeCallbackUrl": "<string>",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"subaccountId": "<string>",
"paymentSchemeSelection": "instant_preferred"
}Checkout
Retrieve a Checkout Session
Retrieve a Checkout Session and its details by Ivy id.
POST
/
api
/
service
/
checkout
/
session
/
details
Retrieve a Checkout Session
curl --request POST \
--url https://api.getivy.de/api/service/checkout/session/details \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"id": "<string>"
}
'import requests
url = "https://api.getivy.de/api/service/checkout/session/details"
payload = { "id": "<string>" }
headers = {
"X-Ivy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Ivy-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: '<string>'})
};
fetch('https://api.getivy.de/api/service/checkout/session/details', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getivy.de/api/service/checkout/session/details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getivy.de/api/service/checkout/session/details"
payload := strings.NewReader("{\n \"id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getivy.de/api/service/checkout/session/details")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/checkout/session/details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"appId": "<string>",
"merchantAppId": "<string>",
"merchant": {
"id": "<string>",
"appId": "<string>",
"legalName": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
}
},
"lineItems": [
{
"name": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"referenceId": "<string>",
"quantity": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>",
"co2Grams": 1
}
],
"expiresAt": 123,
"created": 123,
"status": "open",
"referenceId": "<string>",
"displayId": "<string>",
"redirectUrl": "<string>",
"successCallbackUrl": "<string>",
"errorCallbackUrl": "<string>",
"market": "AF",
"availableMarkets": [
"AF"
],
"express": true,
"paymentMode": "direct",
"handshake": true,
"guest": true,
"disableBankSelection": true,
"plugin": "<string>",
"prefill": {
"bankId": "<string>"
},
"locale": "de",
"required": {
"phone": true
},
"offsetProject": "<string>",
"impactOffsetProjects": [
"<string>"
],
"shopLogo": "<string>",
"shopName": "<string>",
"customer": {
"id": "<string>"
},
"incentiveMode": "<string>",
"shippingMethods": [
"<unknown>"
],
"selectedShippingMethodId": "<string>",
"metadata": {},
"category": "<string>",
"abortReason": "<string>",
"billingAddress": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"shippingAddress": {
"line1": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF",
"firstName": "<string>",
"lastName": "<string>",
"line2": "<string>",
"region": "<string>"
},
"quoteCallbackUrl": "<string>",
"completeCallbackUrl": "<string>",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"subaccountId": "<string>",
"paymentSchemeSelection": "instant_preferred"
}Authorizations
API key for authentication
Body
application/json
The checkout session id to retrieve details for
Response
200 - application/json
Returns the checkout session details
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
open, closed, expired Available options:
AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IL, IT, JM, JP, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, MK, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, AX, BQ, CW, GG, IM, JE, ME, BL, MF, RS, SX, SS, XK Available options:
AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IL, IT, JM, JP, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, MK, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, AX, BQ, CW, GG, IM, JE, ME, BL, MF, RS, SX, SS, XK Available options:
direct, settlement Show child attributes
Show child attributes
Available options:
de, nl, en, fr, es, fi, it, pt, sv, pl, sk, lt Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
instant_preferred, standard, instant_only Was this page helpful?