Interface JSON
Contents
- 1 Demande de paiement
- 1.1 Champs génériques
- 1.2 Champs optionnels relatifs à la fraude
- 1.3 Champs optionnels relatifs aux pages de paiement
- 1.4 Champs optionnels relatifs à L’authentification
- 1.5 Champs optionnels relatifs aux moyens de paiement
- 1.5.1 Données d’entrée paymentMeanData
- 1.5.2 Données d’entrée paypal
- 1.5.3 Données d’entrée SDD
- 1.5.4 Données d’entrée Cofinoga3xcb
- 1.5.5 Données d’entrée PassBe
- 1.5.6 Données d’entrée Accord
- 1.5.7 Données d’entrée Facilypay
- 1.5.8 Données d’entrée CetelemNxcb
- 1.5.9 Données d’entrée Presto
- 1.5.10 Données d’entrée Cofidis3x
- 1.5.11 Données d’entrée Cofidis4x
- 1.5.12 Données d’entrée UnEuroCom
- 1.5.13 Données d’entrée Cofinoga
- 1.5.14 Données d’entrée PaymentMeanTradeOption
- 1.5.15 Données d’entrée Cetelem3x
- 1.5.16 Données d’entrée Cetelem4x
- 1.6 Champs optionnels relatifs au paiement échelonné
- 1.7 Champs optionnels pour les données de facturation
- 1.8 Champs optionnels pour les données client
- 1.9 Champs optionnels pour les données de livraison
- 1.10 Champs optionnels pour les données Du titulaire de carte
- 1.11 Champs optionnels pour les données du panier
- 1.12 Champs optionnels pour les ID de Transaction Sips 1.0
- 1.13 Champs optionnels pour les données de gestion du risque
- 1.14 Champs optionnels pour les données du commercant
- 1.15 Champs optionnels pour AMEX-EA
- 2 Réponse de l'initialisation de paiement
- 3 Réponses (automatiques et manuelles)
Demande de paiement
Champs génériques
Nom du champ |
Présence |
Dans la version |
Commentaires |
|
---|---|---|---|---|
amount |
Obligatoire |
WS_1.0 |
||
authenticationData |
Optionnel |
WS_2.2 |
See 8.1.4 |
|
automaticResponseUrl |
Optionnel |
WS_1.0 |
||
billingAddress |
Optionnel |
WS_2.2 |
See 8.1.7 |
|
billingContact |
Optionnel |
WS_2.2 |
See 8.1.7 |
|
billingFirstDate |
Optionnel |
WS_2.5 |
||
bypassReceiptPage |
Optionnel |
WS_2.0 |
No longer used, use container in section 8.1.3 |
|
bypassDcc |
Optionnel |
WS_2.11 |
||
captureDay |
Optionnel |
WS_1.0 |
||
captureMode |
Optionnel |
WS_1.0 |
||
currencyCode |
Obligatoire |
WS_1.0 |
||
customer3DSTransactionDate |
Optionnel |
WS_2.5 |
||
customerAddress |
Optionnel |
WS_2.2 |
See 8.1.8 |
|
customerContact |
Optionnel |
WS_2.2 |
See 8.1.8 |
|
customerData |
Optionnel |
WS_2.2 |
See 8.1.8 |
|
customerBillingNb |
Optionnel |
WS_2.5 |
||
customerDeliverySuccessFlag |
Optionnel |
WS_2.5 |
||
customerEmail |
Optionnel |
WS_1.0 |
Only available in WS_1.0 and WS_2.0 |
|
customerId |
Optionnel |
WS_2.0 |
||
customerIpAddress |
Optionnel |
WS_2.1 |
||
customerLanguage |
Optionnel |
WS_1.0 |
||
customerPhoneValidationMethod |
Optionnel |
WS_2.5 |
||
customerRegistrationDateOnline |
Optionnel |
WS_2.5 |
||
customerRegistrationDateProxi |
Optionnel |
WS_2.5 |
||
deliveryAddress |
Optionnel |
WS_2.2 |
See 8.1.9 |
|
deliveryContact |
Optionnel |
WS_2.2 |
See 8.1.9 |
|
deliveryData |
Optionnel |
WS_2.6 |
See 8.1.9 |
|
deliveryFirstDate |
Optionnel |
WS_2.5 |
||
evidenceAcquisitionDate |
Optionnel |
WS_2.5 |
||
evidenceNumber |
Optionnel |
WS_2.5 |
||
evidenceType |
Optionnel |
WS_2.5 |
||
fraudData |
Optionnel |
WS_2.1 |
See 8.1.2 |
|
hashAlgorithm1 |
Optionnel |
WS_2.1 |
||
hashAlgorithm2 |
Optionnel |
WS_2.1 |
||
hashSalt1 |
Optionnel |
WS_2.1 |
||
hashSalt2 |
Optionnel |
WS_2.1 |
||
holderAdditionalReference |
Optionnel |
WS_2.9 |
||
holderAddress |
Optionnel |
WS_2.2 |
See 8.1.10 |
|
holderContact |
Optionnel |
WS_2.2 |
See 8.1.10 |
|
holderData |
Optionnel |
WS_2.2 |
See 8.1.10 |
|
instalmentData |
Optionnel |
WS_2.6 |
See 8.1.6 |
|
interfaceVersion |
Obligatoire |
WS_1.0 |
||
intermediateServiceProviderId |
Optionnel |
WS_2.11 |
||
invoiceReference |
Optionnel |
WS_2.0 |
||
keyVersion |
Obligatoire |
WS_2.2 |
||
mandateId |
Optionnel |
WS_2.5 |
||
merchantId |
Obligatoire |
WS_1.0 |
||
merchantSessionId |
Optionnel |
WS_2.0 |
||
merchantTransactionDateTime |
Optionnel |
WS_2.0 |
||
merchantWalletID |
Optionnel |
WS_2.2 |
||
normalReturnUrl |
Obligatoire |
WS_1.0 |
||
orderChannel |
Obligatoire |
WS_2.1 |
||
ordercontext |
Optionnel |
WS_2.16 |
See 8.1.15.1 |
|
orderId |
Optionnel |
WS_1.0 |
||
paymentMeanBrandList |
Optionnel |
WS_1.0 |
This field is a JSON list |
|
paymentMeanData |
Optionnel |
WS_2.2 |
See 8.1.5 |
|
paymentPattern |
Optionnel |
WS_2.1 |
This field is Obligatoire for certain payment means. Please refer to the respective payment mean implementation guide for details. |
|
paypageData |
Optionnel |
WS_2.0 |
See 8.1.3 |
|
responseKeyVersion |
Optionnel |
WS_2.0 |
||
returnContext |
Optionnel |
WS_2.0 |
||
riskManagementCustomDataList |
Optionnel |
WS_2.9 |
This field is a JSON list of riskManagementCustomData See 8.1.13 |
|
s10TransactionReference |
Optionnel |
WS_2.7 |
See 8.1.12 |
|
seal |
Obligatoire |
WS_2.0 |
||
sealAlgorithm |
Optionnel |
WS_2.9 |
||
shoppingCartDetail |
Optionnel |
WS_2.6 |
See 8.1.11 |
|
statementReference |
Optionnel |
WS_2.1 |
||
subMerchantAddress |
Optionnel |
WS_2.15 |
See 8.1.14 |
|
subMerchantCategoryCode |
Optionnel |
WS_2.15 |
||
subMerchantId |
Optionnel |
WS_2.15 |
||
subMerchantLegalId |
Optionnel |
WS_2.15 |
||
subMerchantShortName |
Optionnel |
WS_2.15 |
||
templateName |
Optionnel |
WS_2.1 |
||
transactionActors |
Optionnel |
WS_2.2 |
||
transactionOrigin |
Optionnel |
WS_2.0 |
||
transactionReference |
Optionnel |
WS_1.0 |
||
travelContext |
Optionnel |
WS_2.16 |
See 8.1.15.2 |
|
valueDate |
Optionnel |
WS_2.5 |
Table 5: Payment request
Champs optionnels relatifs à la fraude
Données d’entrée fraudData
Nom du champ </th²> |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
allowedCardArea |
Optionnel |
WS_2.1 |
|
allowedCardCountryList |
Optionnel |
WS_2.1 |
This field is a JSON list |
allowedIpArea |
Optionnel |
WS_2.1 |
|
allowedIpCountryList |
Optionnel |
WS_2.1 |
This field is a JSON list |
bypass3DS |
Optionnel |
WS_2.1 |
|
bypassCtrlList |
Optionnel |
WS_2.1 |
This field is a JSON list |
bypassInfoList |
Optionnel |
WS_2.1 |
This field is a JSON list |
deniedCardArea |
Optionnel |
WS_2.1 |
|
deniedCardCountryList |
Optionnel |
WS_2.1 |
This field is a JSON list |
deniedIpArea |
Optionnel |
WS_2.1 |
|
deniedIpCountryList |
Optionnel |
WS_2.1 |
This field is a JSON list |
riskManagementDynamicSettingList |
Optionnel |
WS_2.10 |
This field is a JSON list of riskManagementDynamicSetting object |
Table 6: Details of the fraud fields
Données d’entrée riskManagementDynamicSetting
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
riskManagementDynamicParam |
Obligatoire |
WS_2.10 |
|
riskManagementDynamicValue |
Obligatoire |
WS_2.10 |
Table 7: Details of RiskManagementDynamicSetting fields
Champs optionnels relatifs aux pages de paiement
Données d’entrée paypageData
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
bypassReceiptPage |
Optionnel |
WS_2.0 |
Table 8: Details of fields regarding the functioning of payment pages
Champs optionnels relatifs à L’authentification
Données d’entrée authenticationData
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
issuerWalletPolicy |
Optionnel |
WS_2.2 |
See below |
cardAuthPolicy |
Optionnel |
WS_2.8 |
See below |
Table 9: Details of fields regarding the authentication data fields
Données d’entrée IssuerWalletPolicy
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
check3DS |
Optionnel |
WS_2.2 |
|
checkCSC |
Optionnel |
WS_2.2 |
Table 10: Details of fields regarding the issuer wallet authentication policy
Données d’entrée CardAuthPolicy
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
checkAVS |
Optionnel |
WS_2.8 |
|
ignoreAddressCheckResult |
Optionnel |
WS_2.8 |
|
ignorePostcodeCheckResult |
Optionnel |
WS_2.8 |
|
ignoreCSCCheckResult |
Optionnel |
WS_2.17 |
Table 11: Details of fields regarding the card authentication policy
Champs optionnels relatifs aux moyens de paiement
Données d’entrée paymentMeanData
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
paypal |
Optionnel |
WS_2.2 |
|
sdd |
Optionnel |
WS_2.2 |
|
cofinoga3xcb |
Optionnel |
WS_2.2 |
|
passbe |
Optionnel |
WS_2.5 |
|
accord |
Optionnel |
WS_2.6 |
|
facilypay |
Optionnel |
WS_2.6 |
|
cetelemNxcb |
Optionnel |
WS_2.9 |
See below |
presto |
Optionnel |
WS_2.10 |
See below |
cofidis3x |
Optionnel |
WS_2.11 |
See below |
cofidis4x |
Optionnel |
WS_2.12 |
See below |
unEuroCom |
Optionnel |
WS_2.11 |
See below |
cofinoga |
Optionnel |
WS_2.15 |
See below |
cetelem3x |
Optionnel |
WS_2.16 |
See below |
cetelem4x |
Optionnel |
WS_2.16 |
See below |
Table 12: Fields relating to PaymentMeanData fields
Données d’entrée paypal
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
landingPage |
Optionnel |
WS_2.2 |
|
addrOverride |
Optionnel |
WS_2.2 |
|
invoiceId |
Optionnel |
WS_2.2 |
|
dupFlag |
Optionnel |
WS_2.2 |
|
dupDesc |
Optionnel |
WS_2.2 |
|
dupCustom |
Optionnel |
WS_2.2 |
|
dupType |
Optionnel |
WS_2.2 |
|
mobile |
Optionnel |
WS_2.2 |
|
orderDescription |
Optionnel |
WS_2.16 |
Table 13: Fields relating to PayPal
Données d’entrée SDD
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
mandateAuthentMethod |
Optionnel |
WS_2.2 |
|
mandateUsage |
Optionnel |
WS_2.2 |
|
mandateCertificationType |
Optionnel |
WS_2.5 |
Table 14: Fields relating to SDD
Données d’entrée Cofinoga3xcb
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
creditIndicator |
Optionnel |
WS_2.2 |
Table 15: Fields relating to Cofinoga3xcb
Données d’entrée PassBe
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
settlementModeList |
Optionnel |
WS_2.5 |
Table 16: Fields relating to PassBe
Données d’entrée Accord
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
settlementMode |
Optionnel |
WS_2.6 |
Table 17: Fields relating to Accord
Données d’entrée Facilypay
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
settlementMode |
Optionnel |
WS_2.6 |
|
settlementModeVersion |
Optionnel |
WS_2.6 |
|
receiverType |
Optionnel |
WS_2.6 |
|
depositRefundIndicator |
Optionnel |
WS_2.6 |
Table 18: Fields relating to Facilypay
Données d’entrée CetelemNxcb
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
nxcbTransactionReference1 |
Optionnel |
WS_2.9 |
|
nxcbTransactionReference2 |
Optionnel |
WS_2.9 |
|
s10NxcbTransactionId1 |
Optionnel |
WS_2.9 |
|
s10NxcbTransactionId2 |
Optionnel |
WS_2.9 |
Table 19: Fields relating to CetelemNxcb
Données d’entrée Presto
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
financialProduct |
Obligatoire |
WS_2.10 |
Only Obligatoire for a presto transaction |
paymentMeanCustomerId |
Obligatoire |
WS_2.10 |
Only Obligatoire for a presto transaction |
prestoCardType |
Optionnel |
WS_2.10 |
Table 20: Fields relating to Presto
Données d’entrée Cofidis3x
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
preScoreValue |
Optionnel |
WS_2.11 |
|
cofidisDisplayCancelButton |
Optionnel |
WS_2.11 |
|
cofidisPrivateData |
Optionnel |
WS_2.11 |
Table 21: Fields relating to cofidis3x
Données d’entrée Cofidis4x
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
preScoreValue |
Optionnel |
WS_2.12 |
|
cofidisDisplayCancelButton |
Optionnel |
WS_2.12 |
|
cofidisPrivateData |
Optionnel |
WS_2.12 |
Table 22: Fields relating to cofidis4x
Données d’entrée UnEuroCom
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
preScoreValue |
Optionnel |
WS_2.11 |
|
cofidisPrivateData |
Optionnel |
WS_2.11 |
Table 23: Fields relating to unEuroCom
Données d’entrée Cofinoga
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
paymentMeanTradeOptionList |
Optionnel |
WS_2.15 |
paymentMeanTradeOption is a container describe below |
Table 24: Fields relating to cofinoga
Données d’entrée PaymentMeanTradeOption
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
paymentMeanTradingName |
Optionnel |
WS_2.15 |
|
settlementModeList |
Optionnel |
WS_2.15 |
Table 25: Fields relating to paymentMeanTradOption
Données d’entrée Cetelem3x
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
cetelemPrivateMerchantData |
Optionnel |
WS_2.16 |
|
cetelemPrivateData |
Optionnel |
WS_2.16 |
Table 5: Fields relating to cetelem3x
Données d’entrée Cetelem4x
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
cetelemPrivateMerchantData |
Optionnel |
WS_2.16 |
|
cetelemPrivateData |
Optionnel |
WS_2.16 |
Table26: Fields relating to cetelem4x
Champs optionnels relatifs au paiement échelonné
Données d’entrée instalmentData
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
number |
Optionnel |
WS_2.2 |
|
datesList |
Optionnel |
WS_2.2 |
This field is a JSON list |
transactionReferencesList |
Optionnel |
WS_2.2 |
This field is a JSON list |
s10transactionIdsList |
Optionnel |
WS_2.7 |
This field is a JSON list |
amountsList |
Optionnel |
WS_2.2 |
This field is a JSON list |
Table 28: Fields relating to recurring payment
Champs optionnels pour les données de facturation
Données d’entrée billingAddress
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
addressAdditional1 |
Optionnel |
WS_2.2 |
|
addressAdditional2 |
Optionnel |
WS_2.2 |
|
addressAdditional3 |
Optionnel |
WS_2.2 |
|
city |
Optionnel |
WS_2.2 |
|
company |
Optionnel |
WS_2.2 |
|
country |
Optionnel |
WS_2.2 |
|
postBox |
Optionnel |
WS_2.2 |
|
state |
Optionnel |
WS_2.2 |
|
street |
Optionnel |
WS_2.2 |
|
streetNumber |
Optionnel |
WS_2.2 |
|
zipCode |
Optionnel |
WS_2.2 |
Table 29: Fields for the billingAddress element
Données d’entrée billingContact
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
|
Optionnel |
WS_2.2 |
|
firstname |
Optionnel |
WS_2.2 |
|
gender |
Optionnel |
WS_2.2 |
|
lastname |
Optionnel |
WS_2.2 |
|
mobile |
Optionnel |
WS_2.2 |
|
phone |
Optionnel |
WS_2.2 |
|
title |
Optionnel |
WS_2.2 |
Table 30: Fields for the billingContact element
Champs optionnels pour les données client
Données d’entrée customerAddress
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
addressAdditional1 |
Optionnel |
WS_2.2 |
|
addressAdditional2 |
Optionnel |
WS_2.2 |
|
addressAdditional3 |
Optionnel |
WS_2.2 |
|
city |
Optionnel |
WS_2.2 |
|
company |
Optionnel |
WS_2.2 |
|
country |
Optionnel |
WS_2.2 |
|
postBox |
Optionnel |
WS_2.2 |
|
state |
Optionnel |
WS_2.2 |
|
street |
Optionnel |
WS_2.2 |
|
streetNumber |
Optionnel |
WS_2.2 |
|
zipCode |
Optionnel |
WS_2.2 |
|
businessName |
Optionnel |
WS_2.17 |
Table 31: Fields for the customerAddress element
Données d’entrée customerContact
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
|
Optionnel |
WS_2.2 |
|
firstname |
Optionnel |
WS_2.2 |
|
gender |
Optionnel |
WS_2.2 |
|
lastname |
Optionnel |
WS_2.2 |
|
mobile |
Optionnel |
WS_2.2 |
|
phone |
Optionnel |
WS_2.2 |
|
title |
Optionnel |
WS_2.2 |
|
initials |
Optionnel |
WS_2.17 |
|
legalId |
Optionnel |
WS_2.17 |
|
positionOccupied |
Optionnel |
WS_2.17 |
Table 32: Fields for the customerContact element
Données d’entrée customerData
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
birthCity |
Optionnel |
WS_2.2 |
|
birthCountry |
Optionnel |
WS_2.2 |
|
birthDate |
Optionnel |
WS_2.2 |
|
birthZipCode |
Optionnel |
WS_2.2 |
|
nationalityCountry |
Optionnel |
WS_2.2 |
|
newPwd |
Optionnel |
WS_2.2 |
|
pwd |
Optionnel |
WS_2.2 |
|
maidenName |
Optionnel |
WS_2.18 |
Table 33: Fields for the customerData element
Champs optionnels pour les données de livraison
Données d’entrée deliveryAddress
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
addressAdditional1 |
Optionnel |
WS_2.2 |
|
addressAdditional2 |
Optionnel |
WS_2.2 |
|
addressAdditional3 |
Optionnel |
WS_2.2 |
|
city |
Optionnel |
WS_2.2 |
|
company |
Optionnel |
WS_2.2 |
|
country |
Optionnel |
WS_2.2 |
|
postBox |
Optionnel |
WS_2.2 |
|
state |
Optionnel |
WS_2.2 |
|
street |
Optionnel |
WS_2.2 |
|
streetNumber |
Optionnel |
WS_2.2 |
|
zipCode |
Optionnel |
WS_2.2 |
Table 34: Fields for the deliveryAddress element
Données d’entrée deliveryContact
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
|
Optionnel |
WS_2.2 |
|
firstname |
Optionnel |
WS_2.2 |
|
gender |
Optionnel |
WS_2.2 |
|
lastname |
Optionnel |
WS_2.2 |
|
mobile |
Optionnel |
WS_2.2 |
|
phone |
Optionnel |
WS_2.2 |
|
title |
Optionnel |
WS_2.2 |
Table 35: Fields for the deliveryContact element
Données d'entrée deliveryData
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
deliveryChargeAmount |
Optionnel |
WS_2.6 |
|
estimatedDeliveryDate |
Optionnel |
WS_2.6 |
|
estimatedDeliveryDelay |
Optionnel |
WS_2.7 |
|
deliveryMode |
Optionnel |
WS_2.6 |
|
deliveryMethod |
Optionnel |
WS_2.6 |
|
deliveryOperator |
Optionnel |
WS_2.6 |
Table 36 : Fields for the deliveryData element
Champs optionnels pour les données Du titulaire de carte
Données d’entrée holderAddress
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
addressAdditional1 |
Optionnel |
WS_2.2 |
|
addressAdditional2 |
Optionnel |
WS_2.2 |
|
addressAdditional3 |
Optionnel |
WS_2.2 |
|
city |
Optionnel |
WS_2.2 |
|
company |
Optionnel |
WS_2.2 |
|
country |
Optionnel |
WS_2.2 |
|
postBox |
Optionnel |
WS_2.2 |
|
state |
Optionnel |
WS_2.2 |
|
street |
Optionnel |
WS_2.2 |
|
streetNumber |
Optionnel |
WS_2.2 |
|
zipCode |
Optionnel |
WS_2.2 |
Table 37: Fields for the holderAddress element
Données d’entrée holderContact
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
|
Optionnel |
WS_2.2 |
|
firstname |
Optionnel |
WS_2.2 |
|
gender |
Optionnel |
WS_2.2 |
|
lastname |
Optionnel |
WS_2.2 |
|
mobile |
Optionnel |
WS_2.2 |
|
phone |
Optionnel |
WS_2.2 |
|
title |
Optionnel |
WS_2.2 |
Table 38: Fields for the holderContact element
Données d'entrée holderData
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
birthDate |
Optionnel |
WS_2.6 |
Table 39: Fields for the holderData element
Champs optionnels pour les données du panier
Données d’entrée shoppingCartDetail
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
shoppingCartTotalAmount |
Optionnel |
WS_2.6 |
|
shoppingCartTotalQuantity |
Optionnel |
WS_2.6 |
|
shoppingCartTotalTaxAmount |
Optionnel |
WS_2.7 |
|
mainProduct |
Optionnel |
WS_2.6 |
|
shoppingCartItemList |
Optionnel |
WS_2.6 |
This field is a JSON list of shoppingCartItem |
Table 40: Fields for the shoppingCartDetail element
Données d’entrée shoppingCartItem
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
productName |
Optionnel |
WS_2.6 |
|
productDescription |
Optionnel |
WS_2.6 |
|
productCode |
Optionnel |
WS_2.6 |
|
productSKU |
Optionnel |
WS_2.6 |
|
productUnitAmount |
Optionnel |
WS_2.6 |
|
productQuantity |
Optionnel |
WS_2.6 |
|
productTaxRate |
Optionnel |
WS_2.6 |
|
productUnitTaxAmount |
Optionnel |
WS_2.6 |
|
productCategory |
Optionnel |
WS_2.6 |
Table 41: Fields for the shoppingCartItem element
Champs optionnels pour les ID de Transaction Sips 1.0
Données d’entrée s10TransactionReference
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
s10TransactionId |
Optionnel |
WS_2.7 |
|
s10TransactionIdDate |
Optionnel |
WS_2.7 |
Table 42: Fields for the s10TransactionReference element
Champs optionnels pour les données de gestion du risque
Données d’entrée riskManagementCustomData
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
riskManagementCustomSequence |
Optionnel |
WS_2.9 |
|
riskManagementCustomValue |
Optionnel |
WS_2.9 |
Table 43: Fields for the riskManagementCustomData element
Champs optionnels pour les données du commercant
Données d’entrée subMerchantAddress
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
addressAdditional1 |
Optionnel |
WS_2.15 |
|
addressAdditional2 |
Optionnel |
WS_2.15 |
|
addressAdditional3 |
Optionnel |
WS_2.15 |
|
city |
Optionnel |
WS_2.15 |
|
company |
Optionnel |
WS_2.15 |
|
country |
Optionnel |
WS_2.15 |
|
postBox |
Optionnel |
WS_2.15 |
|
state |
Optionnel |
WS_2.15 |
|
street |
Optionnel |
WS_2.15 |
|
streetNumber |
Optionnel |
WS_2.15 |
|
zipCode |
Optionnel |
WS_2.15 |
Table 44: Fields for the subMerchantAddress element
Champs optionnels pour AMEX-EA
Données d’entrée orderContext
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
customerHostName |
Optionnel |
WS_2.16 |
|
customerBrowserType |
Optionnel |
WS_2.16 |
|
customerANI |
Optionnel |
WS_2.16 |
|
customerANIInformationIdentifier |
Optionnel |
WS_2.16 |
Table 27: Fields relating to orderContext
Données d’entrée travelContext
Nom du champ |
Présence |
Dans la version |
Commentaires |
---|---|---|---|
departureDate |
Optionnel |
WS_2.16 |
|
passengerName |
Optionnel |
WS_2.16 |
|
originAirport |
Optionnel |
WS_2.16 |
|
numberOfRoutingCities |
Optionnel |
WS_2.16 |
|
routingCityList |
Optionnel |
WS_2.16 |
This field is a JSON list |
numberOfAirlineCarriers |
Optionnel |
WS_2.16 |
|
airlineCarrierList |
Optionnel |
WS_2.16 |
This field is a JSON list |
fareBasis |
Optionnel |
WS_2.16 |
|
numberOfPassengers |
Optionnel |
WS_2.16 |
|
destinationAirport |
Optionnel |
WS_2.16 |
|
reservationCode |
Optionnel |
WS_2.16 |
Table 27: Fields relating to travelContext
Réponse de l'initialisation de paiement
Champs génériques
Nom du champ |
Dans la version |
Commentaires |
---|---|---|
redirectionData |
WS_1.0 |
encrypted and private Sips transaction field |
redirectionStatusCode |
WS_1.0 |
2 digits code indicating if the initialisation response is correct (depending on the initialisation request, on the server and the connexion status) |
redirectionStatusMessage |
WS_1.0 |
brief description of the redirectionStatusCode |
redirectionUrl |
WS_1.0 |
URL to redirect the end user to. |
redirectionVersion |
WS_1.0 |
Private version of Sips message |
seal |
WS_2.2 |
Response seal |
Table 45: Field for the payment initialization response
Réponses (automatiques et manuelles)
Le contenu des réponses Web automatiques et manuelles de Sips Paypage est identique. Le contenu lui-même peut varier selon le résultat du paiement (réussi ou autre).
Nom du champ |
Dans la version |
Commentaires |
---|---|---|
acquirerNativeResponseCode* |
HP_2.12 |
|
acquirerResponseCode* |
HP_2.0 |
|
acquirerResponseIdentifier* |
HP_2.8 |
|
acquirerResponseMessage* |
HP_2.8 |
|
additionalAuthorisationNumber* |
HP_2.8 |
|
amount |
HP_1.0 |
Value communicated in the payment request. |
avsAddressResponseCode |
HP_2.17 |
|
avsPostcodeResponseCode |
HP_2.17 |
|
authorisationId |
HP_1.0 |
Value communicated in the payment request. |
captureDay |
HP_1.0 |
Value communicated in the payment request. |
captureLimitDate* |
HP_2.3 |
|
captureMode |
HP_1.0 |
Value communicated in the payment request. |
cardCSCResultCode* |
HP_2.0 |
|
cardProductCode* |
HP_2.12 |
|
cardProductName* |
HP_2.12 |
|
cardProductProfile* |
HP_2.12 |
|
complementaryCode* |
HP_1.0 |
|
complementaryInfo* |
HP_2.0 |
|
creditorId* |
HP_2.7 |
|
currencyCode |
HP_1.0 |
Value communicated in the payment request. |
customerBusinessName |
HP_2.17 |
|
customerCompanyName |
HP_2.17 |
|
customerEmail |
HP_2.0 |
Value communicated in the payment request. Only available for version HP_2.0 |
customerId |
HP_2.0 |
Value communicated in the payment request. |
customerIpAddress |
HP_2.0 |
Value communicated in the payment request. |
customerLegalId |
HP_2.17 |
|
customerMobilePhone |
HP_2.1 |
Value communicated in the payment request. Only available for version HP_2.1 |
customerPositionOccupied |
HP_2.17 |
|
dccAmount* |
HP_2.3 |
|
dccCurrencyCode* |
HP_2.3 |
|
dccExchangeRate* |
HP_2.3 |
|
dccExchangeRateValidity* |
HP_2.3 |
|
dccProvider* |
HP_2.3 |
|
dccStatus* |
HP_2.3 |
|
dccResponseCode* |
HP_2.3 |
|
guarantheeIndicator* |
HP_2.0 |
|
hashPan1* |
HP_2.0 |
|
hashPan2* |
HP_2.0 |
|
holderAuthentMethod* |
HP_2.4 |
|
holderAuthentProgram* |
HP_2.5 |
|
holderAuthentRelegation* |
HP_2.0 |
|
holderAuthentStatus* |
HP_2.0 |
|
instalmentAmountsList* |
HP_2.6 |
|
instalmentDatesList* |
HP_2.6 |
|
instalmentNumber* |
HP_2.6 |
|
instalmentTransactionReferencesList* |
HP_2.6 |
|
interfaceVersion* |
HP_1.0 |
|
invoiceReference |
HP_2.10 |
|
issuerCode* |
HP_2.12 |
|
issuerCountryCode* |
HP_2.12 |
|
issuerEnrollementIndicator* |
HP_2.0 |
|
issuerWalletInformation |
HP_2.9 |
|
keyVersion* |
HP_1.0 |
Value communicated in the payment request. |
mandateAuthentMethod* |
HP_2.2 |
|
mandateCertificationType* |
HP_2.7 |
|
mandateId* |
HP_2.3 |
|
mandateUsage* |
HP_2.2 |
|
maskedPan* |
HP_1.0 |
|
merchantId |
HP_1.0 |
Value communicated in the payment request. |
merchantSessionId |
HP_2.0 |
Value communicated in the payment request. |
merchantTransactionDateTime |
HP_2.0 |
Value communicated in the payment request. |
merchantWalletId |
HP_2.0 |
Value communicated in the payment request. |
orderChannel |
HP_2.0 |
Value communicated in the payment request. |
orderId |
HP_1.0 |
Value communicated in the payment request. |
panEntryMode* |
HP_2.4 |
|
panExpiryDate* |
HP_2.0 |
|
paymentAttemptNumber |
HP_2.18 |
|
paymentMeanBrand* |
HP_1.0 |
|
paymentMeanBrandSelectionStatus* |
HP_2.14 |
|
paymentMeanData* |
HP_2.2 |
|
paymentMeanId* |
HP_2.6 |
|
paymentMeanTradingName* |
HP_2.8 |
|
paymentMeanType* |
HP_1.0 |
|
paymentPattern* |
HP_2.0 |
Value communicated in the payment request. |
preAuthenticationColor |
HP_2.10 |
|
preAuthenticationInfo |
HP_2.10 |
|
preAuthenticationProfile |
HP_2.10 |
|
preAuthenticationProfileValue* |
HP_2.14 |
|
preAuthenticationRuleResultList* |
HP_2.14 |
A list of preAuthenticationRuleResult objects. See below. |
preAuthenticationThreshold |
HP_2.10 |
|
preAuthenticationValue |
HP_2.10 |
|
preAuthorisationProfile* |
HP_2.14 |
|
preAuthorisationProfileValue* |
HP_2.14 |
|
preAuthorisationRuleResultList* |
HP_2.14 |
A list of preAuthorisationRuleResult objects. See below. |
responseCode |
HP_1.0 |
|
returnContext |
HP_1.0 |
Value communicated in the payment request. |
s10TransactionId |
HP_2.9 |
|
s10TransactionIdDate |
HP_2.9 |
|
s10transactionIdsList* |
HP_2.11 |
|
scoreColor* |
HP_2.0 |
|
scoreInfo* |
HP_2.0 |
|
scoreProfile* |
HP_2.0 |
|
scoreThreshold* |
HP_2.0 |
|
scoreValue* |
HP_2.0 |
|
settlementMode |
HP_2.7 |
|
settlementModeComplement |
HP_2.13 |
|
statementReference* |
HP_2.4 |
|
tokenPan* |
HP_2.0 |
|
transactionActors* |
HP_2.2 |
Value communicated in the payment request. |
transactionDateTime* |
HP_1.0 |
|
transactionOrigin* |
HP_2.0 |
Value communicated in the payment request. |
transactionPlatform |
HP_2.16 |
Future use (always filled with ‘PROD’ for the moment) |
transactionReference |
HP_1.0 |
Value communicated in the payment request. |
walletType* |
HP_2.4 |
Table 46: Field for the automatic/manual payment response
- these fields are provided when they are available, depending on the status of the transaction and the method of payment selected.
Données de PreAuthorisationRuleResult
Nom du champ |
Dans la version |
Commentaires |
---|---|---|
ruleCode |
HP_2.14 |
|
ruleType |
HP_2.14 |
|
ruleWeight |
HP_2.14 |
|
ruleSetting |
HP_2.14 |
|
ruleResultIndicator |
HP_2.14 |
|
ruleDetailedInfo |
HP_2.14 |
Table 47: Fields for the PreAuthorisationRuleResult element
Données de PreAuthenticationRuleResult
Nom du champ |
Dans la version |
Commentaires |
---|---|---|
ruleCode |
HP_2.14 |
|
ruleType |
HP_2.14 |
|
ruleWeight |
HP_2.14 |
|
ruleSetting |
HP_2.14 |
|
ruleResultIndicator |
HP_2.14 |
|
ruleDetailedInfo |
HP_2.14 |
Table 48: Fields for the PreAuthenticationRuleResult element