Open Banking
Starts a new bank checkout session for the payment.
This endpoint is available only for customer-initiated payments.
Unique ID of the payment
ID of the request, unique to the call, as determined by the initiating party
User's browser IP address
Exact content of the HTTP user-agent header
Preferred locale for the checkout page, defaults to the locale sent in payment initiation request
POST /egw/{version}/payments/{paymentId}/sessions/bank HTTP/1.1
Host: hostname
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 94
{
"bank": {
"bankId": "text"
},
"browserIp": "text",
"browserUserAgent": "text",
"preferredLocale": "cz"
}{
"sessionId": "text",
"sessionStatus": "INITIALIZED",
"action": {
"type": "REDIRECT_TO_SCA",
"_links": {
"scaRedirect": {
"href": "text"
}
}
}
}Create consent for the payment, after completing pre-step SCA
Unique ID of the payment
Unique ID of the checkout session
ID of the request, unique to the call, as determined by the initiating party
Preferred locale for the checkout page, defaults to the locale sent in payment initiation request
PATCH /egw/{version}/payments/{paymentId}/sessions/{sessionId}/bank/consent HTTP/1.1
Host: hostname
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"preferredLocale": "cz"
}{
"sessionId": "text",
"sessionStatus": "INITIALIZED",
"action": {
"type": "REDIRECT_TO_SCA",
"_links": {
"scaRedirect": {
"href": "text"
}
}
}
}Get available bank accounts for the user
Unique ID of the payment
Unique ID of the checkout session
ID of the request, unique to the call, as determined by the initiating party
GET /egw/{version}/payments/{paymentId}/sessions/{sessionId}/bank/accounts HTTP/1.1
Host: hostname
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
{
"sessionId": "text",
"sessionStatus": "INITIALIZED",
"action": {
"type": "SELECT_ACCOUNT",
"accounts": [
{
"displayName": "text",
"iban": "text",
"balance": "text",
"currency": "text",
"ownerName": "text"
}
]
}
}Confirm and initiate the payment
Unique ID of the payment
Unique ID of the checkout session
ID of the request, unique to the call, as determined by the initiating party
International Bank Account Number of the bank account to be used for the payment
Preferred language for the checkout page. Defaults to language sent in one-off or CIT request, if missing
PATCH /egw/{version}/payments/{paymentId}/sessions/{sessionId}/bank/confirm HTTP/1.1
Host: hostname
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"iban": "text",
"preferredLocale": "cz"
}{
"sessionId": "text",
"sessionStatus": "INITIALIZED",
"action": {
"type": "REDIRECT_TO_SCA",
"_links": {
"scaRedirect": {
"href": "text"
}
}
}
}Check the status of the payment and mark as completed
Unique ID of the payment
Unique ID of the checkout session
ID of the request, unique to the call, as determined by the initiating party
PATCH /egw/{version}/payments/{paymentId}/sessions/{sessionId}/bank/complete HTTP/1.1
Host: hostname
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
{
"sessionId": "text",
"sessionStatus": "INITIALIZED",
"completionStatus": "SUCCESS",
"action": {
"type": "REDIRECT_TO_SHOP",
"_links": {
"shopRedirect": {
"href": "text"
}
}
}
}Last updated
Was this helpful?