Skip to main content
API docs by Redocly

debiX Auth Provider API: Provider-to-SIX (2.1.0)

Download OpenAPI specification:Download

Callback API used by the Authentication Provider and implemented by SIX / debiX

Health check

Health check using GET method.

Returns a status message of the system.

header Parameters
x-request-id
string

A unique identifier for a request and response pair.

Responses

Response samples

Content type
application/json
{
  • "message": "The healthcheck GET request was successfully received and processed.",
  • "requestDateTime": "2021-10-03T16:03:09.101+02:00",
  • "receivedHeaders": [
    • {
      }
    ],
  • "apiVersion": "1.0.0"
}

Health check using POST method.

Returns the request body. This operation will not modify the system.

header Parameters
x-request-id
string

A unique identifier for a request and response pair.

Request Body schema: application/json
required

Any message which is expected in the response.

message
required
string [ 1 .. 100 ] characters

Expected response message from the health check.

Responses

Request samples

Content type
application/json
{
  • "message": "Any string"
}

Response samples

Content type
application/json
{
  • "message": "The healthcheck GET request was successfully received and processed.",
  • "requestDateTime": "2021-10-03T16:03:09.101+02:00",
  • "receivedHeaders": [
    • {
      }
    ],
  • "apiVersion": "1.0.0"
}

Authentication callback

Processes the result of the authentication request.

The operation processes the result of the authentication request and notifies the ACS.

header Parameters
x-correlation-id
string

A unique identifier for an authentication request and authentication callback

Request Body schema: application/json
required
threeDsTransactionId
required
string

The 3DS transaction id.

confirmationStatus
required
string
Enum: "ACCEPTED" "DECLINED" "FAILED" "CANCELLED"

Status of the authentication request. It may be either ACCEPTED or DECLINED by the cardholder. If a technical error occurs preventing the successful display of the Push Notification on the device, then FAILED must be used. If the authentication provider sets a time window for the cardholder to accept or decline the authentication request and the cardholder fails to respond, then CANCELLED must be used as the confirmationStatus.

oobAuthenticationMethod
string
Enum: "BIOMETRICS" "OTHER"

This indicates the type of second factor used for authentication. This property is mandatory if the confirmationStatus is ACCEPTED, but not required if the confirmationStatus is FAILED, DECLINED or CANCELLED.

Responses

Request samples

Content type
application/json
{
  • "threeDsTransactionId": "a5b86c4e-0caa-11e8-ba89-0ed5f89f718b",
  • "confirmationStatus": "ACCEPTED",
  • "oobAuthenticationMethod": "BIOMETRICS"
}

Response samples

Content type
application/json
{
  • "applicationError": "OPERATION_FAILED",
  • "errorCode": 5001,
  • "description": "The requested operation failed.",
  • "errors": [
    • {
      }
    ],
  • "errorToken": "618503aa-7beb-4d3d-986e-36f1fdbd0e13"
}