Card
Starts a new card 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
POST /egw/{version}/payments/{paymentId}/sessions/card HTTP/1.1
Host: hostname
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 107
{
"card": {
"cardholderName": "text",
"cardNumber": "text",
"expiry": {
"month": "text",
"year": "text"
},
"csc": "text"
}
}{
"sessionId": "text",
"sessionStatus": "INITIALIZED",
"action": {
"type": "AUTHENTICATE_WITH_3DS",
"_links": {
"threeDsMethod": {
"href": "text"
},
"checkoutRedirect": {
"href": "text"
}
}
}
}Get previously created checkout session
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}/card HTTP/1.1
Host: hostname
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
{
"sessionId": "text",
"sessionStatus": "INITIALIZED",
"action": {
"type": "AUTHENTICATE_WITH_3DS",
"_links": {
"threeDsMethod": {
"href": "text"
},
"checkoutRedirect": {
"href": "text"
}
}
}
}Initiate 3DS authentication for 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
Request containing payment and 3DS browser data for 3DS authentication
Exact content of the HTTP accept headers as sent to the 3DS Requestor from the Cardholder’s browser
IP address of the browser as returned by the HTTP headers to the 3DS Requestor
Boolean that represents the ability of the cardholder browser to execute Java
Boolean that represents the ability of the cardholder browser to execute JavaScript
Value representing the browser language as defined in IETF BCP47
Value representing the bit depth of the colour palette for displaying images, in bits per pixel
Total height of the Cardholder’s screen in pixels
Total width of the Cardholder’s screen in pixels
Time-zone offset in minutes between UTC and the Cardholder browser local time
Exact content of the HTTP user-agent header
PATCH /egw/{version}/payments/{paymentId}/sessions/{sessionId}/card/three-ds/authentication HTTP/1.1
Host: hostname
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 261
{
"browserAcceptHeader": "text",
"browserIp": "text",
"browserJavaEnabled": true,
"browserJavascriptEnabled": true,
"browserLanguage": "text",
"browserColorDepth": "text",
"browserScreenHeight": "text",
"browserScreenWidth": "text",
"browserTZ": "text",
"browserUserAgent": "text"
}{
"sessionId": "text",
"sessionStatus": "INITIALIZED",
"action": {
"type": "AUTHENTICATE_WITH_3DS",
"_links": {
"threeDsMethod": {
"href": "text"
},
"checkoutRedirect": {
"href": "text"
}
}
}
}Complete 3DS challenge for 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
Request to complete the 3DS challenge
Base64-encoded CRes message, as received from the ACS
PATCH /egw/{version}/payments/{paymentId}/sessions/{sessionId}/card/three-ds/challenge-result HTTP/1.1
Host: hostname
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"cres": "text"
}{
"sessionId": "text",
"sessionStatus": "INITIALIZED",
"action": {
"type": "REDIRECT_TO_SHOP",
"_links": {
"shopRedirect": {
"href": "text"
}
}
}
}Last updated
Was this helpful?