addDirectDebit
To search in the page use Ctrl+F on your keyboard
This function allows to add a mandate to a wallet. If the mandat is already recorded in the wallet, then a 94 response code is returned.
If the creation succeeds, response code 00 is returned as well as a lot of information about the account and the associated mandate
- creation date
- external identifier of the means of payment created for the wallet
- iban, partially hidden (only the first 4 and 2 last digits are clear).
Recommended interfaceVersion: WR_WS_2.52
Endpoints
-
- PROD
-
https://office-server.sogenactif.com/rs-services/v2/wallet/addDirectDebit - method
- POST
-
- TEST
-
https://office-server-sogenactif.test.sips-services.com/rs-services/v2/wallet/addDirectDebit - method
- POST
-
- PROD
-
https://office-server.sogenactif.com/services/v2/wallet?wsdl - method
- POST
-
- TEST
-
https://office-server-sogenactif.test.sips-services.com/services/v2/wallet?wsdl - method
- POST
Request
Required
-
interfaceVersion- presence
- Required
- Interface version
- 2.0
Version of the interface used. It is composed of a prefix that varies according to the function used and a version number (e.g. IR_WS_2.47).
Please refer to the function page for the value to use. Use the latest interface version number.
List of values
WR_WS_2.- WR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Wallet functions.
-
keyVersion- presence
- Required
- Interface version
- 2.0
Version of the merchant’s secret key used to calculate the imprint of the message (key stored by the merchant to verify the imprint of the automatic and manual notifications).
-
merchantId- presence
- Required
- Interface version
- 2.0
Identifier of the shop, this value is provided to the merchant by Sogenactif during the shop registration.
-
merchantWalletId- presence
- Required
- Interface version
- 2.0
Customer’s Wallet identifier.
-
paymentMeanBrand- presence
- Required
- Interface version
- 2.0
Name of the payment method that is used. It is related to one paymentMeanType.
List of values
1EUROCOM- Cofidis Pay 5x10x20x Acquisition contract: ONLINE_CREDIT
3XCBCOFINOGA- Depreciated. Cofinoga 3xCB paymentMeanBrandType: CARD
ACCEPTGIRO- AcceptGiro paymentMeanBrandType: CREDIT_TRANSFER
ACCORD- Oney card paymentMeanBrandType: CARD
ACCORD_3X- Payment in 3 times with Facily Pay paymentMeanBrandType: ONLINE_CREDIT
ACCORD_4X- Payment in 4 times with Facily Pay paymentMeanBrandType: ONLINE_CREDIT
ACCORD_KDO- Carte Cadeau Oney paymentMeanBrandType: CARD
AIRPLUS- Airplus card paymentMeanBrandType: CARD
AIRPLUS_LOGEE- Airplus card paymentMeanBrandType: CARD
AMEX- American Express card paymentMeanBrandType: CARD
AMEX_LOGEE- American Express card paymentMeanBrandType: CARD
AURORE- CPAY card paymentMeanBrandType: CARD
BCACB_3X- Payment in 3 times with Floa Bank CB paymentMeanBrandType: ONLINE_CREDIT
BCACB_4X- Payment in 4 times with Floa Bank CB paymentMeanBrandType: ONLINE_CREDIT
BCACUP- CUP card of Floa Bank paymentMeanBrandType: CARD
BCMC- Bancontact card paymentMeanBrandType: CARD
CACF_3X- CACF payment in 3 installments paymentMeanBrandType: ONLINE_CREDIT
CACF_3XSANSFRAIS- CACF payment in 3 installments free of charge paymentMeanBrandType: ONLINE_CREDIT
CACF_4X- CACF payment in 4 installments paymentMeanBrandType: ONLINE_CREDIT
CACF_4XSANSFRAIS- CACF payment in 4 installments free of charge paymentMeanBrandType: ONLINE_CREDIT
CADHOC- Cadhoc paymentMeanBrandType: CARD
CADOCARTE- Cado Carte paymentMeanBrandType: CARD
CB- Carte Bancaire paymentMeanBrandType: CARD
CBCONLINE- PayButton CBC Online paymentMeanBrandType: CREDIT_TRANSFER
CETELEM_3X- Cetelem 3xCB paymentMeanBrandType: ONLINE_CREDIT
CETELEM_4X- Cetelem 4xCB paymentMeanBrandType: ONLINE_CREDIT
COFIDIS_3X- Cofidis 3xCB paymentMeanBrandType: ONLINE_CREDIT
COFIDIS_4X- Cofidis 4xCB paymentMeanBrandType: ONLINE_CREDIT
CONECS- Titres Restaurants Dématérialisés Conecs paymentMeanBrandType: VOUCHER
CUP- China UnionPay card paymentMeanBrandType: CARD
CVA- Visa Aurore card paymentMeanBrandType: CARD
CVCO- Chèque-Vacances Connect paymentMeanBrandType: VOUCHER
DINERS- Carte Diners club international paymentMeanBrandType: CARD
ELV- Elektronisches LastschriftVerfahren paymentMeanBrandType: DIRECT_DEBIT
FIVORY- Lyf Pay paymentMeanBrandType: WALLET
FRANFINANCE_3X- Franfinance 3xCB paymentMeanBrandType: ONLINE_CREDIT
FRANFINANCE_4X- Franfinance 4xCB paymentMeanBrandType: ONLINE_CREDIT
GIROPAY- Giropay paymentMeanBrandType: CREDIT_TRANSFER
IDEAL- iDeal paymentMeanBrandType: CREDIT_TRANSFER
ILLICADO- Illicado paymentMeanBrandType: CARD
INCASSO- Incasso paymentMeanBrandType: DIRECT_DEBIT
INGHOMEPAY- PayButton ING Home’Pay paymentMeanBrandType: CREDIT_TRANSFER
JCB- Carte Japan Credit Bureau paymentMeanBrandType: CARD
KBCONLINE- PayButton KBC Online paymentMeanBrandType: CREDIT_TRANSFER
LEPOTCOMMUN- Le Pot Commun paymentMeanBrandType: CARD
LYDIA- Lydia paymentMeanBrandType: PROVIDER
MAESTRO- Maestro card (Mastercard) paymentMeanBrandType: CARD
MASTERCARD- Mastercard card paymentMeanBrandType: CARD
MASTERPASS- Deprecated - MasterPass paymentMeanBrandType:
ONEY34X- Payment in 3 or 4 times with Oney paymentMeanBrandType: ONLINE_CREDIT
PAYLIB- Paylib paymentMeanBrandType:
PAYPAL- Paypal paymentMeanBrandType: WALLET
PAYTRAIL- Paytrail paymentMeanBrandType: CREDIT_TRANSFER
PAY_BY_BANK- SEPA credit transfer paymentMeanBrandType: CREDIT_TRANSFER
PRESTO- Presto Plus paymentMeanBrandType: ONLINE_CREDIT
SEPA_DIRECT_DEBIT- SDD (SEPA Direct Debit) paymentMeanBrandType: DIRECT_DEBIT
SOFINCO- Sofinco card paymentMeanBrandType: CARD
SOFORTUBERWEISUNG- Sofortüberweisung (Sofort Banking) paymentMeanBrandType: CREDIT_TRANSFER
UNKNOWN- Unknown payment mean (this value can be returned by Sogenactif but must not be used in a request)
VISA- Visa card paymentMeanBrandType: CARD
VISACHECKOUT- Deprecated - Visa Checkout wallet paymentMeanBrandType: WALLET
VISA_ELECTRON- Carte Visa Electron paymentMeanBrandType: CARD
VPAY- VPAY card (Visa) paymentMeanBrandType: CARD
-
seal- presence
- Required
- Interface version
- 2.0
Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.
Optional
-
customerAccount- presence
- Optional
- Interface version
- 2.0
Account number of the customer either in national, or international or specific codification. The format is specified in the field customerBankAccountType (eg IBAN …).
-
customerBankCode- presence
- Optional
- Interface version
- 2.0
Bank code of the customer either in national, or international or specific codification. The format is specified in the field customerBankAccountType (eg BIC …).
-
intermediateServiceProviderId- presence
- Optional
- Interface version
- 2.12
Identifier of the Service used by the merchant for the exchanges with the Sogenactif platform.
-
mandateId- presence
- Optional
- Interface version
- 2.0
Mandate number.
-
paymentMeanAlias- presence
- Optional
- Interface version
- 2.0
Payment mean alias defined by the Buyer and used in the Buyer’s wallet.
Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data.
-
sealAlgorithm- presence
- Optional
- Interface version
- 2.12
Algorithm applied to calculate the seal encryption.
List of values
HMAC-SHA-256- The encryption algorithm applied is HMAC-SHA-256
HMAC-SHA-512- The encryption algorithm applied is HMAC-SHA-512
SHA-256- The encryption algorithm applied is SHA-256
-
transactionActors- presence
- Optional
- Interface version
- 2.0
Indicates the players in the transaction.
List of values
BTOB- Business to Business
BTOC- Business to Consumer
BTOF- Business to organization / association
Request sample
{
"customerAccount": "FR76300460012900297215195464",
"customerBankCode": "CEPAFRPP118",
"interfaceVersion": "WR_WS_2.0",
"keyVersion": "1",
"mandateId": "MANDATE0001",
"merchantId": "011223344550000",
"merchantWalletId": "1",
"paymentMeanAlias": "ABC bank account",
"paymentMeanBrand": "SEPA_DIRECT_DEBIT",
"transactionActors": "BtoB",
"seal": "8493c63cd279824b90bf39f542df205343392e08412345d4c2b9c856c42464ef9"
}
<urn:addDirectDebit>
<urn:input>
<urn:merchantId>023107704346002</urn:merchantId>
<urn:interfaceVersion>WR_WS_2.0</urn:interfaceVersion>
<urn:merchantWalletId>1</urn:merchantWalletId>
<urn:paymentMeanBrand>SEPA_DIRECT_DEBIT</urn:paymentMeanBrand>
<urn:mandateId>MANDATE0001</urn:mandateId>
<urn:customerBankCode>CEPAFRPP118</urn:customerBankCode>
<urn:customerAccount>FR76300460012900297215195464</urn:customerAccount>
<urn:transactionActors>BtoB</urn:transactionActors>
<urn:paymentMeanAlias>ABC bank account</urn:paymentMeanAlias>
</urn:input>
</urn:addDirectDebit>
Response
Required
-
seal- presence
- Required
- Interface version
- 2.0
Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.
Optional
-
errorFieldName- presence
- Optional
- Interface version
- 2.0
Error field name of the incoming request. Present when responseCode = 12 or 30.
-
maskedPan- presence
- Optional
- Interface version
- 2.0
Masked Primary Account Number. In the case of wallets, masked PAN of the payment mean registered in the wallet.
-
paymentMeanId- presence
- Optional
- Interface version
- 2.0
Payment mean rank in Sogenactif wallet.
-
transactionActors- presence
- Optional
- Interface version
- 2.0
Indicates the players in the transaction.
List of values
BTOB- Business to Business
BTOC- Business to Consumer
BTOF- Business to organization / association
-
walletActionDateTime- presence
- Optional
- Interface version
- 2.0
Date and time of the action on the wallet, in Sogenactif system at the merchant’s local time (in the merchant’s time zone)
-
walletResponseCode- presence
- Optional
- Interface version
- 2.0
Sogenactif server response code for wallet Management.
List of values
00- Successful operation
03- Invalid Merchant contract
12- Invalid data, verify the request
25- Wallet / payment mean unknown by Sogenactif
30- Format error
40- merchantId not allowed to access this wallet service
94- Duplicated wallet / payment mean
99- Temporary problem at the Sogenactif server level
Response sample
{
"walletActionDateTime": "2014-07-28T21:14:13-12:00",
"paymentMeanId": "8",
"maskedPan": "MAND#####01",
"transactionActors": "BtoB",
"walletResponseCode": "00",
"seal": "75cc0bd5f72a15fb38b0f609393437db61866f867fa7befeef9b3f496a9e449f"
}
<addDirectDebitResponse xmlns="urn:sips:cn:contract:office:wallet:v2">
<output>
<walletActionDateTime>2014-07-28T21:02:26-12:00</walletActionDateTime>
<paymentMeanId>7</paymentMeanId>
<maskedPan>FR76#####01</maskedPan>
<transactionActors>BtoB</transactionActors>
<walletResponseCode>00</walletResponseCode>
</output>
</addDirectDebitResponse>
Changelog
| Interface version | Data | Attendance | Container |
|---|---|---|---|
| 2.0 |
customerAccount
|
Request | |
| 2.0 |
customerBankCode
|
Request | |
| 2.12 |
intermediateServiceProviderId
|
Request | |
| 2.0 |
mandateId
|
Request | |
| 2.0 |
paymentMeanAlias
|
Request | |
| 2.12 |
sealAlgorithm
|
Request | |
| 2.0 |
transactionActors
|
Request/Response | |
| 2.0 |
interfaceVersion
|
Request | |
| 2.0 |
keyVersion
|
Request | |
| 2.0 |
merchantId
|
Request | |
| 2.0 |
merchantWalletId
|
Request | |
| 2.0 |
paymentMeanBrand
|
Request | |
| 2.0 |
seal
|
Request/Response | |
| 2.0 |
errorFieldName
|
Response | |
| 2.0 |
maskedPan
|
Response | |
| 2.0 |
paymentMeanId
|
Response | |
| 2.0 |
walletActionDateTime
|
Response | |
| 2.0 |
walletResponseCode
|
Response |
