WL SIPS DOCS

Release 24.6

go directly to content

Search by keywords

directDebitOrder

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

This function allows you, if you have the bank information of a customer, to make payments by direct debit (e.g. SDD).

Recommended interfaceVersion: IR_WS_2.55

  • PROD
    https://office-server.sips-services.com/rs-services/v2/checkout/directDebitOrder
    method
    POST
  • TEST
    https://office-server.test.sips-services.com/rs-services/v2/checkout/directDebitOrder
    method
    POST
  • PROD
    https://office-server.sips-services.com/services/v2/checkout?wsdl
    method
    POST
  • TEST
    https://office-server.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_
    Sips Paypage and Sips 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 Worldline Sips 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 Worldline Sips 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": "2500",
  "captureDay": "0",
  "captureMode": "AUTHOR_CAPTURE",
  "cardCSCValue": "0000",
  "currencyCode": "978",
  "customerBankAccountType": "BIC_IBAN",
  "interfaceVersion": " IR_WS_2.3",
  "keyVersion": "1",
  "mandateId": "000000000000001999",
  "merchantId": "011223344550000",
  "orderChannel": "INTERNET",
  "orderId": " ORD101",
  "paymentMeanBrand": "SEPA_DIRECT_DEBIT",
  "returnContext": "ReturnContext",
  "transactionOrigin": " SO_WEBAPPLI",
  "transactionReference": "TREFEXA2012",
  "seal": "2205f0636dc500c4f3ef536075895b8baba3a60c7087e06cd9d330c50a50c53e"
}

        
                  <urn:directDebitOrder>
         <urn:input>
            <urn:amount>2500</urn:amount>
            <urn:captureDay>0</urn:captureDay>
            <urn:captureMode>AUTHOR_CAPTURE</urn:captureMode>
            <urn:currencyCode>978</urn:currencyCode>
            <urn:customerIpAddress>127.0.0.1</urn:customerIpAddress>
          + <urn:fraudData>
            </urn:fraudData>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:orderChannel>INTERNET</urn:orderChannel>
            <urn:orderId>ORD101</urn:orderId>
            <urn:interfaceVersion >IR_WS_2.2</urn:interfaceVersion >
            <urn:returnContext>ReturnContext</urn:returnContext>
            <urn:transactionReference>TREFEXA2012</urn:transactionReference>
            <urn:transactionOrigin>SO_WEBAPPLI</urn:transactionOrigin>
            <urn:paymentMeanBrand >SEPA_DIRECT_DEBIT</urn:paymentMeanBrand >
          + <urn:billingAddress>
            </urn:billingAddress>
          + <urn:billingContact>
            </urn:billingContact>
          + <urn:customerAddress>
            </urn:customerAddress>
          + <urn:customerContact>
            </urn:customerContact>
          + <urn:deliveryAddress>
            </urn:deliveryAddress>
          + <urn:deliveryContact>
            </urn:deliveryContact>
          + <urn:holderAddress>
            </urn:holderAddress>
          + <urn:holderContact>
            </urn:holderContact>
          + <urn:customerData>
            </urn:customerData>
            <urn:paymentMeanData>
               <urn:sdd>
                  <urn:mandateAuthentMethod>SMS_OTP</urn:mandateAuthentMethod>
                  <urn:mandateUsage>ONE_OFF</urn:mandateUsage>
                  <urn:mandateId>000000000000000283</urn:mandateId>
               </urn:sdd>
            </urn:paymentMeanData>
         </urn:input>
      </urn:directDebitOrder>

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

  • acquirerResponseCode
    presence
    Optional
    Interface version
    2.0

    Response code returned by the acquirer during an authorisation request.

    List of values
    00
    Transaction approved or processed successfully
    02
    Contact payment mean issuer
    03
    Invalid acceptor
    04
    Keep the payment mean
    05
    Do not honour
    07
    Keep the payment mean, special conditions
    08
    Approve after identification
    12
    Invalid transaction
    13
    Invalid amount
    14
    Invalid PAN
    15
    Unknown payment mean issuer
    17
    Payment aborted by the buyer
    20
    Invalid response (error in server domain)
    24
    Operation not authorised
    25
    Transaction not found
    30
    Format error
    31
    Id of the acquiring organisation unknown
    33
    payment mean expired (Paypal / Cofidis)
    34
    Fraud suspicion
    40
    Function not supported
    41
    Payment mean lost
    43
    Payment mean stolen
    51
    Insufficient or exceeded credit
    54
    Payment mean expired (CB / Visa / MC / WLAcq / BCMC)
    55
    Wrong PIN
    56
    Payment mean missing from the file
    57
    Transaction unauthorised for this payment mean holder
    58
    Transaction forbidden to the terminal
    59
    Fraud suspicion
    60
    The payment mean acceptor must contact the acquirer
    61
    Exceeds the amount limit
    62
    Transaction awaiting payment confirmation
    63
    Security rules not complied with
    65
    Allowed number of daily transactions has been exceeded
    68
    Response not received or received too late
    75
    Exceeded number of PAN attempts
    87
    Terminal unknown
    90
    System temporarily stopped
    91
    Payment mean issuer inaccessible
    92
    The transaction does not contain enough information to be routed to the authorizing agency
    93
    Transaction cannot be completed: violation of law
    94
    Duplicated transaction
    96
    System malfunction
    97
    Request time-out; transaction refused
    98
    Server unavailable; network routing requested again
    99
    Incident with initiator domain
    A1
    Transaction refused because the 3-D Secure authentication data is missing
    A4
    Transaction refused because the 3-D Secure authentication exemption is misused
    R1
    the cardholder (or his bank) has revoked recurring payments made at a merchant
    R3
    the cardholder (or his bank) has revoked all recurring payments
  • authorisationId
    presence
    Optional
    Interface version
    2.0

    Authorisation ID returned by the acquirer if the authorisation request is accepted.

  • captureDay
    presence
    Optional
    Interface version
    2.15

    Deadline for settlement.

  • captureLimitDate
    presence
    Optional
    Interface version
    2.0

    Date from which the transaction will be sent for settlement. Beyond this date, the merchant can no longer validate or cancel the transaction.

  • captureLimitDateTime
    presence
    Optional
    Interface version
    2.35

    Date and time from which the transaction will be sent for settlement. Beyond this date, the merchant can no longer validate or cancel the transaction.

  • captureMode
    presence
    Optional
    Interface version
    2.15

    Payment collection method for the transaction.

    List of values
    AUTHOR_CAPTURE
    Cancellation mode: automatic authorisation and payment collection (default value)
    AUTHOR_NOCAPTURE
    Value only for response purpose
    IMMEDIATE
    Immediate mode: online payment collection at the time of the authorisation request (available for a restricted list of payment methods)
    VALIDATION
    Validation mode: payment collection following validation of the merchant
  • complementaryCode
    presence
    Optional
    Interface version
    2.0

    Additional response code from the Worldline Sips server returned in the response. This field is only filled out if you have signed up for additional checks for the Worldline Sips e-payment solution.

    List of values
    00
    All controls that you adhered to have been successfully completed Fraud Rule: All
    02
    The card used has exceeded the authorised balance limit Fraud Rule: Card Velocity
    03
    The card used is on the merchant’s “grey list” Fraud Rule: Card number grey list
    04
    Deprecated value. The postal code used is on the merchant’s “grey list” Fraud Rule: Postal code grey list
    05
    Deprecated value. The BIN of the card used belongs to a range which is not referenced on Worldline Sips platform BIN table Fraud Rule: Card country / Commercial card (and card country)
    06
    The country code related to the card number is not on the list of countries allowed by the merchant Fraud Rule: Card country
    07
    Virtual card (e-card) detected Fraud Rule: Virtual card
    08
    The card BIN is present in a range on the merchant’s “grey list” Fraud Rule: BIN range grey list
    09
    Deprecated value. Unknown country IP Fraud Rule: IP address country
    10
    Denied country IP Fraud Rule: IP address country
    11
    Card in hot/black list Fraud Rule: Hot list
    12
    Country card / IP address country combination denied Fraud Rule: IP and card country
    13
    Deprecated value. Unknown country IP or card. The country code cannot be determined from the card number Fraud Rule: Combination of card and IP address country
    14
    Systematic authorisation card Fraud Rule: Systematic authorisation card
    15
    Deprecated value. Unknown BIN (on control of systematic authorisation card) Fraud Rule: Systematic authorisation card
    16
    IP address in progress exceeded Fraud Rule: IP address velocity
    17
    Blocking related the status of the 3-D Secure authentication process Fraud Rule: 3-D Secure authentication
    18
    The card number is a commercial card number Fraud Rule: Commercial card
    19
    The card number is not part of the CB scheme Fraud Rule: CB scheme card
    20
    Customer ID in progress exceeded Fraud Rule: Customer ID velocity
    21
    Maximum number of customer ID per card exceeded Fraud Rule: Number of customers per card
    22
    Maximum number of cards per customer ID exceeded Fraud Rule: Number of cards per customer
    23
    The card is going to expire Fraud Rule: Card expiry date
    24
    For futur use
    25
    The amount violates one of the defined boundaries Fraud Rule: Cap collar Amounts
    26
    Delivery postal code and billing postal code are different Fraud Rule: Delivery and billing postal code
    27
    At least one of email addresses provided is contained in a list of suspicious domain names Fraud Rule: Free e-mail address
    28
    Customer identifier is on the merchant’s “black list” Fraud Rule: Customer ID black list
    29
    Customer identifier is on the merchant’s “grey list” Fraud Rule: Customer ID grey list
    30
    Delivery country and billing country are different Fraud Rule: Delivery and billing country
    31
    At least one of email addresses provided is on the merchant’s “black list” Fraud Rule: E-mail address black list
    32
    At least one of email addresses provided is on the merchant’s “grey list” Fraud Rule: E-mail address grey list
    33
    At least one of phone number provided is on the merchant’s “black list” Fraud Rule: Phone number black list
    34
    At least one of phone number provided is on the merchant’s “grey list” Fraud Rule: Phone number grey list
    35
    At least one of contact name provided is on the merchant’s “black list” Fraud Rule: Customer name black list
    36
    At least one of contact name provided is on the merchant’s “grey list” Fraud Rule: Customer name grey list
    37
    Buyer’s IP address is on the merchant’s “black list” Fraud Rule: IP address black list
    38
    Buyer’s IP address is on the merchant’s “grey list” Fraud Rule: IP address grey list
    39
    The country / postal code combination is on the merchant’s “black list” Fraud Rule: Postal code black list
    3L
    Reason of the refusal of the transaction which is the transaction is not guaranteed by any entity (acquirer, wallet provider, etc.) Fraud Rule: Authent guarantee
    40
    The country / postal code combination is on the merchant’s “grey list” Fraud Rule: Postal code grey list
    41
    The card BIN is present in a range on the merchant’s “black list” Fraud Rule: BIN range black list
    42
    Card country / delivery country combination denied Fraud Rule: Delivery and card country
    43
    The card number is a commercial card number and the issuing country is not associated to a country accepted by the merchant Fraud Rule: Commercial card (and card country)
    44
    IP address of the buyer denied Fraud Rule: IP address reputations
    45
    Number of different cards allowed for a given IP address. Fraud Rule: Number of cards per IP address
    46
    The email address format provided is incorrect Fraud Rule: E-mail address syntax
    47
    Card country / billing country combination denied Fraud Rule: Billing and card country
    50
    The card used is on the merchant’s “black list” Fraud Rule: Card number black list
    51
    At least one product in the basket is on a risky product list Fraud Rule: Risky product list
    52
    The quantity of risky products in the basket exceeds the allowed quantity Fraud Rule: Risky product quantity
    53
    The ration of risky products/total amount of the basket exceeds the allowed ratio Fraud Rule: Risky product ratio
    54
    The quantity of products in the basket exceeds the allowed quantity Fraud Rule: Product quantity
    55
    Simple mode: the IBAN country code is not allowed. Advanced mode: the IBAN country is disadvantaged or advantaged. Fraud Rule: IBAN country
    56
    Simple mode: the delivery country and IBAN country combination is not allowed. Advanced mode: the delivery country and IBAN country combination is disadvantaged or advantaged. Fraud Rule: Delivery and IBAN country
    57
    Simple mode: the phone number country and IBAN country combination is not allowed. Advanced mode: the phone number country and IBAN country combination is disadvantaged or advantaged. Fraud Rule: Phone number and IBAN country
    58
    Simple mode: the IP country and IBAN country combination is not allowed. Advanced mode: the IP country and IBAN country combination is disadvantaged or advantaged. Fraud Rule: IP address and IBAN country
    59
    The number of IBANs per IP address exceeds the allowed threshold. Fraud Rule: Number of IBANs per IP address
    60
    The number of IP addresses per IBAN exceeds the allowed threshold. Fraud Rule: Number of IP addresses per IBAN
    61
    The number of different customers per IBAN exceeds the allowed threshold. Fraud Rule: Number of customers per IBAN
    62
    The number of different IBANs per customer exceeds the allowed threshold. Fraud Rule: Number of IBANs per customer
    63
    The number of mandates per IP address exceeds the allowed threshold. Fraud Rule: Number of mandates per IP address
    64
    Too many transactions/Excessive amount spent for the mandate used. Fraud Rule: Mandate velocity
    65
    Too many transactions/Excessive amount spent for the IBAN used. Fraud Rule: IBAN velocity
    66
    The BIC is in your “blacklist”. Fraud Rule: BIC blacklist
    67
    The BIC is in the your “greylist”. Fraud Rule: BIC greylist
    68
    The IBAN is in your “blacklist”. Fraud Rule: IBAN blacklist
    69
    The IBAN is in your “greylist”. Fraud Rule: IBAN greylist
    70
    The mandate is in your “blacklist”. Fraud Rule: Mandate blacklist
    71
    The mandate is in your “greylist”. Fraud Rule: Mandate greylist
    72
    Prepaid carte detected Fraud rule: Prepaid card
    73
    Invalid issuer country. Fraud rule: Card issuing country
    74
    Invalid billing and card issuing country combinaison. Fraud rule: Card issuing and billing country
    75
    Invalid shipping and card issuing country combinaison. Fraud rule: Card issuing and delivery country
    76
    Invalid ip card and issuing country combinaison. Fraud rule: Card issuing and IP country
    77
    Commercial card with invalid issuing country. Fraud rule: Commercial card (and card issuing country)
    99
    the Worldline Sips server encountered a problem during the processing of one of the additional local checks Fraud Rule: All
    AA
    Card number is on the merchant’s “white list” Fraud Rule: Card number white list
    AB
    Customer identifier is on the merchant’s “white list” Fraud Rule: Customer ID white list
    AC
    At least one of email addresses provided is on the merchant’s “white list” Fraud Rule: E-mail address white list
    AD
    At least one of phone number provided is on the merchant’s “white list” Fraud Rule: Phone number white list
    AE
    Buyer’s IP address is on the merchant’s “white list” Fraud Rule: IP address white list
    AF
    At least one of contact name provided is on the merchant’s “white list” Fraud Rule: Customer name white list
    AG
    The country / postal code combination is on the merchant’s “white list” Fraud Rule: Postal code white list
    AH
    The card BIN is present in a range on the merchant’s “white list” Fraud Rule: BIN Range white list
    AI
    The BIC is on your “whitelist” Fraud Rule: BIC whitelist
    AJ
    The customer’s BIC is on your “whitelist” Fraud Rule: IBAN whitelist
    AK
    The customer’s SDD mandate is on your “whitelist” Fraud Rule: Mandate whitelist
    Empty
    No control performed Fraud Rule: No rules
  • complementaryInfo
    presence
    Optional
    Interface version
    2.0

    Additional information from the Worldline Sips server sent back in the response.

  • creditorId
    presence
    Optional
    Interface version
    2.5

    Unique identifier of the creditor. For SEPA, the Creditor Identifier (CI) is required to send Direct Debit instructions.

  • errorFieldName
    presence
    Optional
    Interface version
    2.5

    Error field name of the incoming request. Present when responseCode = 12 or 30.

  • guaranteeIndicator
    presence
    Optional
    Interface version
    2.0

    Transaction’s guarantee level.

    List of values
    E
    Eligible to the guarantee (applicable for payments delivered upon shipping and in several shipments with CB) Method Payment: 3-D Secure card
    Empty
    The guarantee has not been calculated Method Payment: Card
    N
    The guarantee is not applicable Method Payment: 3-D Secure card
    U
    The guarantee is not defined Method Payment: 3-D Secure card
    Y
    The guarantee is applicable Method Payment: 3-D Secure card
  • holderAuthentRelegationCode
    presence
    Optional
    Interface version
    2.0

    Code indicating whether the issuer accepts or refuses the transfer of responsibility.

    List of values
    N
    Transfer of responsibility accepted
    Y
    Transfer of responsibility refused
  • holderAuthentStatus
    presence
    Optional
    Interface version
    2.0

    Result of the authentication process.

    List of values
    3D_ABORT
    The buyer has abandoned the transaction during the process of authentication. Currently, this status is only possible in the case of a PAYLIB payment.
    3D_ATTEMPT
    The merchant and the cardholder are both enrolled in the authentication programme, but the buyer did not have to be authenticated (the server access control of the bank that issued the card, only implements the generation of an authentication attempt proof). This case can also occur when the DS replies instead of the ACS when the ACS is unavailable.
    3D_BYPASS
    According to certain criteria set by the merchant, the authentication programme checks were bypassed.
    3D_ERROR
    The merchant participates in the authentication programme but the Worldline Sips server encountered a technical problem during the authentication process (when checking the registration card to the authentication programme or during authentication of the holder).
    3D_FAILURE
    The merchant and the cardholder are both enrolled in the authentication programme, but the buyer failed to authenticate (wrong password).
    3D_NOTENROLLED
    The merchant participates in the authentication programme, but the cardholder’s card is not enrolled.
    3D_SUCCESS
    The merchant and the cardholder are both enrolled in the authentication programme and the cardholder has successfully authenticated.
    ATTEMPT
    The merchant and the cardholder are both enrolled in the authentication programme, but the buyer did not have to be authenticated (the server access control of the bank that issued the card, only implements the generation of an authentication attempt proof). This case can also occur when the DS replies instead of the ACS when the ACS is unavailable.
    BYPASS
    According to certain criteria set by the merchant, the authentication programme checks were bypassed.
    CANCEL
    The buyer has abandoned the transaction during the process of authentication. Currently, this status is only possible in the case of a PAYLIB payment.
    ERROR
    The merchant participates in the authentication programme but the Worldline Sips server encountered a technical problem during the authentication process (when checking the registration card to the authentication programme or during authentication of the holder).
    FAILURE
    The merchant and the cardholder are both enrolled in the authentication programme, but the buyer failed to authenticate (wrong password).
    NOT_ENROLLED
    The merchant participates in the authentication programme, but the cardholder’s card is not enrolled.
    NOT_PARTICIPATING
    The buyer has not authenticated to one of the following reasons: - the type of card is not supported by the authentication programm - the merchant is not enrolled in the authentication programm
    NOT_SPECIFIED
    The status of the holder authentication is not available.
    NO_AUTHENT
    According to certain criteria set by the merchant, the authentication programme checks were bypassed
    NO_AUTHENT_DTA
    According to certain criteria set by the merchant, the authentication programme checks were bypassed using Direct to Authorize
    SSL
    According to certain criteria set by the merchant, the authentication programme checks were bypassed
    SUCCESS
    The merchant and the cardholder are both enrolled in the authentication programme and the cardholder has successfully authenticated.
  • mandateId
    presence
    Optional
    Interface version
    2.5

    Mandate number.

  • 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.

  • orderId
    presence
    Optional
    Interface version
    2.24

    Order number associated with the payment transaction.

    Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data

    As a subcontractor, Worldline processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.

    Thus:

    • The personal data specified in the DPA must only be transmitted to Worldline via the fields provided for this purpose (see data dictionary).
    • All other personal data not listed in the DPA must not be transmitted to Worldline.
  • preAuthorisationProfile
    presence
    Optional
    Interface version
    2.13

    Name of the applied pre-authorisation profile.

  • preAuthorisationProfileValue
    presence
    Optional
    Interface version
    2.13

    Unique identifier of the antifraud profile applied for a transaction in pre-authorisation step. Contrary to the profile name, the unique identifier takes into account the dynamic override and the bypassing of the antifraud rules. This identifier allows to retrieve all executed antifraud rules of a transaction and their setup and could be used in case of dispute.

  • preAuthorisationRuleResultList
    presence
    Optional
    Interface version
    2.13

    List containing the result of each executed antifraud rules in pre-authorisation step.

    Contains
  • responseCode
    presence
    Optional
    Interface version
    2.0

    Worldline Sips server response code.

    List of values
    00
    Operation accepted
    01
    For panToToken and tokenToPan methods, partial success
    02
    Request of authorized on via telephone with the issuer because of exceeding the card authorization threshold
    03
    Invalid merchant contract
    05
    Refused authorization
    11
    Used for differed check. The PAN is blocked
    12
    Invalid transaction. Please check the request parameters
    14
    Invalid PAN or payment mean data check is failed (e.g. card number or the visual cryptogram of the card or AVS address)
    17
    Customer cancellation
    24
    • In response to a cash management operation: operation not authorized. The operation you wish to perform is not compliant with the transaction status or another operation is in progress at the same time
    • In response to a payment creation: operation rejected, request already carried out with the same data and the same parameters
    25
    Transaction unknown by Worldline Sips
    30
    Format error
    34
    Fraud suspicion (seal erroneous)
    40
    Function not supported: the operation that you wish to perform is not part of the operation type for which you are authorized
    51
    Amount too high
    54
    Payment mean expiry date is past
    55
    Merchant doesn’t accept prepaid cards
    57
    Refund operation refused because the original transaction was subject of an unpaid
    60
    Transaction pending
    62
    Waiting the confirmation for the transaction (used by PayPal 1.0)
    63
    Security rules not observed, transaction stopped
    75
    Number of attempts to enter the data of the payment mean from Sips Paypage is exceeded
    90
    Service temporarily not available
    94
    Duplicated transaction: the transactionReference has been used previously
    97
    Session expired (no action from the user during 15 minutes), transaction refused
    99
    Temporarily problem with the payment server
  • s10TransactionReference
    presence
    Optional
    Interface version
    2.6

    Contains the identification of the transaction (to be compliant with Worldline Sips 1.0).Contains the data pair (s10TransactionId, s10TransactionIdDAte) which ensures the uniqueness of the transaction 1.0.

    Contains
  • scoreColor
    presence
    Optional
    Interface version
    2.0

    Colour associated with the score. Used to give a comparison between the antifraud rules applied on a payment request.The Business Score module assigns a score to each transaction qohich indicates the degree of risk you take if you accept the transaction. A color is also associated with this score through the scoreColor field.

    List of values
    BLACK
    Score color black
    Empty
    No check
    GREEN
    Score color green
    ORANGE
    Score color orange
    RED
    Score color red
    WHITE
    Score color white
  • scoreInfo
    presence
    Optional
    Interface version
    2.0

    Return of the antifraud rule applied after the score is calculated, or ERROR if an error is generated during the check sequence.The Business Score module assigns a score to each transaction qohich indicates the degree of risk you take if you accept the transaction. A color is also associated with this score through the scoreColor field.

  • scoreProfile
    presence
    Optional
    Interface version
    2.0

    Name associated with the profile used to calculate the transaction score.The Business Score module assigns a score to each transaction qohich indicates the degree of risk you take if you accept the transaction. A color is also associated with this score through the scoreColor field.

  • scoreThreshold
    presence
    Optional
    Interface version
    2.0

    Thresholds to determine the risk level of a transaction in pre-authorisation step.The Business Score module assigns a score to each transaction qohich indicates the degree of risk you take if you accept the transaction. A color is also associated with this score through the scoreColor field.

  • scoreValue
    presence
    Optional
    Interface version
    2.0

    Relative number representing the transaction score. Value of the score Pre-authorization computed by the Fraud engine in Business Score mode.

  • secureReference
    presence
    Optional
    Interface version
    2.26

    as parto of SDD option Safe Debit, reference of the secure transaction returned by the SSP (Score & Secure Payment).

  • 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
  • transactionDateTime
    presence
    Optional
    Interface version
    2.0

    Date and time the transaction was processed on the Worldline Sips server. (expressed in the Worldline Sips server time zone)

  • transactionPlatform
    presence
    Optional
    Interface version
    2.17

    Platform where the transaction has been executed.

    List of values
    PRE-PROD
    Pre-production transaction not sent to remittance
    PROD
    Production transaction
    SIMU
    Simulated transaction
    UAT
    User acceptance test transaction
  • transactionReference
    presence
    Optional
    Interface version
    2.6

    The merchant can choose of referencing his transactions by a transactionId or a transactionReference.transactionReference uniquely identifies a transaction throughout the life of the shop.

  • valueDate
    presence
    Optional
    Interface version
    2.5

    Payment value date

