{"id":866,"date":"2025-06-02T10:21:51","date_gmt":"2025-06-02T10:21:51","guid":{"rendered":"https:\/\/lddpay.com\/?post_type=docs&p=866"},"modified":"2025-06-03T12:06:54","modified_gmt":"2025-06-03T12:06:54","password":"","slug":"standalone-authentication","status":"publish","type":"docs","link":"https:\/\/lddpay.com\/zh\/docs\/standalone-authentication\/","title":{"rendered":"Standalone Authentication"},"content":{"rendered":"

Request a session<\/h2>\n\n\n\n

Create a payment session to authenticate a cardholder before requesting a payment. Payment sessions can be linked to one or more payments (in the case of recurring and other merchant-initiated payments). The next_actions object in the response tells you which actions can be performed next.<\/p>\n\n\n\n

Authorizations:<\/summary>\n

bearer<\/em><\/p>\n\n\n\n

<\/h5>\n\n\n\n
HTTP: bearer<\/h5>\n\n\n\n

HTTP Authorization Scheme: <\/strong>bearer<\/code><\/p>\n\n\n\n

Bearer format: <\/strong>JWT<\/code><\/p>\n<\/details>\n\n\n\n

<\/p>\n\n\n\n

header Parameters<\/h5>\n\n\n\n
Authorizationrequired<\/td>stringBearer token (OAuth2 Access Token).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Request Body schema: application\/json<\/h5>\n\n\n\n

Request body for creating a standalone authentication session.<\/p>\n\n\n\n

source required object (The source of the authentication.)<\/summary>\n
numberrequired<\/td>string [ 13 .. 19 ] characters The card number.<\/td><\/tr>
expiry_monthrequired<\/td>number [ 1 .. 12 ] The expiry month of the card.<\/td><\/tr>
expiry_yearrequired<\/td>numberThe expiry year of the card (4 digits).<\/td><\/tr>
scheme<\/td>stringIndicates the cardholder scheme choice.<\/td><\/tr>
billing_address<\/td>objectThe customer’s billing address.<\/td><\/tr>
home_phone<\/td>objectThe cardholder’s home phone number.<\/td><\/tr>
mobile_phone<\/td>objectThe cardholder’s mobile phone number.<\/td><\/tr>
work_phone<\/td>objectThe cardholder’s work phone number.<\/td><\/tr>
email<\/td>string <= 254 characters The email of the cardholder.<\/td><\/tr>
name<\/td>string [ 2 .. 45 ] characters The name of the cardholder.<\/td><\/tr>
stored<\/td>boolean Default: falseThis must be set to true for authentications that use stored card details.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
currencyrequired<\/td>string = 3 characters The three-letter ISO currency code.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/p>\n\n\n\n

completion required object (The completion (redirect) information.)<\/summary>\n
typerequired<\/td>string <= 10 characters Whether the session should be hosted by Checkout.com.<\/td><\/tr>
success_url<\/td>string <= 256 characters Overrides the default success redirect URL.<\/td><\/tr>
failure_url<\/td>string <= 256 characters Overrides the default failure redirect URL.<\/td><\/tr>
callback_url<\/td>stringCallback URL for non-hosted sessions.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
amount<\/td>number >= 0 The payment amount in the minor currency unit.<\/td><\/tr>
processing_channel_id<\/td>stringThe processing channel to be used for the session.<\/td><\/tr>
marketplace<\/td>objectInformation related to authentication for payfac payments.<\/td><\/tr>
authentication_type<\/td>stringIndicates the type of payment this session is for.<\/td><\/tr>
authentication_category<\/td>stringIndicates the category of the authentication request.<\/td><\/tr>
account_info<\/td>objectAdditional information about the Cardholder’s account.<\/td><\/tr>
challenge_indicator<\/td>stringIndicates whether a challenge is requested for this session.<\/td><\/tr>
billing_descriptor<\/td>objectAn optional dynamic billing descriptor.<\/td><\/tr>
reference<\/td>stringA reference you can later use to identify this payment.<\/td><\/tr>
merchant_risk_info<\/td>objectAdditional information about the cardholder’s purchase.<\/td><\/tr>
transaction_type<\/td>stringThe type of transaction being authenticated.<\/td><\/tr>
shipping_address<\/td>objectThe shipping address.<\/td><\/tr>
shipping_address_matches_billing<\/td>booleanIndicates whether the cardholder shipping address and billing address are the same.<\/td><\/tr>
channel_data<\/td>objectThe information gathered from the environment used to initiate the session.<\/td><\/tr>
recurring<\/td>objectDetails of a recurring authentication.<\/td><\/tr>
installment<\/td>objectDetails of an installment authentication.<\/td><\/tr>
optimization<\/td>objectOptionally opt into request optimization.<\/td><\/tr>
initial_transaction<\/td>objectDetails of a previous transaction.<\/td><\/tr>
google_spa<\/td>objectThis object contains the Google SPA properties (non-hosted only).<\/td><\/tr>
preferred_experiences<\/td>Array of stringsIndicates the chosen experience(s) for this session.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Responses<\/h5>\n\n\n\n
201 Session processed successfully<\/summary>\n
Cko-Request-Id<\/td>stringThe unique identifier of the request<\/td><\/tr>
Cko-Version<\/td>stringThe version of the API<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Response Schema: application\/json<\/h5>\n\n\n\n
session_secretrequired<\/td>stringA base64 encoded value prefixed with sek_ that gives access to client-side operations for a single authentication within the Sessions API.<\/td><\/tr>
idrequired<\/td>stringSession unique identifier.<\/td><\/tr>
transaction_idrequired<\/td>stringThe transaction identifier that needs to be provided when communicating directly with the Access Control Server (ACS).<\/td><\/tr>
schemerequired<\/td>stringIndicates the scheme this authentication is carried out against.<\/td><\/tr>
amountrequired<\/td>numberThe amount in the minor currency.<\/td><\/tr>
currencyrequired<\/td>stringThe three-letter ISO currency code.<\/td><\/tr>
completedrequired<\/td>booleanIndicates whether this session has been completed.<\/td><\/tr>
challengedrequired<\/td>booleanIndicates whether this session involved a challenge.<\/td><\/tr>
authentication_typerequired<\/td>stringIndicates the type of payment this session is for.<\/td><\/tr>
authentication_categoryrequired<\/td>stringIndicates the category of the authentication request.<\/td><\/tr>
certificates<\/td>objectPublic certificates specific to a Directory Server (DS) for encrypting device data and verifying ACS signed content.<\/td><\/tr>
statusrequired<\/td>stringIndicates the status of the session.<\/td><\/tr>
status_reason<\/td>stringWhen the Session is unavailable this will point to the reason it is so.<\/td><\/tr>
approved<\/td>booleanWhether the authentication was successful. This will only be set if the Session is in a final state.<\/td><\/tr>
protocol_versionrequired<\/td>stringThe protocol version number of the specification used by the API for authentication.<\/td><\/tr>
account_info<\/td>objectAdditional information about the Cardholder’s account.<\/td><\/tr>
merchant_risk_info<\/td>objectAdditional information about the cardholder’s purchase.<\/td><\/tr>
reference<\/td>stringA reference you can later use to identify this payment, such as an order number.<\/td><\/tr>
transaction_type<\/td>stringIdentifies the type of transaction being authenticated.<\/td><\/tr>
next_actions<\/td>Array of stringsSpecifies which action to take in order to complete the session.<\/td><\/tr>
ds<\/td>objectThe directory server (DS) information.<\/td><\/tr>
acs<\/td>objectThe access control server (ACS) information.<\/td><\/tr>
response_code<\/td>stringThe response from the DS or ACS which indicates whether a transaction qualifies as an authenticated transaction or account verification.<\/td><\/tr>
response_status_reason<\/td>stringThe response from the DS or ACS which provides information on why the response_code field has the specified value.<\/td><\/tr>
cryptogram<\/td>stringPayment system-specific value provided as part of the ACS registration for each supported DS.<\/td><\/tr>
eci<\/td>stringElectronic Commerce Indicator.<\/td><\/tr>
xid<\/td>stringThe xid value to use for authorization.<\/td><\/tr>
cardholder_info<\/td>stringMay provide cardholder information from the DS to be presented to the cardholder.<\/td><\/tr>
card<\/td>objectDetails related to the Session source.<\/td><\/tr>
recurring<\/td>objectDetails of a recurring authentication.<\/td><\/tr>
installment<\/td>objectDetails of an installment authentication.<\/td><\/tr>
initial_transaction<\/td>objectDetails of a previous transaction.<\/td><\/tr>
customer_ip<\/td>stringThe card holder’s IP address.<\/td><\/tr>
_linksrequired<\/td>objectThe links related to the session.<\/td><\/tr>
authentication_date<\/td>string <date-time> Authentication date and time<\/td><\/tr>
exemption<\/td>objectDetails related to exemption present in 3DS flow<\/td><\/tr>
flow_type<\/td>stringIndicates whether the 3D Secure 2 authentication was challenged or frictionless<\/td><\/tr>
challenge_indicatorrequired<\/td>stringIndicates the preference for whether or not a 3DS challenge should be performed.<\/td><\/tr>
optimization<\/td>objectThe information about the optimization options selected.<\/td><\/tr>
scheme_info<\/td>objectIndicates scheme-specific information<\/td><\/tr>
3ds<\/td>object3DS experience.<\/td><\/tr>
preferred_experiences<\/td>objectPreferred Experiences<\/td><\/tr>
experience<\/td>stringThe authentication experience that was used for processing<\/td><\/tr>
google_spa<\/td>objectGoogle SPA experience.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
202 Session accepted and further action required<\/summary>\n
Cko-Request-Id<\/td>stringThe unique identifier of the request<\/td><\/tr>
Cko-Version<\/td>stringThe version of the API<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Response Schema: application\/json<\/h5>\n\n\n\n
session_secretrequired<\/td>stringA base64 encoded value prefixed with sek_ that gives access to client-side operations for a single authentication within the Sessions API.<\/td><\/tr>
idrequired<\/td>stringSession unique identifier.<\/td><\/tr>
transaction_idrequired<\/td>stringThe transaction identifier that needs to be provided when communicating directly with the Access Control Server (ACS).<\/td><\/tr>
schemerequired<\/td>stringIndicates the scheme this authentication is carried out against.<\/td><\/tr>
amountrequired<\/td>numberThe amount in the minor currency.<\/td><\/tr>
currencyrequired<\/td>stringThe three-letter ISO currency code.<\/td><\/tr>
completedrequired<\/td>booleanIndicates whether this session has been completed.<\/td><\/tr>
challengedrequired<\/td>booleanIndicates whether this session involved a challenge.<\/td><\/tr>
authentication_typerequired<\/td>stringIndicates the type of payment this session is for.<\/td><\/tr>
authentication_categoryrequired<\/td>stringIndicates the category of the authentication request.<\/td><\/tr>
certificates<\/td>objectPublic certificates specific to a Directory Server (DS) for encrypting device data and verifying ACS signed content.<\/td><\/tr>
statusrequired<\/td>stringIndicates the status of the session.<\/td><\/tr>
status_reason<\/td>stringWhen the Session is unavailable this will point to the reason it is so.<\/td><\/tr>
approved<\/td>booleanWhether the authentication was successful. This will only be set if the Session is in a final state.<\/td><\/tr>
protocol_versionrequired<\/td>stringThe protocol version number of the specification used by the API for authentication.<\/td><\/tr>
account_info<\/td>objectAdditional information about the Cardholder’s account.<\/td><\/tr>
merchant_risk_info<\/td>objectAdditional information about the cardholder’s purchase.<\/td><\/tr>
reference<\/td>stringA reference you can later use to identify this payment, such as an order number.<\/td><\/tr>
transaction_type<\/td>stringIdentifies the type of transaction being authenticated.<\/td><\/tr>
next_actions<\/td>Array of stringsSpecifies which action to take in order to complete the session.<\/td><\/tr>
ds<\/td>objectThe directory server (DS) information.<\/td><\/tr>
acs<\/td>objectThe access control server (ACS) information.<\/td><\/tr>
response_code<\/td>stringThe response from the DS or ACS which indicates whether a transaction qualifies as an authenticated transaction or account verification.<\/td><\/tr>
response_status_reason<\/td>stringThe response from the DS or ACS which provides information on why the response_code field has the specified value.<\/td><\/tr>
cryptogram<\/td>stringPayment system-specific value provided as part of the ACS registration for each supported DS.<\/td><\/tr>
eci<\/td>stringElectronic Commerce Indicator.<\/td><\/tr>
xid<\/td>stringThe xid value to use for authorization.<\/td><\/tr>
cardholder_info<\/td>stringMay provide cardholder information from the DS to be presented to the cardholder.<\/td><\/tr>
card<\/td>objectDetails related to the Session source.<\/td><\/tr>
recurring<\/td>objectDetails of a recurring authentication.<\/td><\/tr>
installment<\/td>objectDetails of an installment authentication.<\/td><\/tr>
initial_transaction<\/td>objectDetails of a previous transaction.<\/td><\/tr>
customer_ip<\/td>stringThe card holder’s IP address.<\/td><\/tr>
_linksrequired<\/td>objectThe links related to the session.<\/td><\/tr>
authentication_date<\/td>string <date-time> Authentication date and time<\/td><\/tr>
exemption<\/td>objectDetails related to exemption present in 3DS flow<\/td><\/tr>
flow_type<\/td>stringIndicates whether the 3D Secure 2 authentication was challenged or frictionless<\/td><\/tr>
challenge_indicatorrequired<\/td>stringIndicates the preference for whether or not a 3DS challenge should be performed.<\/td><\/tr>
optimization<\/td>objectThe information about the optimization options selected.<\/td><\/tr>
scheme_info<\/td>objectIndicates scheme-specific information<\/td><\/tr>
3ds<\/td>object3DS experience.<\/td><\/tr>
preferred_experiences<\/td>objectPreferred Experiences<\/td><\/tr>
experience<\/td>stringThe authentication experience that was used for processing<\/td><\/tr>
google_spa<\/td>objectGoogle SPA experience.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
401 Unauthorized<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe type of error.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsError response code(s).<\/td><\/tr>
errors<\/td>objectAdditional error details.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
403 Forbidden<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe type of error.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsError response code(s).<\/td><\/tr>
errors<\/td>objectAdditional error details.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
422 Invalid data was sent<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe type of error.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsError response code(s).<\/td><\/tr>
errors<\/td>objectAdditional error details.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
503 Service not available. A temporary server error.<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe type of error.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsError response code(s).<\/td><\/tr>
errors<\/td>objectAdditional error details.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n

<\/a><\/h2>\n\n\n\n

Get session details<\/h2>\n\n\n\n

Returns the details of the session with the specified identifier string.<\/p>\n\n\n\n

Authorizations<\/summary>\n

bearer<\/em><\/p>\n\n\n\n

<\/h5>\n\n\n\n
HTTP: bearer<\/h5>\n\n\n\n

HTTP Authorization Scheme: <\/strong>bearer<\/code><\/p>\n\n\n\n

Bearer format: <\/strong>JWT<\/code><\/p>\n<\/details>\n\n\n\n

<\/p>\n\n\n\n

path Parameters<\/h5>\n\n\n\n
idrequired<\/td>string = 30 characters ^(sid)_(\\w{26})$Session ID<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
query Parameters<\/h5>\n\n\n\n
channel<\/td>string Enum:”browser””app”Optionally provide the type of channel so you only get the relevant actions<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
header Parameters<\/h5>\n\n\n\n
Authorizationrequired<\/td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Responses<\/h5>\n\n\n\n
200 Session retrieved successfully<\/summary>\n
Cko-Request-Id<\/td>stringThe unique identifier of the request<\/td><\/tr>
Cko-Version<\/td>stringThe version of the API<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Response Schema: application\/json<\/h5>\n\n\n\n
idrequired<\/td>stringSession unique identifier.<\/td><\/tr>
transaction_idrequired<\/td>stringThe transaction identifier that needs to be provided when communicating directly with the Access Control Server (ACS).<\/td><\/tr>
schemerequired<\/td>stringIndicates the scheme this authentication is carried out against.<\/td><\/tr>
amountrequired<\/td>numberThe amount in the minor currency.<\/td><\/tr>
currencyrequired<\/td>stringThe three-letter ISO currency code.<\/td><\/tr>
authentication_typerequired<\/td>stringIndicates the type of payment this session is for.<\/td><\/tr>
authentication_categoryrequired<\/td>stringIndicates the category of the authentication request.<\/td><\/tr>
statusrequired<\/td>stringIndicates the status of the session.<\/td><\/tr>
protocol_versionrequired<\/td>stringThe protocol version number of the specification used by the API for authentication.<\/td><\/tr>
_linksrequired<\/td>objectThe links related to the session.<\/td><\/tr>
challenge_indicatorrequired<\/td>stringIndicates the preference for whether or not a 3DS challenge should be performed.<\/td><\/tr>
session_secretrequired<\/td>stringA base64 encoded value prefixed with sek_ that gives access to client-side operations for a single authentication within the Sessions API.<\/td><\/tr>
completedrequired<\/td>booleanIndicates whether this session has been completed.<\/td><\/tr>
challengedrequired<\/td>booleanIndicates whether this session involved a challenge.<\/td><\/tr>
certificates<\/td>objectPublic certificates specific to a Directory Server (DS) for encrypting device data and verifying ACS signed content. Required when channel is app.<\/td><\/tr>
status_reason<\/td>stringWhen the Session is unavailable this will point to the reason it is so.<\/td><\/tr>
approved<\/td>booleanWhether the authentication was successful. This will only be set if the Session is in a final state.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n

401 Unauthorized<\/p>\n\n\n\n

403 Forbidden. This can happen when the OAuth token scope is sessions:app, but the session was initiated with the scope sessions:browser.<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
404 Session not found<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
502 Bad gateway<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n

<\/a><\/h2>\n\n\n\n

Update a session<\/h2>\n\n\n\n

Update a session by providing information about the environment.<\/p>\n\n\n\n

Authorizations<\/summary>\n

bearer<\/em><\/p>\n\n\n\n

<\/h5>\n\n\n\n
HTTP: bearer<\/h5>\n\n\n\n

HTTP Authorization Scheme: <\/strong>bearer<\/code><\/p>\n\n\n\n

Bearer format: <\/strong>JWT<\/code><\/p>\n\n\n\n

<\/p>\n<\/details>\n\n\n\n

<\/p>\n\n\n\n

path Parameters<\/h5>\n\n\n\n
idrequired<\/td>string = 30 characters ^(sid)_(\\w{26})$Session ID<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
header Parameters<\/h5>\n\n\n\n
Authorizationrequired<\/td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Request Body schema: application\/json<\/h5>\n\n\n\n
channelrequired<\/td>string Default: “browser” Value:”browser”Indicates the type of channel interface being used to initiate the transaction.<\/td><\/tr>
accept_headerrequired<\/td>string <= 2048 characters Exact content of the HTTP accept headers as sent to the 3DS Requestor from the cardholder’s browser<\/td><\/tr>
java_enabledrequired<\/td>booleanBoolean that represents the ability of the cardholder’s browser to execute Java.<\/td><\/tr>
javascript_enabledrequired<\/td>booleanBoolean that represents the ability of the cardholder’s browser to execute Javascript.<\/td><\/tr>
languagerequired<\/td>string [ 1 .. 12 ] characters Value representing the browser language as defined in IETF BCP47.<\/td><\/tr>
color_depthrequired<\/td>string [ 1 .. 2 ] characters Value representing the bit depth of the color palette for displaying images, in bits per pixel.<\/td><\/tr>
screen_heightrequired<\/td>string [ 1 .. 6 ] characters Total height of the cardholder’s screen in pixels.<\/td><\/tr>
screen_widthrequired<\/td>string [ 1 .. 6 ] characters Total width of the cardholder’s screen in pixels.<\/td><\/tr>
timezonerequired<\/td>string [ 1 .. 5 ] characters Time difference between UTC time and the local time of the cardholder’s browser, in minutes.<\/td><\/tr>
user_agentrequired<\/td>string <= 2048 characters Exact content of the HTTP user-agent header<\/td><\/tr>
ip_addressrequired<\/td>string <= 45 characters IP address of the browser as returned by the HTTP headers to the 3DS Requestor<\/td><\/tr>
three_ds_method_completion<\/td>string Default: “U” Enum:”Y””N””U”Indicates whether the 3DS Method successfully completed<\/td><\/tr>
iframe_payment_allowed<\/td>booleanWhether the Payment API is enabled for all parent frames. This is required for Google SPA support in hosted sessions.<\/td><\/tr>
user_agent_client_hint<\/td>stringThe raw Sec-CH-UA header value. This can improve Google SPA support.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Responses<\/h5>\n\n\n\n
200 Session updated successfully<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
idrequired<\/td>stringSession unique identifier.<\/td><\/tr>
transaction_idrequired<\/td>stringThe transaction identifier that needs to be provided when communicating directly with the Access Control Server (ACS).<\/td><\/tr>
schemerequired<\/td>stringIndicates the scheme this authentication is carried out against.<\/td><\/tr>
amountrequired<\/td>numberThe amount in the minor currency.<\/td><\/tr>
currencyrequired<\/td>stringThe three-letter ISO currency code.<\/td><\/tr>
authentication_typerequired<\/td>stringIndicates the type of payment this session is for.<\/td><\/tr>
authentication_categoryrequired<\/td>stringIndicates the category of the authentication request.<\/td><\/tr>
statusrequired<\/td>stringIndicates the status of the session.<\/td><\/tr>
protocol_versionrequired<\/td>stringThe protocol version number of the specification used by the API for authentication.<\/td><\/tr>
_linksrequired<\/td>objectThe links related to the session.<\/td><\/tr>
challenge_indicatorrequired<\/td>stringIndicates the preference for whether or not a 3DS challenge should be performed.<\/td><\/tr>
session_secretrequired<\/td>stringA base64 encoded value prefixed with sek_ that gives access to client-side operations for a single authentication within the Sessions API.<\/td><\/tr>
completedrequired<\/td>booleanIndicates whether this session has been completed.<\/td><\/tr>
challengedrequired<\/td>booleanIndicates whether this session involved a challenge.<\/td><\/tr>
certificates<\/td>objectPublic certificates specific to a Directory Server (DS) for encrypting device data and verifying ACS signed content. Required when channel is app.<\/td><\/tr>
status_reason<\/td>stringWhen the Session is unavailable this will point to the reason it is so.<\/td><\/tr>
approved<\/td>booleanWhether the authentication was successful. This will only be set if the Session is in a final state.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n

401 Unauthorized<\/p>\n\n\n\n

404 Session not found<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
502 Bad gateway<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n

<\/a><\/h2>\n\n\n\n

Complete a session<\/h2>\n\n\n\n

Completes a session by posting the request to the callback URL. This step is optional and only applies to non-hosted sessions.<\/p>\n\n\n\n

Authorizations<\/summary>\n

bearer<\/em><\/p>\n\n\n\n

<\/h5>\n\n\n\n
HTTP: bearer<\/h5>\n\n\n\n

HTTP Authorization Scheme: <\/strong>bearer<\/code><\/p>\n\n\n\n

Bearer format: <\/strong>JWT<\/code><\/p>\n<\/details>\n\n\n\n

path Parameters<\/h5>\n\n\n\n
idrequired<\/td>stringSession ID<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
header Parameters<\/h5>\n\n\n\n
Authorizationrequired<\/td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Request Body schema: application\/json<\/h5>\n\n\n\n
session_idrequired<\/td>stringSession unique identifier.<\/td><\/tr>
amountrequired<\/td>numberThe payment amount in the minor currency unit.<\/td><\/tr>
currencyrequired<\/td>stringThe three-letter ISO currency code.<\/td><\/tr>
statusrequired<\/td>stringThe status of the session.<\/td><\/tr>
authentication_typerequired<\/td>stringThe authentication type.<\/td><\/tr>
authentication_categoryrequired<\/td>stringThe authentication category.<\/td><\/tr>
referencerequired<\/td>stringA reference for the session.<\/td><\/tr>
approvedrequired<\/td>booleanWhether the authentication was approved.<\/td><\/tr>
protocol_versionrequired<\/td>stringThe protocol version.<\/td><\/tr>
response_coderequired<\/td>stringThe response code.<\/td><\/tr>
response_status_reasonrequired<\/td>stringThe response status reason.<\/td><\/tr>
cryptogramrequired<\/td>stringThe cryptogram.<\/td><\/tr>
ecirequired<\/td>stringThe ECI.<\/td><\/tr>
xidrequired<\/td>stringThe XID.<\/td><\/tr>
cardholder_inforequired<\/td>stringCardholder info.<\/td><\/tr>
challengedrequired<\/td>booleanWhether the session was challenged.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Responses<\/h5>\n\n\n\n

204 Session completed successfully
401 Unauthorized<\/p>\n\n\n\n

403 Forbidden<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
404 session not found<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n

<\/a><\/h2>\n\n\n\n

Update session 3DS Method completion indicator<\/h2>\n\n\n\n

Update the session’s 3DS Method completion indicator based on the result of accessing the 3DS Method URL.<\/p>\n\n\n\n

Authorizations<\/summary>\n

bearer<\/em><\/p>\n\n\n\n

<\/h5>\n\n\n\n
HTTP: bearer<\/h5>\n\n\n\n

HTTP Authorization Scheme: <\/strong>bearer<\/code><\/p>\n\n\n\n

Bearer format: <\/strong>JWT<\/code><\/p>\n<\/details>\n\n\n\n

<\/p>\n\n\n\n

path Parameters<\/h5>\n\n\n\n
idrequired<\/td>string = 30 characters ^(sid)_(\\w{26})$Session ID<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
header Parameters<\/h5>\n\n\n\n
Authorizationrequired<\/td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Request Body schema: application\/json<\/h5>\n\n\n\n
three_ds_method_completionrequired<\/td>string = 1 characters Enum:”Y””N””U”The result of the 3DS method URL. Default to U if a response is not received from the 3DS Method URL within 10 seconds.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Responses<\/h5>\n\n\n\n
200 Session updated successfully<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
idrequired<\/td>stringSession unique identifier.<\/td><\/tr>
transaction_idrequired<\/td>stringThe transaction identifier that needs to be provided when communicating directly with the Access Control Server (ACS).<\/td><\/tr>
schemerequired<\/td>stringIndicates the scheme this authentication is carried out against.<\/td><\/tr>
amountrequired<\/td>numberThe amount in the minor currency.<\/td><\/tr>
currencyrequired<\/td>stringThe three-letter ISO currency code.<\/td><\/tr>
authentication_typerequired<\/td>stringIndicates the type of payment this session is for.<\/td><\/tr>
authentication_categoryrequired<\/td>stringIndicates the category of the authentication request.<\/td><\/tr>
statusrequired<\/td>stringIndicates the status of the session.<\/td><\/tr>
protocol_versionrequired<\/td>stringThe protocol version number of the specification used by the API for authentication.<\/td><\/tr>
_linksrequired<\/td>objectThe links related to the session.<\/td><\/tr>
challenge_indicatorrequired<\/td>stringIndicates the preference for whether or not a 3DS challenge should be performed.<\/td><\/tr>
session_secretrequired<\/td>stringA base64 encoded value prefixed with sek_ that gives access to client-side operations for a single authentication within the Sessions API.<\/td><\/tr>
completedrequired<\/td>booleanIndicates whether this session has been completed.<\/td><\/tr>
challengedrequired<\/td>booleanIndicates whether this session involved a challenge.<\/td><\/tr>
certificates<\/td>objectPublic certificates specific to a Directory Server (DS) for encrypting device data and verifying ACS signed content. Required when channel is app.<\/td><\/tr>
status_reason<\/td>stringWhen the Session is unavailable this will point to the reason it is so.<\/td><\/tr>
approved<\/td>booleanWhether the authentication was successful. This will only be set if the Session is in a final state.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n

401 Unauthorized<\/p>\n\n\n\n

403 Forbidden<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
404 Session not found<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>\n\n\n\n
422 Unprocessable channel information<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n
request_idrequired<\/td>stringThe unique request identifier.<\/td><\/tr>
error_typerequired<\/td>stringThe error type.<\/td><\/tr>
error_codesrequired<\/td>Array of stringsThe error codes.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/details>","protected":false},"excerpt":{"rendered":"

Request a session Create a payment session to authenticate a cardholder before requesting a payment. Payment sessions can be linked […]<\/p>","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"doc_category":[122],"doc_tag":[],"year_month":"2026-04","word_count":2700,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"author_nicename":"admin","author_url":"https:\/\/lddpay.com\/zh\/author\/admin\/"},"doc_category_info":[{"term_name":"Temp Solution","term_url":"https:\/\/lddpay.com\/zh\/docs-category\/temp-solution\/"}],"doc_tag_info":[],"author_list":[{"ID":"3","user_login":"jony","display_name":"jony","id":"3"},{"ID":"2","user_login":"Merchantlogin","display_name":"Merchantlogin","id":"2"},{"ID":"1","user_login":"w2863431","display_name":"admin","id":"1"}],"_links":{"self":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs\/866"}],"collection":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/comments?post=866"}],"version-history":[{"count":5,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs\/866\/revisions"}],"predecessor-version":[{"id":875,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/docs\/866\/revisions\/875"}],"wp:attachment":[{"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/media?parent=866"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/doc_category?post=866"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/lddpay.com\/zh\/wp-json\/wp\/v2\/doc_tag?post=866"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}