Getting Started
Capabilities
Payout Report
Charge
Banking
Checkout
Create a Checkout Session
Creates a Checkout Session for the merchant corresponding to the given API key. See the guide for more information.
POST
/
api
/
service
/
checkout
/
session
/
create
Copy
curl --request POST \
--url https://api.sand.getivy.de/api/service/checkout/session/create \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"express": false,
"paymentMode": "direct",
"settlementDestination": {
"reference": "<string>",
"financialAddress": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"paymentReference": "<string>",
"psuData": {
"username": "<string>",
"branchNumber": "<string>",
"ssn": "<string>",
"oib": "<string>",
"ipAddress": "<string>",
"psuId": "<string>",
"clientId": "<string>"
}
}
},
"referenceId": "<string>",
"displayId": "<string>",
"metadata": {},
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"lineItems": [
{
"name": "<string>",
"referenceId": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"quantity": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>"
}
],
"billingAddress": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF"
},
"prefill": {
"bankId": "<string>"
},
"created": 1749726329,
"expiresAt": 123,
"locale": "de",
"disableBankSelection": false,
"successCallbackUrl": "<string>",
"errorCallbackUrl": "<string>",
"quoteCallbackUrl": "<string>",
"completeCallbackUrl": "<string>",
"market": "AF",
"mandate": {
"setup": false,
"referenceId": "<string>",
"accountHolderName": "<string>",
"userNotificationEmail": "<string>",
"additionalDisplayInformation": {
"price": {
"amount": 123,
"currency": "EUR"
},
"cadence": "BI_WEEKLY"
}
},
"subaccountId": "<string>",
"paymentSchemeSelection": "instant_preferred",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com"
},
"themeVariant": "light"
}'
Copy
{
"id": "<string>",
"market": "AF",
"availableMarkets": [
"AF"
],
"express": true,
"paymentMode": "direct",
"handshake": true,
"guest": true,
"disableBankSelection": true,
"price": {
"total": 1.01,
"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": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>",
"co2Grams": 1
}
],
"plugin": "<string>",
"prefill": "<any>",
"locale": "de",
"required": {
"phone": true
},
"offsetProject": "<string>",
"expiresAt": 123,
"created": 123,
"impactOffsetProjects": [
"<string>"
],
"shopLogo": "<string>",
"shopName": "<string>",
"customer": {
"id": "<string>"
},
"incentiveMode": "<string>",
"shippingMethods": [
"<any>"
],
"selectedShippingMethodId": "<string>",
"status": "open",
"mandate": {
"setup": false
},
"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": "<any>",
"updatedAt": "<any>",
"subaccountId": "<string>",
"paymentSchemeSelection": "instant_preferred"
}
Authorizations
API key for authentication
Body
application/json
Response
200 - application/json
Returns the created checkout session
The response is of type object
.
Copy
curl --request POST \
--url https://api.sand.getivy.de/api/service/checkout/session/create \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"express": false,
"paymentMode": "direct",
"settlementDestination": {
"reference": "<string>",
"financialAddress": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"paymentReference": "<string>",
"psuData": {
"username": "<string>",
"branchNumber": "<string>",
"ssn": "<string>",
"oib": "<string>",
"ipAddress": "<string>",
"psuId": "<string>",
"clientId": "<string>"
}
}
},
"referenceId": "<string>",
"displayId": "<string>",
"metadata": {},
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"lineItems": [
{
"name": "<string>",
"referenceId": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"quantity": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>"
}
],
"billingAddress": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF"
},
"prefill": {
"bankId": "<string>"
},
"created": 1749726329,
"expiresAt": 123,
"locale": "de",
"disableBankSelection": false,
"successCallbackUrl": "<string>",
"errorCallbackUrl": "<string>",
"quoteCallbackUrl": "<string>",
"completeCallbackUrl": "<string>",
"market": "AF",
"mandate": {
"setup": false,
"referenceId": "<string>",
"accountHolderName": "<string>",
"userNotificationEmail": "<string>",
"additionalDisplayInformation": {
"price": {
"amount": 123,
"currency": "EUR"
},
"cadence": "BI_WEEKLY"
}
},
"subaccountId": "<string>",
"paymentSchemeSelection": "instant_preferred",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com"
},
"themeVariant": "light"
}'
Copy
{
"id": "<string>",
"market": "AF",
"availableMarkets": [
"AF"
],
"express": true,
"paymentMode": "direct",
"handshake": true,
"guest": true,
"disableBankSelection": true,
"price": {
"total": 1.01,
"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": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>",
"co2Grams": 1
}
],
"plugin": "<string>",
"prefill": "<any>",
"locale": "de",
"required": {
"phone": true
},
"offsetProject": "<string>",
"expiresAt": 123,
"created": 123,
"impactOffsetProjects": [
"<string>"
],
"shopLogo": "<string>",
"shopName": "<string>",
"customer": {
"id": "<string>"
},
"incentiveMode": "<string>",
"shippingMethods": [
"<any>"
],
"selectedShippingMethodId": "<string>",
"status": "open",
"mandate": {
"setup": false
},
"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": "<any>",
"updatedAt": "<any>",
"subaccountId": "<string>",
"paymentSchemeSelection": "instant_preferred"
}
Assistant
Responses are generated using AI and may contain mistakes.