Release 24.5

go directly to content

Search by keywords

creditTransferInitialize

To search in the page use Ctrl+F on your keyboard

This service is currently available for the payment means iDEAL and Sofortüberweisung.

This request initializes a session for a bank transfer. If the initialization step is successful, you will receive in response a secure URL (redirectionUrl) to which the customer should be redirected to continue the bank transfer. This redirection must be made via a POST form, see the part “POST form to external suppliers”.

In the request, you shall also indicate the URL (merchantReturnUrl) to which the customer will be redirected to at the end of the external bank transfer. You must then call the creditTransferrFinalizeAndOrder service to finalize the transaction.

Recommended interfaceVersion: IR_WS_2.55

  • PROD
    https://sherlocks-office-server.secure.lcl.fr/rs-services/v2/checkout/creditTransferInitialize
    method
    POST
  • TEST
    https://office-server-sherlocks.test.sips-services.com/rs-services/v2/checkout/creditTransferInitialize
    method
    POST
  • PROD
    https://sherlocks-office-server.secure.lcl.fr/services/v2/checkout?wsdl
    method
    POST
  • TEST
    https://office-server-sherlocks.test.sips-services.com/services/v2/checkout?wsdl
    method
    POST

Required

  • amount
    presence
    Required
    Interface version
    2.0

    Transaction amount. The amount must be transmitted in the smallest currency unit.For example in euros: an amount of EUR 10.50 must be transmitted in the form 1050.

  • currencyCode
    presence
    Required
    Interface version
    2.0

    Currency code for the transaction. This code is ISO 4217 compatible.

    List of values
    032
    Argentinean Peso
    036
    Australian Dollar
    048
    Bahrain Dinar
    116
    Cambodian Riel
    124
    Canadian Dollar
    144
    Sri Lanka Rupee
    156
    China Yuan Renminbi
    191
    Croatia Kuna
    203
    Czech Republic Koruna
    208
    Danes crown
    344
    Hong Kong dollar
    348
    Hungary Forint
    352
    Iceland Rupee
    356
    Indian rupee
    376
    Israel Shekel
    392
    Japanese Yen
    410
    South Korean Won
    414
    Kuwait Dinar
    458
    Malaysia Ringgit
    480
    Mauritius Rupee
    484
    Mexican Peso
    524
    Nepal Rupee
    554
    New Zealand Dollar
    578
    Norwegian crown
    634
    Qatar Riyal
    643
    Russia Ruble
    682
    Saudi Arabia Riyal
    702
    Singapore Dollar
    710
    South Africa Rand
    752
    Swedish crown
    756
    Swiss Franc
    764
    Thailand Baht
    784
    United Arab Emirates Dirham
    788
    Tunisia Dinar
    826
    Pound
    840
    American Dollar
    901
    Taiwan Dollar
    941
    Serbian Dinar
    946
    Roumania New Leu
    949
    New Turkish Lira
    952
    CFA Franc
    953
    CFP Franc
    975
    Bulgaria Lev
    978
    Euro
    980
    Ukraine Hryvnia
    985
    Poland Zloty
    986
    Brazilian Real
  • 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
    IR_WS_
    Sherlock’s Paypage and Sherlock’s Office (SOAP/JSON) interface.
  • 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 Sherlock’s during the shop registration.

  • orderChannel
    presence
    Required
    Interface version
    2.0

    Order channel used (Internet, Telephone, Post, Fax etc), Internet is the default value.Use of this field should be reconciled with the conditions defined in the acquirer contract.

    List of values
    FAX
    Fax order channel Acquiring contract: MOTO
    INAPP
    Order from a service inside an application (eg mobile) Acquiring contract: INTERNET
    INTERNET
    Internet order channel Acquiring contract: INTERNET
    IVR
    IVR order channel Acquiring contract: MOTO
    MAIL_ORDER
    Mail order channel Acquiring contract: MOTO
    MINITEL
    Obsolete
    MOTO
    Mail order or Telephone order channel without distinction (deprecated, use MAIL_ORDER or TELEPHONE_ORDER) Acquiring contract: MOTO
    PROXI_ATTENDED
    Obsolete
    PROXI_SEMIATTENDED
    Obsolete
    PROXI_UNATTENDED
    Obsolete
    TELEPHONE_ORDER
    Telephone order channel Acquiring contract: MOTO
  • 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
    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
    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
    FRANFINANCE_3X
    Franfinance 3xCB paymentMeanBrandType: ONLINE_CREDIT
    FRANFINANCE_4X
    Franfinance 4xCB paymentMeanBrandType: ONLINE_CREDIT
    GIROPAY
    Giropay 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
    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
    SEPA_DIRECT_DEBIT
    SDD (SEPA Direct Debit) paymentMeanBrandType: DIRECT_DEBIT
    SOFINCO
    Sofinco card paymentMeanBrandType: CARD
    UNKNOWN
    Unknown payment mean (this value can be returned by Sherlock’s 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.

Conditional

Optional

Request sample

            {
  "amount": "1000",
  "currencyCode": "978",
  "customerBankCode": "RABONL2U",
  "customerBankName": "BANK - RABO",
  "customerLanguage": "fr",
  "interfaceVersion": "IR_WS_2.9",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "merchantReturnUrl": "http://www.yoursiteweb.com",
  "merchantTransactionDateTime": "2015-05-28T11:07:11.005+02:00",
  "orderChannel": "INTERNET",
  "orderId": "123",
  "paymentMeanBrand": "IDEAL",
  "transactionReference": " TREFEXA2015",
  "seal": "50e15601a2e83bcc5ffe596a51bab5b8dab2e3c62d3de2fe0d15502600f4aded"
}

        
                  <urn:creditTransferInitialize>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:transactionReference>TREFEXA2015</urn:transactionReference>
            <urn:interfaceVersion>IR_WS_2.9</urn:interfaceVersion>
            <urn:amount>2500</urn:amount> 
            <urn:customerBankCode>RABONL2U</urn:customerBankCode>            
            <urn:customerBankName>BANK - RABO</urn:customerBankName>
            <urn:currencyCode>978</urn:currencyCode>
            <urn:customerId>cust01</urn:customerId>
            <urn:customerIpAddress>127.0.0.1</urn:customerIpAddress>
            <urn:customerLanguage>fr</urn:customerLanguage>
            <urn:orderChannel>INTERNET</urn:orderChannel>
            <urn:orderId>123456</urn:orderId>
            <urn:paymentMeanBrand>IDEAL</urn:paymentMeanBrand>
            <urn:merchantReturnUrl>http://www.yoursiteweb.com</urn:merchantReturnUrl>
         </urn:input>
      </urn:creditTransferInitialize>

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

Response sample

            {
  "responseCode": "00",
  "redirectionUrl": "https://payment-web.test.sips-services.com/paymentprovider/init",
  "redirectionData": "RSs7cZyL1D...a+hZ+1ticHD/4/s\u003d",
  "messageVersion": "0.1",
  "seal": "d0814427cbd5515e78cb54476c8594eb2c1d3732a9b392afd325ebae33945069"
}

        
                  <creditTransferInitializeResponse xmlns="urn:sips:cn:contract:office:checkout:v2">
         <output>
            <responseCode>00</responseCode>
            <redirectionUrl>https://payment-web.test.sips-services.com/paymentprovider/init</redirectionUrl>
            <redirectionData>RSs7cZyL1DqsVs...vceJKsC4lg</redirectionData>
            <messageVersion>0.1</messageVersion>
         </output>
      </creditTransferInitializeResponse>

Changelog


Interface version Data Attendance Container
2.0 billingAddress Request
2.0 addressAdditional3 Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 addressAdditional1 Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 addressAdditional2 Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 city Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 company Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 country Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 postBox Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 state Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 street Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 streetNumber Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 zipCode Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 billingContact Request
    2.0 email Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 firstname Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 gender Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.11 initials Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 lastname Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 mobile Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 phone Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 title Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.23 workphone Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 customerAddress Request
    2.0 customerContact Request
    2.0 customerData Request
    2.0 birthCity Container
  • customerData
    • 2.0 birthCountry Container
  • customerData
    • 2.0 birthZipCode Container
  • customerData
    • 2.0 birthDate Container
  • customerData
    • 2.51 loyaltyIndicator Container
  • customerData
    • 2.18 maidenName Container
  • customerData
    • 2.0 nationalityCountry Container
  • customerData
    • 2.0 newPassword Container
  • customerData
    • 2.0 password Container
  • customerData
    • 2.0 customerId Request
    2.0 customerIpAddress Request
    2.0 customerLanguage Request
    2.0 deliveryAddress Request
    2.0 deliveryContact Request
    2.10 fraudData Request
    2.10 allowedIpCountryList Container
  • fraudData
    • 2.10 deniedIpCountryList Container
  • fraudData
    • 2.10 bypass3DS Container
  • fraudData
    • 2.10 bypassCtrlList Container
  • fraudData
    • 2.10 allowedCardArea Container
  • fraudData
    • 2.10 allowedIpArea Container
  • fraudData
    • 2.10 deniedCardArea Container
  • fraudData
    • 2.10 deniedCardCountryList Container
  • fraudData
    • 2.23 challengeMode3DS Container
  • fraudData
    • 2.10 allowedCardCountryList Container
  • fraudData
    • 2.23 addressDeliveryBillingMatchIndicator Container
  • fraudData
    • 2.10 deniedIpArea Container
  • fraudData
    • 2.10 bypassInfoList Container
  • fraudData
    • 2.39 merchantAuthentScoreValue Container
  • fraudData
    • 2.27 merchantCustomerAuthentData Container
  • fraudData
    • 2.27 merchantCustomerAuthentDateTime Container
  • fraudData
    • 2.23 merchantCustomerAuthentMethod Container
  • fraudData
    • 2.23 nameDeliveryCustomerMatchIndicator Container
  • fraudData
    • 2.27 productAvailabilityDate Container
  • fraudData
    • 2.23 productAvailabilityIndicator Container
  • fraudData
    • 2.23 reorderProductIndicator Container
  • fraudData
    • 2.10 riskManagementDynamicSettingList Container
  • fraudData
    • 2.10 riskManagementDynamicSetting Container
  • riskManagementDynamicSettingList
    • 2.10 riskManagementDynamicParam Container
  • riskManagementDynamicSetting
    • 2.10 riskManagementDynamicValue Container
  • riskManagementDynamicSetting
    • 2.0 holderAddress Request
    2.0 holderContact Request
    2.12 intermediateServiceProviderId Request
    2.0 invoiceReference Request
    2.0 merchantReturnUrl Request
    2.0 merchantTransactionDateTime Request
    2.0 orderId Request
    2.0 paymentPattern Request
    2.0 returnContext Request
    2.0 s10TransactionReference Request
    2.0 s10TransactionId Container
  • s10TransactionReference
    • 2.0 s10TransactionIdDate Container
  • s10TransactionReference
    • 2.12 sealAlgorithm Request
    2.33 settlementArchivingReference Request
    2.33 settlementMerchantSpecificData Request
    2.0 statementReference Request
    2.0 transactionOrigin Request
    2.0 transactionReference Request
    2.0 amount Request
    2.0 currencyCode Request
    2.0 interfaceVersion Request
    2.0 keyVersion Request
    2.0 merchantId Request
    2.0 orderChannel Request
    2.0 paymentMeanBrand Request
    2.0 seal Request/Response
    2.0 customerBankCode Request
    2.0 customerBankName Request
    2.0 errorFieldName Response
    2.0 messageVersion Response
    2.0 redirectionData Response
    2.0 redirectionUrl Response
    2.0 responseCode Response
    Back to top Need help?

    This site uses trackers to improve your experience, perform analysis and researches on your use of Sherlock's documentation website.
    You have several options:
    Closing this banner you refuse the use of trackers on your device.

    Configuration