Authorizations
API key for authentication
Body
An internal reference id which will be stored with the data session. Needs to be unique per data session. Maximum length is 200 characters.
200
Currently only visible in the merchant dashboard. This id used to be displayed to the user during the checkout.
200
The locale of the data session. If not provided, the default locale will be used.
de
, nl
, en
, fr
, es
, fi
, it
, pt
, sv
, pl
, sk
, lt
ISO 3166-1 alpha-2 country code of the market. If set, the market's default banks will be displayed during the Data Session.
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
Required if not set in the dashboard. Users will be redirected here after a successful session.
Required if not set in the dashboard. Users will be redirected here after a unsuccessful session.
The Epoch time in seconds at which the Session should expire. It can be anywhere from 30 minutes to 24 hours after Session creation. By default, this value is 1 hour from creation. When setting this field, you also need to set created
.
Required when setting expiresAt. The Epoch time in seconds at which the Session was created.
The theme variant which will be used in the data session. If not provided, the default light theme will be used.
light
, dark
Prefill options for the data session
False by default. If set to true, customers cannot choose another bank than the pre-selected one.
Response
Returns the details of the data session
The id of the data session.
An internal reference id for the data session.
The redirect URL of the data session.
Currently only visible in the merchant dashboard. This id used to be displayed to the user during the checkout.
The id of the merchant.
The status of the data session.
open
, closed
, expired
The Epoch time in seconds at which the Session was created.
The Epoch time in seconds at which the Session was updated.
The Epoch time in seconds at which the Session will expire.
The markets where the user of the Data Session can select banks from.
Whether customers can choose another bank than the pre-selected one.
The URL where users will be redirected after a successful session.
The URL where users will be redirected after an unsuccessful session.
The locale of the data session.
de
, nl
, en
, fr
, es
, fi
, it
, pt
, sv
, pl
, sk
, lt
ISO 3166-1 alpha-2 country code of the market.
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
Any data stored with this data session.
Prefill options for the data session