Response sample

            {
  "acquirerResponseCode": "00",
  "authorisationId": "123456789102",
  "maskedPan": "5219##########00",
  "responseCode": "00",
  "transactionDateTime": "2012-10-16T23:50:44-12:00",
  "captureLimitDate": "2012-11-16T23:50:44-12:00",
  "transactionActors": "BTOB",
  "seal": "7ca065ebba90762e3286ee16d6a2d2da0eea8bae6b46592058933881d96d0c3d",
  "transactionPlatform": "PROD"
}

        
                  <directDebitOrderResponse xmlns="urn:sips:cn:contract:office:checkout:v2">
         <output>
            <acquirerResponseCode>00</acquirerResponseCode>
            <authorisationId>123456789102</authorisationId>
            <maskedPan>5219##########00</maskedPan>
            <responseCode>00</responseCode>
            <scoreColor/>
            <scoreInfo/>
            <scoreProfile/>
            <scoreThreshold/>
            <scoreValue/>
            <guaranteeIndicator/>
            <holderAuthentRelegationCode/>
            <holderAuthentStatus/>
            <transactionDateTime>2012-10-16T23:50:44-12:00</transactionDateTime>
            <captureLimitDate>2012-11-16T23:50:44-12:00</captureLimitDate>
            <transactionActors>BTOB</transactionActors>
            <transactionPlatform>PROD</transactionPlatform>
         </output>
      </directDebitOrderResponse>

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 captureDay Request/Response
    2.0 captureMode Request/Response
    2.0 creditorId Request/Response
    2.5 customerAccount Request
    2.0 customerAddress Request
    2.5 customerBankAccountType Request
    2.5 customerBankCode 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 deliveryAddress Request
    2.0 deliveryContact Request
    2.0 fraudData Request
    2.0 allowedIpCountryList Container
  • fraudData
    • 2.0 deniedIpCountryList Container
  • fraudData
    • 2.0 bypass3DS Container
  • fraudData
    • 2.0 bypassCtrlList Container
  • fraudData
    • 2.0 allowedCardArea Container
  • fraudData
    • 2.0 allowedIpArea Container
  • fraudData
    • 2.0 deniedCardArea Container
  • fraudData
    • 2.0 deniedCardCountryList Container
  • fraudData
    • 2.23 challengeMode3DS Container
  • fraudData
    • 2.0 allowedCardCountryList Container
  • fraudData
    • 2.23 addressDeliveryBillingMatchIndicator Container
  • fraudData
    • 2.0 deniedIpArea Container
  • fraudData
    • 2.0 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.0 riskManagementDynamicSettingList Container
  • fraudData
    • 2.0 riskManagementDynamicSetting Container
  • riskManagementDynamicSettingList
    • 2.0 riskManagementDynamicParam Container
  • riskManagementDynamicSetting
    • 2.0 riskManagementDynamicValue Container
  • riskManagementDynamicSetting
    • 2.0 holderAddress Request
    2.0 holderContact Request
    2.0 instalmentData Request
    2.0 datesList Container
  • instalmentData
    • 2.0 amountsList Container
  • instalmentData
    • 2.0 number Container
  • instalmentData
    • 2.6 s10TransactionIdsList Container
  • instalmentData
    • 2.0 transactionReferencesList Container
  • instalmentData
    • 2.12 intermediateServiceProviderId Request
    2.0 invoiceReference Request
    2.0 mandateAuthentMethod Request
    2.0 mandateUsage Request
    2.0 merchantTransactionDateTime Request
    2.0 orderId Request/Response
    2.0 returnContext Request
    2.8 riskManagementCustomData Request
    2.8 riskManagementCustomSequence Container
  • riskManagementCustomData
    • 2.8 riskManagementCustomValue Container
  • riskManagementCustomData
    • 2.8 riskManagementCustomDataList Request
    2.6 s10TransactionReference Request/Response
    2.6 s10TransactionId Container
  • s10TransactionReference
    • 2.6 s10TransactionIdDate Container
  • s10TransactionReference
    • 2.12 sealAlgorithm Request
    2.33 settlementArchivingReference Request
    2.33 settlementMerchantSpecificData Request
    2.8 shoppingCartDetail Request
    2.27 giftCardAmount Container
  • shoppingCartDetail
    • 2.27 giftCardCurrencyCode Container
  • shoppingCartDetail
    • 2.8 mainProduct Container
  • shoppingCartDetail
    • 2.27 giftCardCount Container
  • shoppingCartDetail
    • 2.8 shoppingCartItemList Container
  • shoppingCartDetail
    • 2.8 shoppingCartItem Container
  • shoppingCartItemList
    • 2.8 productName Container
  • shoppingCartItem
    • 2.8 productUnitTaxAmount Container
  • shoppingCartItem
    • 2.8 productDescription Container
  • shoppingCartItem
    • 2.8 productSKU Container
  • shoppingCartItem
    • 2.8 productQuantity Container
  • shoppingCartItem
    • 2.8 productTaxRate Container
  • shoppingCartItem
    • 2.8 productUnitAmount Container
  • shoppingCartItem
    • 2.8 productCode Container
  • shoppingCartItem
    • 2.8 productCategory Container
  • shoppingCartItem
    • 2.8 productTaxCategory Container
  • shoppingCartItem
    • 2.38 travelData Container
  • shoppingCartItem
    • 2.38 travelCardPeriod Container
  • travelData
    • 2.38 journeyDataList Container
  • travelData
    • 2.38 journeyData Container
  • journeyDataList
    • 2.41 journeyAmount Container
  • journeyData
    • 2.38 carrierIdentifier Container
  • journeyData
    • 2.38 classLevel Container
  • journeyData
    • 2.38 departureDateTime Container
  • journeyData
    • 2.38 arrivalLocation Container
  • journeyData
    • 2.38 destinationCountry Container
  • journeyData
    • 2.38 fareBasis Container
  • journeyData
    • 2.38 carrierName Container
  • journeyData
    • 2.38 journeyCancellableIndicator Container
  • journeyData
    • 2.38 departureLocation Container
  • journeyData
    • 2.38 journeyInsurance Container
  • journeyData
    • 2.38 journeyInsuranceIndicator Container
  • journeyData
    • 2.38 journeyModality Container
  • journeyData
    • 2.38 journeyMode Container
  • journeyData
    • 2.41 journeyNature Container
  • journeyData
    • 2.38 journeySequence Container
  • journeyData
    • 2.38 journeyStage Container
  • journeyData
    • 2.38 luggageSupplementIndicator Container
  • journeyData
    • 2.38 numberOfTickets Container
  • journeyData
    • 2.38 ticketExchangeabilityIndicator Container
  • journeyData
    • 2.38 ticketIssueCity Container
  • journeyData
    • 2.38 ticketIssueDate Container
  • journeyData
    • 2.38 ticketIssuerName Container
  • journeyData
    • 2.38 ticketReference Container
  • journeyData
    • 2.38 stayDataList Container
  • travelData
    • 2.38 stayData Container
  • stayDataList
    • 2.38 stayCategory Container
  • stayData
    • 2.38 numberOfNights Container
  • stayData
    • 2.38 stayCompany Container
  • stayData
    • 2.38 stayArrivalDateTime Container
  • stayData
    • 2.38 numberOfPeopleStaying Container
  • stayData
    • 2.38 roomServiceLevel Container
  • stayData
    • 2.38 stayDepartureDateTime Container
  • stayData
    • 2.38 stayInsurance Container
  • stayData
    • 2.38 stayInsuranceIndicator Container
  • stayData
    • 2.38 stayLocation Container
  • stayData
    • 2.38 stayNumberOfRooms Container
  • stayData
    • 2.38 stayRentalCarIndicator Container
  • stayData
    • 2.38 passportDataList Container
  • travelData
    • 2.38 passportData Container
  • passportDataList
    • 2.38 passportExpirationDate Container
  • passportData
    • 2.38 passportIssueCountry Container
  • passportData
    • 2.46 mainTravelerFirstName Container
  • travelData
    • 2.38 travelCardType Container
  • travelData
    • 2.41 bookingData Container
  • travelData
    • 2.41 bookerFirstName Container
  • bookingData
    • 2.41 bookerLastName Container
  • bookingData
    • 2.41 bookingId Container
  • bookingData
    • 2.41 bookingPlatform Container
  • bookingData
    • 2.41 bookingPlatformOrderId Container
  • bookingData
    • 2.46 mainTravelerLastName Container
  • travelData
    • 2.38 numberOfTravelers Container
  • travelData
    • 2.38 travelEndDateTime Container
  • travelData
    • 2.38 travelingPayerIndicator Container
  • travelData
    • 2.38 travelReason Container
  • travelData
    • 2.38 travelStartDateTime Container
  • travelData
    • 2.8 shoppingCartTotalAmount Container
  • shoppingCartDetail
    • 2.8 shoppingCartTotalQuantity Container
  • shoppingCartDetail
    • 2.8 shoppingCartTotalTaxAmount Container
  • shoppingCartDetail
    • 2.0 statementReference Request
    2.0 transactionOrigin Request
    2.0 transactionReference Request/Response
    2.0 valueDate Request/Response
    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 mandateId Request/Response
    2.0 paymentPattern Request
    2.0 acquirerResponseCode Response
    2.0 authorisationId Response
    2.0 captureLimitDate Response
    2.35 captureLimitDateTime Response
    2.0 complementaryCode Response
    2.0 complementaryInfo Response
    2.5 errorFieldName Response
    2.0 guaranteeIndicator Response
    2.0 holderAuthentRelegationCode Response
    2.0 holderAuthentStatus Response
    2.0 maskedPan Response
    2.13 preAuthorisationProfile Response
    2.13 preAuthorisationProfileValue Response
    2.13 preAuthorisationRuleResultList Response
    2.13 ruleResult Container
  • preAuthorisationRuleResultList
    • 2.13 ruleCode Container
  • ruleResult
    • 2.13 ruleDetailedInfo Container
  • ruleResult
    • 2.13 ruleResultIndicator Container
  • ruleResult
    • 2.13 ruleSetting Container
  • ruleResult
    • 2.13 ruleType Container
  • ruleResult
    • 2.13 ruleWeight Container
  • ruleResult
    • 2.0 responseCode Response
    2.0 scoreColor Response
    2.0 scoreInfo Response
    2.0 scoreProfile Response
    2.0 scoreThreshold Response
    2.0 scoreValue Response
    2.26 secureReference Response
    2.0 transactionActors Response
    2.0 transactionDateTime Response
    2.17 transactionPlatform Response
    Back to top Need help?

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

    Configuration