Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

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

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": "2.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": "2.0.0"
}

3DS Authentication

Initiates the authentication of a 3DS transaction

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.

authId
required
string [ 1 .. 36 ] characters

Identifier for the device used for 3DS

required
object (TransactionDetail)
maskedCardNumber
required
string

The masked primary account number.

purchaseDate
string <date-time>

Date and time of the transaction.

merchantName
required
string

The name of the merchant.

purchaseAmount
string

The transaction amount.

purchaseAmountExponent
number [ 0 .. 9 ]

The transaction amount exponent.

purchaseCurrency
string

The ISO-4217 three-letter alphabetic currency code.

threeDSRequestorAppURL
string

threeDSRequestorAppURL as defined in the 3DS 2.2 specification. Used to link back to the merchant app from an OOB app.

Responses

Request samples

Content type
application/json
{
  • "threeDsTransactionId": "a5b86c4e-0caa-11e8-ba89-0ed5f89f718b",
  • "authId": "ea3ze38kfj3g6ktv6wn14aaylvmdv3qn",
  • "transactionDetail": {
    • "maskedCardNumber": "**** **** **** 1234",
    • "purchaseDate": "2017-07-21T17:32:28Z",
    • "merchantName": "ACME Corporation",
    • "purchaseAmount": 120012,
    • "purchaseAmountExponent": 2,
    • "purchaseCurrency": "CHF"
    },
  • "threeDSRequestorAppURL": "https://requestor.url.com?id=24dfc3e8-0dfa-45d7-95c1-4d213a8da9d9"
}

Response samples

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

Cancels the authentication of a 3DS transaction

path Parameters
threeDsTransactionId
required
string
Example: a5b86c4e-0caa-11e8-ba89-0ed5f89f718b

The 3DS transaction id.

header Parameters
x-correlation-id
string

A unique identifier for an authentication request and authentication callback

Responses

Response samples

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