POST
/
api
/
service
/
checkout
/
session
/
expire
curl --request POST \
  --url https://api.sand.getivy.de/api/service/checkout/session/expire \
  --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>",
    "payerFinancialAddress": {
      "type": "<string>",
      "iban": {
        "iban": "<string>",
        "bic": "<string>",
        "accountHolderName": "<string>"
      },
      "sortCode": {
        "sortCode": "<string>",
        "accountNumber": "<string>",
        "accountHolderName": "<string>"
      },
      "bankCode": {
        "code": "<string>",
        "accountNumber": "<string>",
        "accountHolderName": "<string>"
      },
      "bban": {
        "bban": "<string>",
        "accountHolderName": "<string>",
        "bic": "<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

​
X-Ivy-Api-Key
string
header
required

Body

application/json
​
id
string
required

Response

200 - application/json
Returns the external representation of the CheckoutSession
​
availableMarkets
enum<string>[]
required

The markets where the user of the Checkout can select banks from.

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
​
id
string
required

The unique identifier of the Checkout within Ivy.

​
paymentMode
enum<string>
default:
settlement
required
  • settlement: The payment is initially settled into a virtual account. The funds are then disbursed in batches to the merchant. Refunds are instantly processed from the virtual account.
  • direct: The payment will be settled to the specified settlementDestination account. settlementDestination is required if paymentMode is direct.
Available options:
settlement,
direct
​
price
object
required

The amount to be paid by the user. The amounts is in decimals, i.e. 10.23 represents EUR 10.23. Any amount of decimal places can be provided on initialization, but the actual transfer amount is rounded to 2 decimal places, as this is the format accepted by most banks.

​
merchant
object
required
​
status
any
required
​
referenceId
string
required

An internal reference id which will be stored with the checkout & corresponding order. Needs to be unique per shop per order and can be up to 200 characters. We recommend to use your internal order id here.

Maximum length: 200
​
displayId
string
required

The customer facing id. This id is displayed to the user during the checkout and in the merchant dashboard.

Maximum length: 200
​
redirectUrl
string
required
​
successCallbackUrl
string
required

Required if not set in the dashboard. Users will be redirected here after a successful Payment attempt.

​
errorCallbackUrl
string
required

Required if not set in the dashboard. Users will be redirected here after an unsuccessful Payment attempt.

​
createdAt
string
required
​
updatedAt
string
required
​
market
enum<string>

ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is located. If provided, the Checkout will display the market's banks first. Not relevant if prefill.bankId is provided.

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
​
express
boolean

False by default. If set to true, the Checkout is displayed in express mode.

​
handshake
boolean

If true, the order must be confirmed through the merchant with an additional complete callback endpoint. Always true for express sessions.

​
guest
boolean

False by default. If set to true, customers skip email input and jump directly to their bank login. For express Checkout Sessions this is always false.

​
disableBankSelection
boolean

False by default. If set to true, customers cannot modify the pre-selected bank from prefill.bankId.

​
appId
string
​
merchantAppId
string

Use merchant.appId instead

​
lineItems
object[]

The line items of the Checkout.

​
plugin
string

The shop-plugin version.

​
prefill
object

Prefill known data to skip steps in the checkout.

​
locale
enum<string>

The locale of the Checkout. If provided, the Checkout will be displayed in the given language. Users can change the language in the Checkout. If not provided, the language of the Checkout is determined by the browser's language.

Available options:
de,
nl,
en,
fr,
es,
it,
pt,
sv,
pl,
sk
​
required
object

Only applicable for express Checkout Sessions. The given fields will be required input within the Ivy express Checkout.

​
offsetProject
string
​
expiresAt
number

The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 1 hour from creation.

​
created
number

The Epoch time in seconds at which the Checkout Session was created. By default, time of Checkout creation at Ivy.

​
impactOffsetProjects
string[]

The logo of the shop provided as a URL.

​
shopName
string
​
customer
object
​
incentiveMode
enum<string>
default:
white_label

The incentive mode of the checkout session. For any use-case apart from e-commerce, please use white_label as the value. If set to white_label, the checkout session will be white labeled. If set to sustainable, the checkout session will contain sustainable incentives for users.

Available options:
white_label,
sustainable
​
shippingMethods
object[]

The shipping methods of the Checkout.

​
selectedShippingMethodId
string
​
mandate
object
​
metadata
object

Any data which will be stored and returned for this checkout session and corresponding order. See here for more info.

​
category
string

The merchant category code or MCC.

​
abortReason
string
​
billingAddress
object

The billing address of the customer. Required when handshake=true.

​
shippingAddress
object
​
quoteCallbackUrl
string

Only applicable for express Checkouts. Quote Callback requests will be sent to this URL.

​
completeCallbackUrl
string

Only applicable for express Checkouts. Complete Callback requests will be sent to this URL.

​
subaccountId
string
​
paymentSchemeSelection
string
Retrieve a Checkout SessionCreate a new customer