SIX debiX API
REST API for card issuers on the debiX debit and mobile payment platform - transaction processing, card token lifecycle, push notifications, and bulk operations - with publicly downloadable OpenAPI 3.1 definitions for the bank-to-SIX and cardtoken surfaces and documented production and preprod hosts on api.six-group.com.
SIX debiX API is one of 9 APIs that SIX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Debit Cards, Payments, Card Tokens, and Banking. The published artifact set on APIs.io includes API documentation, an API reference, an OpenAPI specification, and a changelog.
This API exposes 25 operations across 23 paths, and defines 115 schemas. It is described by OpenAPI 3.1.0, at version 2.1.9.
Requests are made against 6 base URLs: https://api.six-group.com/api/debix-auth/provider-auth/v2, https://api-preprod.np.six-group.com/api/debix-auth/provider-auth/v2, https://api.six.ssfn.ch/api/debix-auth/provider-auth/v2, https://api-preprod.np.six.ssfn.ch/api/debix-auth/provider-auth/v2, https://api.p2p.six-group.com/api/debix-auth/provider-auth/v2, https://api-preprod.np.p2p.six-group.com/api/debix-auth/provider-auth/v2.
25 operations
23 paths
115 schemas
1 GET20 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 25
Across 23 paths, the API surfaces 25 operations — 1 GET, 20 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Card Management 25
Allows card lifecycle, PIN management, retrieval of sensitive card data.
POST
/cards
Orders a new card.
PUT
/cards
Modifies the data of a card.
POST
/cards/{cardToken}/reverse-order
Reverses a card order.
POST
/cards/{cardToken}
Returns the card's details.
PUT
/cards/{cardToken}
Modifies the data of a card.
PUT
/cards/{cardToken}/status
Modifies the status of a card.
POST
/cards/{cardToken}/credentials
Gets card credentials.
POST
/cards/{cardToken}/pin
Gets the PIN for the given card.
POST
/cards/{cardToken}/start-set-pin
Starts a PIN set operation.
POST
/cards/start-set-pin
Starts a PIN set operation.
POST
/cards/{cardToken}/set-pin
Sets the PIN for the given card.
POST
/cards/{cardToken}/pin-datamailer
Orders a PIN datamailer for the specified card.
POST
/cards/{cardToken}/reset-pin-try-counter
Resets the PIN try counter for the given card.
POST
/cards/card-token
Returns the card token.
POST
/cards/{cardToken}/card-instance-token
Returns the card instance token.
POST
/cards/card-instance-token
Returns the card instance token.
GET
/cards/{cardToken}/short-card-id
Returns the card identifier.
POST
/cards/reverse-order
Reverses a card order.
PUT
/cards/status
Modifies the status of a card.
POST
/cards/details
Returns the card's details.
POST
/cards/credentials
Gets card credentials.
POST
/cards/pin
Gets the PIN for the specified card.
POST
/cards/set-pin
Sets the PIN for the specified card.
POST
/cards/pin-datamailer
Orders a PIN datamailer for the specified card.
POST
/cards/reset-pin-try-counter
Resets the PIN try counter for the specified card.
Schemas 115
The contract defines 115 schemas that model the data the API accepts and returns. The most detailed are CardOrderData (36 properties), FeatureToggles (16 properties), BccData (16 properties), CardMutationBccData (16 properties). Each schema is shown below with its type and property counts.
VisaC2PCustomerId
string
Unique identifier for the customer.
VisaADAliasId
string
The UUID generated by Alias Directory which identifies the alias.
BankClearingNumber
integer
Unique number used to identify each bank agency or branch in the bank directory.
CardStatusUpdateReason
string
The reason for the status update of the card.
BlockedCardReplacement
string
Indicates the need of a card replacement when the card has been blocked. This is only an indicator and does not trigger the actual card replacement.
BccData
object
Information about the cardholder from the bank card central.
16 properties
7 required
BankCardLine
string
Bank card specific field. The content of this field has to be agreed with the card producer and will not be checked by SIX.
CardDetailsRequest
object
Contains identifiers of the card for which to return the details.
1 property
1 required
EmvProfile
object
Information about the EMV-Profile. Must be set for a physical card order.
2 properties
1 required
DatamailerDeliveryDestination
string
Specifies the delivery destination for OTRC, PIN, and card datamailer.
CardId
object
Complex object representing a card consisting of bank clearing number, card number, card type, card sequence number and card expiry.
5 properties
5 required
ParentCardReference
object
Reference to a card from which settings can be inherited.
8 properties
8 required
CardBlockInformation
object
Contains information about blocked cards.
5 properties
CardMailerText
string
Text which will be printed on the letter onto which the card is attached.
CardInstanceToken
string
Unique card instance token of the card.
MerchantCategoryCode
integer
The merchant category code. In a whitelist, the presence of 0 signifies that all merchant category codes are allowed.
StartSetPinRequest
string
JSON Web Token signed by the issuer to get an ephemeral public key from debiX for the given card. The algorithm of the JWS signature can be one of RS256/384/51…
CardMutationRequest
object
Fields to modify. Fields that are set will be modified. Others will be ignored.
6 properties
1 required
CardPlasticCode
string
Plastic code of the card.
UnstructuredAddress
array
Unstructured address of simple address lines.
UseBankCardWithPin
boolean
Bank card specific field. Indicator of whether the bank card is used with or without PIN.
ShortCardId
object
Complex object representing a card consisting of bank clearing number, card number and card type.
3 properties
3 required
Region
string
Region from where an authorization is requested.
FeatureToggles
object
Contains the values of the feature toggles for the card. In card order requests, the contactlessActivationStatus will be ignored. Will be ignored in card order…
16 properties
14 required
AccountAuthority
object
Indicates who has the right to draw on the account.
3 properties
CardCredentialsRequest
string
JSON Web Token signed by the issuer, containing all parameters for securely retrieving sensitive card credentials. The algorithm of the JWS signature can be on…
RestrictedCountries
array
A list of countries from which authorizations will be declined. Country code values are expected in ISO 3166-1 alpha-2 format. The option to define a restricti…
CardBlockOrigin
string
Initiator and channel of the card blocking.
FamilyName
string
Family name
CardMutationFeatureToggles
object
Feature Toggles to mutate.
15 properties
ContactlessActivationMode
string
Describes the contactless activation mode used during card ordering.
CardTokenRequest
object
Contains the identifier of the card for which to return the card token.
1 property
1 required
ProducerInfo
string
Information for the producer of the card. E.g. to print the EUR-label on the card.
GamblingAndBettingAllowance
string
Defines condition when gambling and betting transactions are allowed.
CardOrderData
object
Card data needed to order the card. Online limits are required if they should not be taken over from the parent card. EMV-Profile must be set for a physical ca…
36 properties
8 required
ChipApplication
string
Indicates what chip will be applied to the card. If no chipApplication is provided, EMVI20 will be applied in the order.
CardId_2
object
Complex object representing a card consisting of bank clearing number, card number, card type, card sequence number and card expiry.
5 properties
5 required
YearMonth
object
2 properties
2 required
CardType
integer
A single digit that distinguishes the card types of the schemes. - 1: Debit mastercard - 3: Visa debit - 6: Bank card
GetPinResponse
string
JSON Web Token signed by debiX containing the encrypted PIN and an ephemeral public key to complete the Diffie-Hellman key exchange. The algorithm of the JWS s…
CardStatus
string
The status of the card.
CardLine
string
This line will be printed on the front side of the card. At least the first card line is required for a physical card order.
TransactionAuthorizer
string
Authorizer for retail and ATM transactions.
CardSeqNumber
integer
Sequence number of the card.
UpdateCardStatusAction
string
Distinguishes the type of the card update.
CardMaterial
string
Distinguishes physical from virtual cards. VIRTUAL not allowed for bank cards.
ResetPinTryCounterRequest_2
object
Contains the identifier of the card for which to request the reset of the PIN try counter.
1 property
1 required
CardMutationCardApplication
object
Controls card application settings for the EMV-Profile, online limits and transaction authorizer.
3 properties
CardInstanceTokenByCardIdRequest
object
Contains the identifier of the card for which to return the card instance token.
1 property
1 required
CardOrderResponse
object
Contains the card token and the card instance token for the newly created card. These tokens can be used immediately to perform subsequent card-related operati…
2 properties
2 required
Language
string
Correspondence language.
OnlineLimits
object
The monthly and daily retail and cash transactions limits.
4 properties
4 required
OtrcDelivery
string
Deprecated and will be ignored. Delivery type of OTRC.
CardOrderReason
string
This setting determines the priority in which a physical card is ordered. Daily business orders are processed with higher priority and sent to the producer aft…
UpdateCardStatusRequest
object
Contains the request to update the status of the card. The card block reason is required when blocking the card. Only when blocking a card, the information in…
6 properties
3 required
FirstName
string
First name
PaymentAuthenticationMethods
object
Container for the available authentication methods.
4 properties
4 required
Salutation
string
Salutation code of a cardholder.
SetPinRequest
string
JSON Web Token signed by the issuer to set the PIN for the given card. The algorithm of the JWS signature can be one of RS256/384/512, PS256/384/512, ES256/384…
DeliveryInformation
object
Delivery address of card, PIN and OTRC.
3 properties
2 required
CardDetailsResponse_2
object
Contains detailed information about the card.
10 properties
4 required
ThreeDsInformation
object
Contains 3DS data provided by Worldline.
2 properties
1 required
ErrorDetail
object
2 properties
1 required
CardDetailsResponse
object
Contains detailed information about the card.
9 properties
3 required
RestrictedRegions
array
A list of regions from which authorizations will be declined.
CardMutationFraudConfiguration
object
Controls the fraud configuration of a card.
2 properties
1 required
PinDatamailerOrderRequest_2
object
Details of the PIN datamailer order request. The referenced card must be a physical card.
5 properties
3 required
AuthenticationMethodStatus
string
Status of an authentication method.
ProducerCode
string
Defines the producer of the ordered card. Must only be set for a physical card order.
BankApiError
object
Information about an error on API requests.
5 properties
2 required
ResetPinTryCounterRequest
object
Contains the cardTokenExtension used together with the cardToken path parameter for card identification.
1 property
1 required
GetPinRequest
string
JSON Web Token signed by the issuer, containing all parameters for securely retrieving the PIN. The algorithm of the JWS signature can be one of RS256/384/512,…
CardInstanceTokenRequest
object
Contains the identifier of the card for which to return the card instance token.
1 property
1 required
StartSetPinResponse
string
JSON Web Token signed by debiX containing an ephemeral public key to complete the Diffie-Hellman key exchange, used to encrypt the new PIN to be set for this c…
MoneySendReceiveAllowance
string
Defines conditions if money send to and receive from another cardholder is allowed.
CommonCardInformation
object
Common information about the card.
14 properties
5 required
CardOrderRequest
object
Configuration specifying the new card to be ordered.
5 properties
1 required
PhoneNumber
string
Mobile or landline phone number. Note: phoneNumber is a mandatory parameter which must be provided to register a card with authentication method SMSONLY, PIN,…
CardMutationBccData
object
Information about the cardholder to mutate.
16 properties
7 required
PinDatamailerOrderRequest
object
Details of the PIN datamailer order request. The referenced card must be a physical card.
5 properties
3 required
CardMutationRequest_2
object
Fields to modify. Fields that are set will be modified. Others will be ignored.
6 properties
1 required
AccountNumber
string
Unique number identifying a bank account.
ShortCardIdResponse
object
Contains the identifier of the card that corresponds to the given card token.
1 property
1 required
CardBlockOriginViaBank
string
Initiator and channel of the card blocking when the card is blocked via the bank.
CardTokenExtension
object
Extension to card token to identify a card.
2 properties
2 required
CardInstanceTokenResponse
object
Contains the card instance token of the card.
1 property
1 required
BranchNumber
integer
Branch number of the site where the account was initially created.
CardSequenceNumber
integer
Sequence number of the card.
MailerTextCode
integer
Reference to a predefined text container that will be printed on the datamailer.
RiskShieldList
string
- "EXCLUSIONLIST": General whitelist, i.e. all rules that lead to RiskShield declines and automatic blockings are overridden. - "GREYLISTCNP": The non-secure c…
CardOrderPinData
string
JSON Web Token signed by the issuer to set the PIN for the ordered card. The algorithm of the JWS signature can be one of RS256/384/512, PS256/384/512, ES256/3…
UpdateCardStatusRequest_2
object
Contains the request to update the status of the card. The card block reason is required when blocking the card. Only when blocking a card, the information in…
6 properties
3 required
CardBlockReason
string
The reason why the card was blocked.
CardBlockInterface
string
The interface used for blocking the card.
CardOrderReversalRequest
object
1 property
1 required
CardOrderReversalRequest_2
object
1 property
1 required
CardMutationContactlessActivationStatus
boolean
Controls whether contactless is enabled.
DatamailerExpressCode
string
Defines the express code of OTRC and PIN datamailer delivery.
CardDetailsRequest_2
object
Contains the identifier of the card for which to return the details.
1 property
1 required
CardNumber
integer
Card number of the card.
Birthdate
string
Date of birth.
FraudConfiguration
object
The fraud configuration, containing restrictions for countries and regions. Authorizations from a country will be declined if the country itself, or the region…
3 properties
SubCardType
string
Sub card type that is linked to a dedicated BIN range and specifies a product like 'Platinum', 'EUR' or 'Student'. It must be configured in bank master data, o…
VisaADAliasId_2
string
The UUID generated by Alias Directory which identifies the alias
CardholderDataTrack
string
A formatted combination of family name, name and title. Must only be set for a Mastercard physical card order. Valid formats include: - FAMILYNAME/ - FAMILYNAM…
CardToken
string
Unique card token of a card.
Currency
string
The currency according to ISO 4217.
ContactlessActivationStatus
string
Describes the contactless activation status of the card.
CardExpressCode
string
Defines the express code of the card delivery. Must be set for a physical card order and CardDelivery is DELIVERTOCARDHOLDER.
Country
string
Country code in format ISO 3166-1 alpha 2.
CardTokenResponse
object
Contains the card token of the card.
1 property
1 required
StartSetPinByCardIdRequest
string
JSON Web Token signed by the issuer to get an ephemeral public key from debiX for the given cardId. The algorithm of the JWS signature can be one of RS256/384/…
CardCredentialsResponse
string
JSON Web Token containing the encrypted card credentials and an ephemeral public key to complete the Diffie-Hellman key exchange. The algorithm of the JWS sign…
Iban
string
IBAN of the bank account for which the card was issued.
PinRecoveryStatus
string
The status of the PIN recovery.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from SIX 8
Other APIs SIX publishes across the network.
SIX Web API
SIX Bulk API
SIX bLink API
SIX debiX Auth Provider API
Swiss Bank Master API
SIC Service Status API
SIC Clearing Day Calendar API
Settlement Info Reporting API
#Debit Cards#Payments#Card Tokens#Banking
Where this information came from
This is an independent, third-party profile of SIX debiX API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.