Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/six-group-3-ds-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Six Group 3 DS API
version: 2.36.0
description: 'Operations tagged 3DS across 2 of this provider''s published API definitions: six-group-debix-bank-api-cardtoken-v2-bank-to-six-openapi.yml, six-group-debix-bank-api-v2-bank-to-six-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.six-group.com/api/debix/bank/cardtoken/v2
description: PROD - Internet
- url: https://api-preprod.np.six-group.com/api/debix/bank/cardtoken/v2
description: TEST - Internet
- url: https://api.six.ssfn.ch/api/debix/bank/cardtoken/v2
description: PROD - SSFN
- url: https://api-preprod.np.six.ssfn.ch/api/debix/bank/cardtoken/v2
description: TEST - SSFN
- url: https://api.p2p.six-group.com/api/debix/bank/cardtoken/v2
description: PROD - P2P
- url: https://api-preprod.np.p2p.six-group.com/api/debix/bank/cardtoken/v2
description: TEST - P2P
- url: https://api.six-group.com/api/debix/bank/v2
description: PROD - Internet
- url: https://api-preprod.np.six-group.com/api/debix/bank/v2
description: TEST - Internet
- url: https://api.six.ssfn.ch/api/debix/bank/v2
description: PROD - SSFN
- url: https://api-preprod.np.six.ssfn.ch/api/debix/bank/v2
description: TEST - SSFN
- url: https://api.p2p.six-group.com/api/debix/bank/v2
description: PROD - P2P
- url: https://api-preprod.np.p2p.six-group.com/api/debix/bank/v2
description: TEST - P2P
security: []
tags:
- name: 3 DS
description: 3DS lifecycle, 3DS details, OTRC order.
paths:
/cards/{cardToken}/3ds:
post:
tags:
- 3 DS
summary: Registers the card for 3DS
description: 'If a card with the provided card data is not yet registered for 3DS, the registration will take place.
In addition to standard application error codes, the following codes can be returned:
* 4430 - UNKNOWN_CARD
* 4434 - THREE_DS_NOT_ENABLED_FOR_ISSUER
* 4435 - CARD_ALREADY_REGISTERED_FOR_THREE_DS
* 4436 - CARD_INACTIVE
* 4453 - THREE_DS_OOB_NOT_ENABLED_FOR_ISSUER
* 4467 - THREE_DS_PASSWORD_NOT_ALLOWED
* 4483 - OPERATION_NOT_ALLOWED_FOR_BANK_CARD'
operationId: threeDsRegister
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IssuerTraceIdHeader'
- in: path
name: cardToken
description: Card token
required: true
schema:
$ref: '#/components/schemas/CardToken'
requestBody:
description: Card identifier and 3DS-related data.
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDsRegisterRequest'
required: true
responses:
'204':
description: The card was successfully registered for 3DS.
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
'404':
description: Not found or card is deleted
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
put:
tags:
- 3 DS
summary: Updates the 3DS data
description: 'If the request contains new information, the 3DS data will be updated for the given card.
In addition to standard application error codes, the following codes can be returned:
* 4430 - UNKNOWN_CARD
* 4434 - THREE_DS_NOT_ENABLED_FOR_ISSUER
* 4453 - THREE_DS_OOB_NOT_ENABLED_FOR_ISSUER
* 4483 - OPERATION_NOT_ALLOWED_FOR_BANK_CARD'
operationId: threeDsUpdate
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IssuerTraceIdHeader'
- in: path
name: cardToken
description: Card token
required: true
schema:
$ref: '#/components/schemas/CardToken'
requestBody:
description: Contains 3DS-related data.
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDsUpdateRequest'
required: true
responses:
'204':
description: The request was successfully processed.
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
'404':
description: Not found or card is deleted
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
delete:
tags:
- 3 DS
summary: Deregisters the given card from 3DS and deletes the corresponding data
description: 'If a card with the provided identifier is known to debiX, it will be deregistered from 3DS and the corresponding data deleted.
In addition to standard application error codes, the following codes can be returned:
* 4430 - UNKNOWN_CARD
* 4483 - OPERATION_NOT_ALLOWED_FOR_BANK_CARD'
operationId: threeDsDelete
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IssuerTraceIdHeader'
- in: path
name: cardToken
description: Card token
required: true
schema:
$ref: '#/components/schemas/CardToken'
responses:
'204':
description: The request was successfully processed.
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
'404':
description: Not found or card is deleted
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
servers:
- url: https://api.six-group.com/api/debix/bank/cardtoken/v2
description: PROD - Internet
- url: https://api-preprod.np.six-group.com/api/debix/bank/cardtoken/v2
description: TEST - Internet
- url: https://api.six.ssfn.ch/api/debix/bank/cardtoken/v2
description: PROD - SSFN
- url: https://api-preprod.np.six.ssfn.ch/api/debix/bank/cardtoken/v2
description: TEST - SSFN
- url: https://api.p2p.six-group.com/api/debix/bank/cardtoken/v2
description: PROD - P2P
- url: https://api-preprod.np.p2p.six-group.com/api/debix/bank/cardtoken/v2
description: TEST - P2P
/cards/{cardToken}/3ds/details:
post:
tags:
- 3 DS
summary: Returns the 3DS details for the given card
description: 'Returns the details for the current 3DS registration.
In addition to standard application error codes, the following codes can be returned:
* 4430 - UNKNOWN_CARD
* 4432 - BANK_CLEARING_NUMBER_NOT_CONFIGURED
* 4436 - CARD_INACTIVE
* 4457 - CARD_NOT_REGISTERED_FOR_THREE_DS
* 4483 - OPERATION_NOT_ALLOWED_FOR_BANK_CARD'
operationId: threeDsDetails
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IssuerTraceIdHeader'
- in: path
name: cardToken
description: Card token
required: true
schema:
$ref: '#/components/schemas/CardToken'
requestBody:
description: Identifier of the card for which to return the 3DS details.
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDsDetailsRequest'
responses:
'200':
description: The 3DS details were successfully fetched.
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDsDetailsResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
'404':
description: Not found or card is deleted
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
servers:
- url: https://api.six-group.com/api/debix/bank/cardtoken/v2
description: PROD - Internet
- url: https://api-preprod.np.six-group.com/api/debix/bank/cardtoken/v2
description: TEST - Internet
- url: https://api.six.ssfn.ch/api/debix/bank/cardtoken/v2
description: PROD - SSFN
- url: https://api-preprod.np.six.ssfn.ch/api/debix/bank/cardtoken/v2
description: TEST - SSFN
- url: https://api.p2p.six-group.com/api/debix/bank/cardtoken/v2
description: PROD - P2P
- url: https://api-preprod.np.p2p.six-group.com/api/debix/bank/cardtoken/v2
description: TEST - P2P
/cards/{cardToken}/otrc:
get:
tags:
- 3 DS
summary: Orders an online One-Time-Registration-Code (OTRC)
description: 'Get an online One-Time-Registration-Code (OTRC) for the given card.
In addition to standard application error codes, the following codes can be returned:
* 4430 - UNKNOWN_CARD
* 4483 - OPERATION_NOT_ALLOWED_FOR_BANK_CARD'
operationId: otrcOrder
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IssuerTraceIdHeader'
- in: path
name: cardToken
description: Card token
required: true
schema:
$ref: '#/components/schemas/CardToken'
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/OtrcOrderResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
servers:
- url: https://api.six-group.com/api/debix/bank/cardtoken/v2
description: PROD - Internet
- url: https://api-preprod.np.six-group.com/api/debix/bank/cardtoken/v2
description: TEST - Internet
- url: https://api.six.ssfn.ch/api/debix/bank/cardtoken/v2
description: PROD - SSFN
- url: https://api-preprod.np.six.ssfn.ch/api/debix/bank/cardtoken/v2
description: TEST - SSFN
- url: https://api.p2p.six-group.com/api/debix/bank/cardtoken/v2
description: PROD - P2P
- url: https://api-preprod.np.p2p.six-group.com/api/debix/bank/cardtoken/v2
description: TEST - P2P
/cards/{cardToken}/otrc-datamailer:
post:
tags:
- 3 DS
summary: Orders an One-Time-Registration-Code (OTRC) via datamailer
description: 'Get a datamailer with the One-Time-Registration-Code (OTRC) for the specified card.
In addition to standard application error codes, the following codes can be returned:
* 4430 - UNKNOWN_CARD
* 4483 - OPERATION_NOT_ALLOWED_FOR_BANK_CARD'
operationId: otrcOrderDatamailer
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IssuerTraceIdHeader'
- in: path
name: cardToken
description: Card token
required: true
schema:
$ref: '#/components/schemas/CardToken'
requestBody:
description: Details of the OTRC datamailer.
content:
application/json:
schema:
$ref: '#/components/schemas/OtrcDatamailerOrderRequest'
responses:
'202':
description: Accepted
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
servers:
- url: https://api.six-group.com/api/debix/bank/cardtoken/v2
description: PROD - Internet
- url: https://api-preprod.np.six-group.com/api/debix/bank/cardtoken/v2
description: TEST - Internet
- url: https://api.six.ssfn.ch/api/debix/bank/cardtoken/v2
description: PROD - SSFN
- url: https://api-preprod.np.six.ssfn.ch/api/debix/bank/cardtoken/v2
description: TEST - SSFN
- url: https://api.p2p.six-group.com/api/debix/bank/cardtoken/v2
description: PROD - P2P
- url: https://api-preprod.np.p2p.six-group.com/api/debix/bank/cardtoken/v2
description: TEST - P2P
/cards/3ds:
post:
tags:
- 3 DS
summary: Registers the card for 3DS
description: 'Deprecated, use `POST /debix/bank/cardtoken/v2/cards/{cardToken}/3ds` instead.
If a card with the provided card data is not yet registered for 3DS, the registration will take place.
In addition to standard application error codes, the following codes can be returned:
* 4430 - UNKNOWN_CARD
* 4434 - THREE_DS_NOT_ENABLED_FOR_ISSUER
* 4435 - CARD_ALREADY_REGISTERED_FOR_THREE_DS
* 4436 - CARD_INACTIVE
* 4453 - THREE_DS_OOB_NOT_ENABLED_FOR_ISSUER
* 4467 - THREE_DS_PASSWORD_NOT_ALLOWED
* 4483 - OPERATION_NOT_ALLOWED_FOR_BANK_CARD'
operationId: threeDsRegister
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IssuerTraceIdHeader'
requestBody:
description: Card and 3DS-related data.
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDsRegisterRequest_2'
required: true
responses:
'204':
description: The card was successfully registered for 3DS.
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
'404':
description: Not found or card is deleted
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
put:
tags:
- 3 DS
summary: Updates the 3DS data
description: 'Deprecated, use `PUT /debix/bank/cardtoken/v2/cards/{cardToken}/3ds` instead.
If the request contains new information, the 3DS data will be updated for the given card.
In addition to standard application error codes, the following codes can be returned:
* 4430 - UNKNOWN_CARD
* 4434 - THREE_DS_NOT_ENABLED_FOR_ISSUER
* 4453 - THREE_DS_OOB_NOT_ENABLED_FOR_ISSUER
* 4483 - OPERATION_NOT_ALLOWED_FOR_BANK_CARD'
operationId: threeDsUpdate
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IssuerTraceIdHeader'
requestBody:
description: Card and 3DS-related data.
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDsUpdateRequest_2'
required: true
responses:
'204':
description: The request was successfully processed.
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
'404':
description: Not found or card is deleted
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
servers:
- url: https://api.six-group.com/api/debix/bank/v2
description: PROD - Internet
- url: https://api-preprod.np.six-group.com/api/debix/bank/v2
description: TEST - Internet
- url: https://api.six.ssfn.ch/api/debix/bank/v2
description: PROD - SSFN
- url: https://api-preprod.np.six.ssfn.ch/api/debix/bank/v2
description: TEST - SSFN
- url: https://api.p2p.six-group.com/api/debix/bank/v2
description: PROD - P2P
- url: https://api-preprod.np.p2p.six-group.com/api/debix/bank/v2
description: TEST - P2P
/cards/3ds/delete:
post:
tags:
- 3 DS
summary: Deregisters a card from 3DS and deletes the corresponding data
description: 'Deprecated, use `DELETE /debix/bank/cardtoken/v2/cards/{cardToken}/3ds` instead.
If a card with the provided identifier is known to debiX, it will be deregistered from 3DS and the corresponding data deleted.
In addition to standard application error codes, the following codes can be returned:
* 4430 - UNKNOWN_CARD
* 4483 - OPERATION_NOT_ALLOWED_FOR_BANK_CARD'
operationId: threeDsDelete
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IssuerTraceIdHeader'
requestBody:
description: Identifier of the card to be deregistered from 3DS.
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDsDeleteRequest'
required: true
responses:
'204':
description: The request was successfully processed.
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
'404':
description: Not found or card is deleted
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
servers:
- url: https://api.six-group.com/api/debix/bank/v2
description: PROD - Internet
- url: https://api-preprod.np.six-group.com/api/debix/bank/v2
description: TEST - Internet
- url: https://api.six.ssfn.ch/api/debix/bank/v2
description: PROD - SSFN
- url: https://api-preprod.np.six.ssfn.ch/api/debix/bank/v2
description: TEST - SSFN
- url: https://api.p2p.six-group.com/api/debix/bank/v2
description: PROD - P2P
- url: https://api-preprod.np.p2p.six-group.com/api/debix/bank/v2
description: TEST - P2P
/cards/3ds/details:
post:
tags:
- 3 DS
summary: Returns the 3DS details for this card
description: 'Deprecated, use `POST /debix/bank/cardtoken/v2/cards/{cardToken}/3ds/details` instead.
Returns the details for the current 3DS registration.
In addition to standard application error codes, the following codes can be returned:
* 4430 - UNKNOWN_CARD
* 4432 - BANK_CLEARING_NUMBER_NOT_CONFIGURED
* 4436 - CARD_INACTIVE
* 4457 - CARD_NOT_REGISTERED_FOR_THREE_DS
* 4483 - OPERATION_NOT_ALLOWED_FOR_BANK_CARD'
operationId: threeDsDetails
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IssuerTraceIdHeader'
requestBody:
description: Identifier of the card for which to return the 3DS details.
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDsDetailsRequest_2'
responses:
'200':
description: The 3DS details were successfully fetched.
content:
application/json:
schema:
$ref: '#/components/schemas/ThreeDsDetailsResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
'404':
description: Not found or card is deleted
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
servers:
- url: https://api.six-group.com/api/debix/bank/v2
description: PROD - Internet
- url: https://api-preprod.np.six-group.com/api/debix/bank/v2
description: TEST - Internet
- url: https://api.six.ssfn.ch/api/debix/bank/v2
description: PROD - SSFN
- url: https://api-preprod.np.six.ssfn.ch/api/debix/bank/v2
description: TEST - SSFN
- url: https://api.p2p.six-group.com/api/debix/bank/v2
description: PROD - P2P
- url: https://api-preprod.np.p2p.six-group.com/api/debix/bank/v2
description: TEST - P2P
/cards/otrc:
post:
tags:
- 3 DS
summary: Orders an online One-Time-Registration-Code (OTRC)
description: 'Deprecated, use `GET /debix/bank/cardtoken/v2/cards/{cardToken}/otrc` instead.
Get an online One-Time-Registration-Code (OTRC) for the specified card.
In addition to standard application error codes, the following codes can be returned:
* 4430 - UNKNOWN_CARD
* 4483 - OPERATION_NOT_ALLOWED_FOR_BANK_CARD'
operationId: otrcOrder
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IssuerTraceIdHeader'
requestBody:
description: Identifier of the card for which the OTRC will be ordered.
content:
application/json:
schema:
$ref: '#/components/schemas/OtrcOrderRequest'
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/OtrcOrderResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
servers:
- url: https://api.six-group.com/api/debix/bank/v2
description: PROD - Internet
- url: https://api-preprod.np.six-group.com/api/debix/bank/v2
description: TEST - Internet
- url: https://api.six.ssfn.ch/api/debix/bank/v2
description: PROD - SSFN
- url: https://api-preprod.np.six.ssfn.ch/api/debix/bank/v2
description: TEST - SSFN
- url: https://api.p2p.six-group.com/api/debix/bank/v2
description: PROD - P2P
- url: https://api-preprod.np.p2p.six-group.com/api/debix/bank/v2
description: TEST - P2P
/cards/otrc-datamailer:
post:
tags:
- 3 DS
summary: Orders an One-Time-Registration-Code (OTRC) via datamailer
description: 'Deprecated, use `GET /debix/bank/cardtoken/v2/cards/{cardToken}/otrc-datamailer` instead.
Get a datamailer with the One-Time-Registration-Code (OTRC) for the specified card.
In addition to standard application error codes, the following codes can be returned:
* 4430 - UNKNOWN_CARD
* 4483 - OPERATION_NOT_ALLOWED_FOR_BANK_CARD'
operationId: otrcOrderDatamailer
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IssuerTraceIdHeader'
requestBody:
description: Details of the OTRC datamailer.
content:
application/json:
schema:
$ref: '#/components/schemas/OtrcDatamailerOrderRequest_2'
responses:
'202':
description: Accepted
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/BankApiError'
servers:
- url: https://api.six-group.com/api/debix/bank/v2
description: PROD - Internet
- url: https://api-preprod.np.six-group.com/api/debix/bank/v2
description: TEST - Internet
- url: https://api.six.ssfn.ch/api/debix/bank/v2
description: PROD - SSFN
- url: https://api-preprod.np.six.ssfn.ch/api/debix/bank/v2
description: TEST - SSFN
- url: https://api.p2p.six-group.com/api/debix/bank/v2
description: PROD - P2P
- url: https://api-preprod.np.p2p.six-group.com/api/debix/bank/v2
description: TEST - P2P
components:
schemas:
Password:
description: This parameter must be used exclusively by issuers with special regulations (e.g., PSD2). It must be provided if the issuer intends to register a card for 3DS with SMS as secondary authentication method (i.e. SMS as fallback) or if the issuer intends to register a card with SMS_ONLY as primary and unique authentication method. In these cases, the phoneNumber field must also be provided.
type: string
minLength: 1
examples:
- password
BiometricType:
description: Type of biometric authentication; required for authentication method BIOMETRIC and BIOMETRIC_WITH_PIN_FALLBACK.
type: string
enum:
- ANDROID_BIOMETRIC
- IOS_BIOMETRIC
PartialThreeDsData:
description: Partial data pertaining to a 3DS registration.
type: object
properties:
userId:
description: 'Identifier assigned to a particular user by the issuer. Note: userId is a mandatory parameter when registering a card with authentication method PIN, BIOMETRIC or BIOMETRIC_WITH_PIN_FALLBACK.'
type: string
minLength: 1
examples:
- '2345872'
phoneNumber:
$ref: '#/components/schemas/PhoneNumber'
language:
$ref: '#/components/schemas/Language'
authId:
$ref: '#/components/schemas/AuthId'
authenticationMethod:
$ref: '#/components/schemas/AuthenticationMethod'
biometricType:
$ref: '#/components/schemas/BiometricType'
pinCode:
$ref: '#/components/schemas/PinCode'
password:
$ref: '#/components/schemas/Password'
ThreeDsAuthenticationMethod:
description: User authentication method for either 3DS via debiX Api, via debiX+ App or via SMS.
type: string
enum:
- PIN
- BIOMETRIC
- BIOMETRIC_WITH_PIN_FALLBACK
- BIOMETRIC_AND_PIN
- DELEGATED
- SMS_ONLY
- NONE
ErrorDetail:
type: object
required:
- errorCode
properties:
errorCode:
description: Code describing the error.
type: integer
format: int32
examples:
- 42
description:
description: The message describing the error.
type: string
examples:
- The answer to the great question of Life, the Universe and Everything.
BankApiError:
description: Information about an error on API requests.
type: object
required:
- applicationError
- errorCode
properties:
applicationError:
description: The name of the application error.
type: string
examples:
- OPERATION_FAILED
errorCode:
description: Code describing the error.
type: integer
format: int32
examples:
- 5001
description:
description: A human readable explanation specific to this occurrence of the problem.
type: string
examples:
- The requested operation failed.
errors:
description: List of error details.
type: array
minItems: 1
items:
$ref: '#/components/schemas/ErrorDetail'
errorToken:
description: A generated error token referencing the actual error and logged on the server.
type: string
examples:
- 618503aa-7beb-4d3d-986e-36f1fdbd0e13
AuthenticationMethod:
description: User authentication method. For 3DS Out-of-Band (OOB), authentication method DELEGATED must be selected.
type: string
enum:
- PIN
- BIOMETRIC
- BIOMETRIC_WITH_PIN_FALLBACK
- DELEGATED
- SMS_ONLY
- NONE
Country:
description: Country code in format ISO 3166-1 alpha 2.
type: string
pattern: '[A-Z]{2}'
examples:
- CH
CardToken:
description: Unique card token of a card.
type: string
pattern: ^CTK-[0-9a-fA-F]{32}$
minLength: 36
maxLength: 36
examples:
- CTK-54716A6080B14CF19CEA3C170F85B1DD
DatamailerExpressCode:
description: Defines the express code of OTRC and PIN datamailer delivery.
type: string
enum:
- A_POST
- B_POST
- REGISTERED
default: A_POST
DeliveryInformation:
description: Delivery address of card, PIN and OTRC.
type: object
required:
- address
- country
properties:
address:
$ref: '#/components/schemas/UnstructuredAddress'
country:
$ref: '#/components/schemas/Country'
salutationText:
description: Salutation text for the delivery.
type: string
maxLength: 50
PhoneNumber:
description: 'Mobile or landline phone number. Note: phoneNumber is a mandatory parameter which must be provided to register a card with authentication method SMS_ONLY, PIN, BIOMETRIC or BIOMETRIC_WITH_PIN_FALLBACK. Furthermore, phoneNumber must also be provided in case the issuer desires to register a card for DELEGATED as primary authentication method, with additionally SMS as fallback (as secondary authentication method). For issuers with special regulations (e.g. PSD2), please refer to the additional indications provided under the “password” field.'
type: string
pattern: ^([+]|00)[1-9][0-9]{8,18}$
examples:
- '+41797778899'
OtrcOrderResponse:
description: Contains the OTRC information.
type: object
required:
- otrc
- otrcExpirationDateTime
properties:
otrc:
description: Value of the OTRC.
type: integer
otrcExpirationDateTime:
description: Date and time when the OTRC will expire.
type: string
format: date-time
examples:
- '2024-10-03T16:03:09.101+02:00'
ThreeDsRegisterRequest:
description: Contains the card identifiers and 3DS-related data for the registration of a card.
type: object
required:
- cardTokenExtension
- threeDsData
properties:
cardTokenExtension:
$ref: '#/components/schemas/CardTokenExtension'
threeDsData:
$ref: '#/components/schemas/ThreeDsData'
Language:
description: Correspondence language.
type: string
enum:
- DE
- FR
- IT
- EN
ThreeDsData:
description: Relevant data to register a card for 3DS with a specific authentication method based on the setup desired by the issuer (i.e. for 3DS via SIX SDK or 3DS OOB).
type: object
required:
- language
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/six-group/refs/heads/main/openapi/six-group-3-ds-api-openapi.yml