V1

Resources

Access to bank cards can be obtained through :

Greyed label : /api/cards/ to obtain access to cards of the connected user

or

White label : /api/users/user-identifier/cards to obtain access to cards of the user belonging to the connected third-party application.

/api/cards/ to obtain access to cards registered in the domain of the connected third-party application.

1.1 Cardregistration

Contains information about a bank card

Property Type Example Description
Card Card Card details
Status Int 1 Status of the card registration
0 = Waiting
1 = Completed
2 = Failed
UrlReturn String Url of callback client requested at the end of a card registration
urlCallback String https://domainedeclare/ajoutcarte Specify url of callback server requested at the end of adding card (the domain must be the same as the one of the callback URL provided initially)
AvailableCards String "CB ; VISA" List of cards to be displayed on the registration page.
Possible values ( to separate with ’ ;’ ) :
CB
MASTERCARD
MAESTRO
VISA
VISA_ELECTRON
ErrorCode Int 0 Code d’erreur pour les enregistrements carte échoués, 0 si aucune erreur.
1 = The merchant should contact
the bank of the holder
2 = Payment refused
3 = Payment cancelled by the client
4 = Holder not 3D-Secure enrolled
5 = 3D-Secure authentication error
6 = Systempay technical error
ExtraResults ExtraResults Contains detailed return codes

1.2 Card

Property Type Example Description
Id Long 1 Card ID
AppCardId String "card123" Card identifier in the third-party application
Name String "Carte bancaire" Card name
Hint String "597010XXXXXX0009" Hide the card number
Country String "FR" ISO country code of the card
Extraparameters Extraparameters List of parameters allowing to apply a predefined profile to a transaction

1.3 ExtraResults

Property Type Description
BankAuthResult Int Return code for the authorisation request returned by the issuing bank , if available.
0 = Approved or successfully completed transactions
2 = contact the card issuer
3 = invalid recipient
4 = retain the card
5 = do not honour
7 = retain the card, special conditions
8 = approve after identification
12 = invalid transaction
13 = invalid amount
14 = invalid holder number
15 = card issuer unknown
17 = Annulation client
19 = Repeat the transaction later
20 = Wrong response (error in the domain server)
24 = File update not supported
25 = Localizing the registration in the file not possible
26 = Registration duplicated, old registration replaced
27 = Error on the « edit » field of the file update
28 = Access to file not allowed
29 = Update impossible
30 = format error
31 = Acquiring body identifier not known
33 = card expiry date has passed
34 = suspicion of fraud
38 = Card expiry date has passed
41 = card lost
43 = card stolen
51 = insufficient funds or card expired
54 = card expiry date has passed
55 = Wrong confidential code
56 = File card absent
57 = transaction not allowed for this holder
58 = transaction not allowed on a terminal
59 = suspicion of fraud
60 = Card acceptor must contact the acquirer
61 = withdrawal amount exceeds the limit
63 = security rules not respected
68 = response not obtained or received too late
75 = Number of failed confidential code trials exceeded
76 = Holder already blocked, old registration retained
90 = temporary system shutdown
91 = card issuer not accessible
94 = transaction duplicated
96 = system is not working properly
97 = expiration of the termination of the global monitoring
98 = server unavailable, routing network requested again
99 = Initiator domain incident
RiskControlResult Int Numerical code of the risk control result
Null = No control performed
0 = All controls successfully completed
2 = The card exceeded allowed amounts
3 = The card belongs to the grey list of the merchant
4 = The card issuer country belongs to the grey list of the merchant or
the card issuer country does not belong to the white list of
the merchant.
5 = IP address belongs to the grey list of the merchant
6 = The bin code belongs to the grey list of the merchant
7 = An e-carte bleue detection
8 = National commercial card detection
9 = Foreign commercial card detection
14 = Systematic authorisation card detection
20 = Coherence control : no corresponding country (pays IP, pays card,
client country)
30 = The country of the IP address belongs to the grey list
99 = Technical problem encountered by the server during processing of one of the
local controls
ThreedsResult Int Final status of the 3D-Secure process
0 = initial status
1 = Status not applicable (global, reason not precised)
2 = Status not applicable (integrator disabled)
3 = Non e-commerce payment
4 = Payment without 3DS (payment per identifier, paypal, cetelem, etc.)
5 = Merchant not enrolled, no 3DS
6 = Technical error during the 3DS process, no 3DS
7 = Holder not enrolled, no 3DS
8 = Signature invalid
9 = Problem coming from the ACS
10 = The SDS process is successfully completed
11 = The 3DS process was performed by the integrator
12 = Problem coming from the DS
13 = Timeout during a DS connection
14 = Maintain for the status delivery
15 = Status not applicable (3DS present but deactivated)
16 = Payment channel for which the 3DS is not available (payments by
file...)
98 = The initialization of the 3DS process is OK
99 = Unknown status
WarrantyResult bool Payment guarantee

1.4 ExtraParameters

The Extraparameters array allows to manage the profile to be applied when entering bank details. It can represent a particular CSS application or the translation of the entry page, for example.

Property Type Example Description
profilename String "directpayment" A profile is a set of predefined parameters, which are applied when gaining access to the form, if such a form is provided .
systempaylanguage String "fr" Parameter allowing the translation of the page of the bank details entry form.
Languages available in Systempay :
German : de
English : en
Chinese : zh
Spanish : es
French : fr
Italian : it
Japanese : ja
Dutch : nl
Polish : pl
Portugese : pt
Russian : ru
Swedish : sv
Turkish : tr