WL SIPS DOCS

Release 24.1

go directly to content

Search by keywords

walletOrder (batch)

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

This function allows to create a payment with a card enrolled in “Worldline Sips wallet.”

Required

Optional

Request sample

            FILE;request;office;v19
HEADER;023101122334455;2021-12-16+0100;14:26:45+0100;1
WALLETORDER;13;023101122334456;SIM20220329092501;66;8;AUTHOR_CAPTURE;978;customer@email.com;customerId;128.0.0.1;2022-03-29T09:30:16+02:00;INTERNET;orderId;paymentMeanId;returnContext;statementReference;w01;origin;987;ONE_SHOT;Y;ctrl1;info1;USA;POR;ITA;SPA;BRA;FIN;GER;CHI;101;20210329;initialSchemeTransactionIdentifier;VISA;settlementArchivingReference;settlementMerchantSpecificData;paymentMeanBrandSelectionStatus;merchantAuthentMethod;023101122334457;subMerchantCategoryCode;subMerchantLegalId;subMerchantName;Paris;FRA;Rue de la Rgent;4;75000;additional1;additional2;additional3;postbox;IleDeFrance;subMerchantUrl.com
END;1

        
            <?xml version="1.0" encoding="UTF-8"?>
<file format="office" type="request" version="5">
	<header>
		<remitterId>023101122334455</remitterId>
		<date>2018-07-25+02:00</date>
		<time>09:00:00+01:00</time>
		<sequence>1</sequence>
	</header>
	<body>
		<walletOrder recordSequence="1">
            <merchantId>023101122334456</merchantId>
            <transactionReference>SIM20220329092501</transactionReference>
            <amount>66</amount>
            <captureDay>8</captureDay>
            <captureMode>AUTHOR_CAPTURE</captureMode>
            <currencyCode>978</currencyCode>
            <customerEmail>customer@email.com</customerEmail>
            <customerId>customerId</customerId>
            <customerIpAddress>128.0.0.1</customerIpAddress>
            <merchantTransactionDateTime>2022-03-29T09:30:16+02:00</merchantTransactionDateTime>
            <orderChannel>INTERNET</orderChannel>
            <orderId>orderId</orderId>
            <paymentMeanId>paymentMeanId</paymentMeanId>
            <returnContext>returnContext</returnContext>
            <statementReference>statementReference</statementReference>
            <merchantWalletId>w01</merchantWalletId>
            <transactionOrigin>origin</transactionOrigin>
            <cardCSCValue>987</cardCSCValue>
            <paymentPattern>ONE_SHOT</paymentPattern>
            <fraudData>
                <bypass3DS>Y</bypass3DS>
                <bypassCtrlList>
                    <ctrl>ctrl1</ctrl>
                </bypassCtrlList>
                <bypassInfoList>
                    <info>info1</info>
                </bypassInfoList>
                <allowedCardCountryList>
                    <country>USA</country>
                </allowedCardCountryList>
                <deniedCardCountryList>
                    <country>POR</country>
                </deniedCardCountryList>
                <allowedCardArea>ITA</allowedCardArea>
                <deniedCardArea>SPA</deniedCardArea>
                <allowedIpCountryList>
                    <country>BRA</country>
                </allowedIpCountryList>
                <deniedIpCountryList>
                    <country>FIN</country>
                </deniedIpCountryList>
                <allowedIpArea>GER</allowedIpArea>
                <deniedIpArea>CHI</deniedIpArea>
                <riskManagementDynamicSettingList>
                    <riskManagementDynamicSetting>
                        <riskManagementDynamicParam>param1</riskManagementDynamicParam>
                        <riskManagementDynamicValue>value1</riskManagementDynamicValue>
                    </riskManagementDynamicSetting>
                </riskManagementDynamicSettingList>
            </fraudData>
            <s10TransactionReference>
                <s10TransactionId>101</s10TransactionId>
                <s10TransactionIdDate>20210329</s10TransactionIdDate>
            </s10TransactionReference>
            <orderContext>
                <customerHostName>hostName</customerHostName>
                <customerBrowserType>browser</customerBrowserType>
                <customerANI>ani</customerANI>
                <customerANIInformationIdentifier>aniId</customerANIInformationIdentifier>
                <merchantOrderSpecificDataList>
                    <merchantOrderSpecificData>
                        <merchantOrderSpecificDataReference>orderReference</merchantOrderSpecificDataReference>
                        <merchantOrderSpecificDataType>orderDataType</merchantOrderSpecificDataType>
                        <merchantOrderSpecificDataValue>orderDataValue</merchantOrderSpecificDataValue>
                    </merchantOrderSpecificData>
                </merchantOrderSpecificDataList>
            </orderContext>
            <travelContext>
                <departureDate>20210320</departureDate>
                <passengerName>passengerName</passengerName>
                <originAirport>originAirport</originAirport>
                <numberOfRoutingCities>22</numberOfRoutingCities>
                <routingCityList>
                    <routingCity>Beijing</routingCity>
                </routingCityList>
                <numberOfAirlineCarriers>20</numberOfAirlineCarriers>
                <airlineCarrierList>
                    <airlineCarrier>carrier</airlineCarrier>
                </airlineCarrierList>
                <fareBasis>fareBasis</fareBasis>
                <numberOfPassengers>21</numberOfPassengers>
                <destinationAirport>destinationAirport</destinationAirport>
                <reservationCode>reservationCode</reservationCode>
            </travelContext>
            <deliveryContact>
                <firstName>River</firstName>
                <lastName>Song</lastName>
                <gender>F</gender>
                <phone>0203040506</phone>
                <email>river.song.1@dw.net</email>
                <mobile>0607080910</mobile>
                <title>title</title>
                <initials>MP</initials>
            </deliveryContact>
            <deliveryAddress>
                <city>Paris</city>
                <country>FRA</country>
                <streetName>Rue de la Rgent</streetName>
                <streetNumber>1</streetNumber>
                <zipCode>75000</zipCode>
                <additionalAddress1>additional1</additionalAddress1>
                <additionalAddress2>additional2</additionalAddress2>
                <additionalAddress3>additional3</additionalAddress3>
                <postbox>postbox</postbox>
                <state>IleDeFrance</state>
            </deliveryAddress>
            <deliveryData>
                <deliveryMethod>deliveryMethod</deliveryMethod>
            </deliveryData>
            <holderContact>
                <firstName>River</firstName>
                <lastName>Song</lastName>
                <gender>F</gender>
                <phone>0203040506</phone>
                <email>river.song.2@dw.net</email>
                <mobile>0607080910</mobile>
                <title>title</title>
                <initials>MP</initials>
            </holderContact>
            <billingContact>
                <firstName>River</firstName>
                <lastName>Song</lastName>
                <gender>F</gender>
                <phone>0203040506</phone>
                <email>river.song.3@dw.net</email>
                <mobile>0607080910</mobile>
                <title>title</title>
                <initials>MP</initials>
            </billingContact>
            <billingAddress>
                <city>Paris</city>
                <country>FRA</country>
                <streetName>Rue de la Rgent</streetName>
                <streetNumber>2</streetNumber>
                <zipCode>75000</zipCode>
                <additionalAddress1>additional1</additionalAddress1>
                <additionalAddress2>additional2</additionalAddress2>
                <additionalAddress3>additional3</additionalAddress3>
                <postbox>postbox</postbox>
                <state>IleDeFrance</state>
            </billingAddress>
            <authenticationData>
                <cardAuthPolicy>
                    <checkAVS>checkAVS</checkAVS>
                    <ignoreCSCCheckResult>ignoreCSC</ignoreCSCCheckResult>
                    <ignorePostcodeCheckResult>ignorePostcode</ignorePostcodeCheckResult>
                    <ignoreAddressCheckResult>ignoreAddress</ignoreAddressCheckResult>
                    <automaticReverse>automaticReverse</automaticReverse>
                </cardAuthPolicy>
            </authenticationData>
            <holderAddress>
                <city>Paris</city>
                <country>FRA</country>
                <streetName>Rue de la Rgent</streetName>
                <streetNumber>3</streetNumber>
                <zipCode>75000</zipCode>
                <additionalAddress1>additional1</additionalAddress1>
                <additionalAddress2>additional2</additionalAddress2>
                <additionalAddress3>additional3</additionalAddress3>
                <postbox>postbox</postbox>
                <state>IleDeFrance</state>
            </holderAddress>
            <shoppingCartDetail>
                <shoppingCartTotalAmount>66</shoppingCartTotalAmount>
                <shoppingCartTotalQuantity>1</shoppingCartTotalQuantity>
                <shoppingCartTotalTaxAmount>2</shoppingCartTotalTaxAmount>
                <mainProduct>main</mainProduct>
                <ShoppingCartItemList>
                    <shoppingCartItem>
                        <productName>name</productName>
                        <productDescription>description</productDescription>
                        <productCode>code</productCode>
                        <productSKU>sku</productSKU>
                        <productUnitAmount>66</productUnitAmount>
                        <productQuantity>1</productQuantity>
                        <productTaxRate>01</productTaxRate>
                        <productUnitTaxAmount>2</productUnitTaxAmount>
                        <productCategory>category</productCategory>
                        <productTaxCategory>tax</productTaxCategory>
                        <travelData>
                            <numberOfTravelers>3</numberOfTravelers>
                            <travelStartDateTime>2021-03-27</travelStartDateTime>
                            <travelEndDateTime>2021-03-28</travelEndDateTime>
                            <travelReason>reason</travelReason>
                            <travelCardPeriod>period</travelCardPeriod>
                            <travelCardType>cardtype</travelCardType>
                            <PassportDataList>
                                <passportData>
                                    <passportExpirationDate>20210322</passportExpirationDate>
                                    <passportIssueCountry>POL</passportIssueCountry>
                                </passportData>
                            </PassportDataList>
                            <StayDataList>
                                <stayData>
                                    <stayLocation>stayLocation</stayLocation>
                                    <stayArrivalDateTime>2021-03-24</stayArrivalDateTime>
                                    <stayDepartureDateTime>2021-03-23</stayDepartureDateTime>
                                    <numberOfNights>8</numberOfNights>
                                    <numberOfPeopleStaying>9</numberOfPeopleStaying>
                                    <roomServiceLevel>roomServiceLevel</roomServiceLevel>
                                    <stayNumberOfRooms>10</stayNumberOfRooms>
                                    <stayCategory>stayCategory</stayCategory>
                                    <stayCompany>stayCompany</stayCompany>
                                    <stayInsurance>stayInsurance</stayInsurance>
                                    <stayInsuranceIndicator>true</stayInsuranceIndicator>
                                    <stayRentalCarIndicator>true</stayRentalCarIndicator>
                                </stayData>
                            </StayDataList>
                            <JourneyDataList>
                                <journeyData>
                                    <departureLocation>Brazilia</departureLocation>
                                    <arrivalLocation>Sao Polo</arrivalLocation>
                                    <destinationCountry>SRI</destinationCountry>
                                    <departureDateTime>2021-03-26</departureDateTime>
                                    <numberOfTickets>7</numberOfTickets>
                                    <ticketIssuerName>issuerName</ticketIssuerName>
                                    <ticketReference>ticketReference</ticketReference>
                                    <ticketIssueCity>La Paz</ticketIssueCity>
                                    <ticketIssueDate>20210325</ticketIssueDate>
                                    <fareBasis>fareBasis</fareBasis>
                                    <carrierIdentifier>carrierId</carrierIdentifier>
                                    <carrierName>carrierName</carrierName>
                                    <classLevel>class</classLevel>
                                    <journeyModality>modality</journeyModality>
                                    <journeyMode>mode</journeyMode>
                                    <journeyStage>stage</journeyStage>
                                    <journeySequence>sequ</journeySequence>
                                    <journeyInsurance>insurance</journeyInsurance>
                                    <journeyInsuranceIndicator>true</journeyInsuranceIndicator>
                                    <journeyCancellableIndicator>true</journeyCancellableIndicator>
                                    <luggageSupplementIndicator>true</luggageSupplementIndicator>
                                    <ticketExchangeabilityIndicator>true</ticketExchangeabilityIndicator>
                                    <journeyAmount>777</journeyAmount>
                                    <journeyNature>nature</journeyNature>
                                </journeyData>
                            </JourneyDataList>
                            <travelingPayerIndicator>true</travelingPayerIndicator>
                            <bookingData>
                                <bookingPlatform>platform</bookingPlatform>
                                <bookingPlatformOrderId>platformOrderId</bookingPlatformOrderId>
                                <bookingId>bookingId</bookingId>
                                <bookerFirstName>Melody</bookerFirstName>
                                <bookerLastName>Pond</bookerLastName>
                            </bookingData>
                        </travelData>
                    </shoppingCartItem>
                </ShoppingCartItemList>
            </shoppingCartDetail>
            <initialSchemeTransactionIdentifier>initialSchemeTransactionIdentifier</initialSchemeTransactionIdentifier>
            <paymentMeanBrand>VISA</paymentMeanBrand>
            <settlementArchivingReference>settlementArchivingReference</settlementArchivingReference>
            <settlementMerchantSpecificData>settlementMerchantSpecificData</settlementMerchantSpecificData>
            <paymentMeansBrandSelectionStatus>paymentMeanBrandSelectionStatus</paymentMeansBrandSelectionStatus>
            <paymentMeanData>
                <bancontact>
                    <bancontactMerchantCustomerAuthenticationMethod>merchantAuthentMethod</bancontactMerchantCustomerAuthenticationMethod>
                </bancontact>
            </paymentMeanData>
            <subMerchantId>023101122334457</subMerchantId>
            <subMerchantCategoryCode>subMerchantCategoryCode</subMerchantCategoryCode>
            <subMerchantLegalId>subMerchantLegalId</subMerchantLegalId>
            <subMerchantName>subMerchantName</subMerchantName>
            <subMerchantAddress>
                <city>Paris</city>
                <country>FRA</country>
                <streetName>Rue de la Rgent</streetName>
                <streetNumber>4</streetNumber>
                <zipCode>75000</zipCode>
                <additionalAddress1>additional1</additionalAddress1>
                <additionalAddress2>additional2</additionalAddress2>
                <additionalAddress3>additional3</additionalAddress3>
                <postbox>postbox</postbox>
                <state>IleDeFrance</state>
            </subMerchantAddress>
            <subMerchantUrl>subMerchantUrl.com</subMerchantUrl>
        </walletOrder>
	</body>
	<end nbRecord="1" />
</file>

        

Required

  • amount
    presence
    Required
    Interface version
    4
    Order
    4

    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
    4
    Order
    7

    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
  • merchantId
    presence
    Required
    Interface version
    4
    Order
    2

    Identifier of the shop, this value is provided to the merchant by Worldline Sips during the shop registration.

  • merchantWalletId
    presence
    Required
    Interface version
    4
    Order
    17

    Customer’s Wallet identifier.

  • officeBatchResponseCode
    presence
    Required
    Interface version
    4
    Order
    30

    officeBatchResponseCode completes the result of the processing of a payment request handled by which would be rejected (classic reject responseCode) and contains the field of the payment request that is in error.

    List of values
    00
    None (all fields are correct)
    01
    merchantId error
    03
    transactionReference error
    04
    merchantTransactionDateTime error
    05
    amount error
    06
    captureDay error
    07
    captureMode error
    08
    operationAmount error
    09
    operationOrigin error
    11
    currencyCode error
    12
    customerIpAddress error
    13
    customerEmail error
    14
    customerId error
    16
    orderId error
    17
    orderChannel error
    18
    transactionOrigin error
    19
    returnContext error
    20
    fromTransactionReference error
    21
    cardExpiryDate error
    22
    cardNumber error
    23
    cardCSCValue error
    24
    cardEffectiveDate error
    25
    cardSeqNumber error
    26
    paymentMeanBrand error
    27
    authorisationId error
    28
    merchantWalletId error
    29
    paymentMeanId error
    30
    paymentPattern error
    31
    number error
    32
    statementReference error
    33
    panType error
    34
    mandateId error
    35
    valueDate error
    36
    paymentMeanAlias error
    37
    account error
    38
    bankCode error
    39
    transactionActors error
    45
    Date fields format error
    46
    settlementMode error
    47
    comment error
    48
    validationIndicator error
    50
    s10TransactionId error
    51
    s10TransactionIdDate error
    52
    s10FromTransactionId error
    53
    s10FromTransactionIdDate error
    54
    fraudData error
    55
    riskManagementDynamicParam error
    56
    riskManagementDynamicValue error
    57
    riskManagementDynamicSettingList error
    58
    fraudListReason error
    59
    fraudListType error
    60
    fraudListLevel error
    61
    fraudListElementType error
    62
    fraudListElementValue error
    63
    lastRecoveryIndicator error
    64
    orderContext error
    65
    travelContext error
    66
    deliveryData error
    67
    address error
    68
    contact error
    69
    cardAuthPolicy error
    70
    shoppingCartDetail error
    71
    merchantExternalId error
    72
    paymentMeansBrandSelectionStatus error
    73
    settlementArchivingReference error
    74
    settlementMerchantSpecificData error
    75
    fromTransactionAcceptor error
    80
    Merchant not registered to use Sips Office Batch / Merchant not linked to the remitter declared in the header.
  • orderChannel
    presence
    Required
    Interface version
    4
    Order
    12

    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
  • recordSequence
    presence
    Required
    Interface version
    4
    Order
    1

    Transaction order in a Sips Office Batch file.

Optional

  • acquirerResponseCode
    presence
    Optional
    Interface version
    4
    Order
    22

    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
  • authorMessageReference
    presence
    Optional
    Interface version XML
    9
    Interface version CSV
    9
    Order
    40

    Identifier shared with the acquirer during the authorisation process.For example, this reference data could be sent by the acquirer in the authorisation response, then sent (unchanged) in a subsequent authorisation reversal message, to the extent that the acquirer is able to match a reversal message to the associated response message.

  • authorisationId
    presence
    Optional
    Interface version
    4
    Order
    23

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

  • authorisationTypeLabel
    presence
    Optional
    Interface version XML
    9
    Interface version CSV
    9
    Order
    41

    Label of the authorisation request type.

    List of values
    DEMANDE_DE_RENSEIGNEMENT
    Ask for information
    TRANSACTION_DE_PAIEMENT
    Payment transaction
  • avsAddressResponseCode
    presence
    Optional
    Interface version XML
    8
    Interface version CSV
    8
    Order
    39

    Contains the result of the AVS ADDRESS check.

    List of values
    0
    No data was provided
    1
    No check has been done
    2
    Check successful
    4
    Check failed
    8
    Partial check
  • avsPostcodeResponseCode
    presence
    Optional
    Interface version XML
    8
    Interface version CSV
    8
    Order
    38

    Contains the result of the AVS POSTCODE check.

    List of values
    0
    No data was provided
    1
    No check has been done
    2
    Check successful
    4
    Check failed
    8
    Partial check
  • billingAddress
    presence
    Optional
    Interface version XML
    8

    Contains the billing address information for the buyer.

    Contains
  • billingContact
    presence
    Optional
    Interface version XML
    8

    Contains the billing contact’s information.

    Contains
  • captureDay
    presence
    Optional
    Interface version
    4
    Order
    5

    Deadline for settlement.

  • captureMode
    presence
    Optional
    Interface version
    4
    Order
    6

    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
  • cardCSCResultCode
    presence
    Optional
    Interface version XML
    8
    Interface version CSV
    8
    Order
    37

    Response code for the Card Security Code check returned in the authorisation response.

    List of values
    4D
    Incorrect cryptogram
    4E
    Correct cryptogram
    50
    Cryptogram not processed
    53
    Cryptogram missing in the authorisation request
    55
    The Internet user’s bank is not certified; the control could not be performed
    Empty
    The Internet user’s bank has not responded
    NO
    No cryptogramme on the card
  • cardData
    presence
    Optional
    Interface version XML
    5
    Interface version CSV
    5
    Order
    34

    Contains specific information regarding a card

    Contains
    • cardProductCode
      presence
      Optional
      Interface version
      4

      Product code of the card.

    • cardProductName
      presence
      Optional
      Interface version
      4

      Product name of the card.

    • cardProductProfile
      presence
      Optional
      Interface version
      4

      Profile code of the card.

      List of values
      C
      Credit (pay after)
      D
      Debit (pay now)
      Empty
      Unknown
      H
      Charge card (UK specific)
      N
      Non-Mastercard
      P
      Prepaid
      R
      Deffered debit
      U
      Universal
    • cardProductUsageLabel
      presence
      Optional
      Interface version XML
      9
      Interface version CSV
      9

      Profile name of the card which is displayed on payment electronic ticket in accordance with MPADS requirements.

      List of values
      COMMERCIAL
      Business card
      CREDIT
      Credit card
      DEBIT
      Debit card
      PREPAID
      Prepaid card
    • cardScheme
      presence
      Optional
      Interface version
      4

      Network name associated with the card.

      List of values
      ACCORD
      Accord scheme
      AMEX
      American Express scheme
      BCMC
      Bancontact scheme
      CB
      Bank Card scheme
      MASTERCARD
      Mastercard scheme (Example of cards on the Mastercard scheme: Mastercard, Maestro)
      SOFINCO
      Sofinco scheme
      VISA
      Visa scheme (Example of cards on the Visa scheme: Visa, Vpay, Visa Electron)
    • issuerCode
      presence
      Optional
      Interface version
      4

      Issuer code of the card. This data is called cardIssuerCode in the reports.

    • issuerCountryCode
      presence
      Optional
      Interface version
      4

      Country code of the card issuer. This data is called cardIssuerCountryCode in the reports.

      List of values
      ABW
      ARUBA
      AFG
      AFGHANISTAN
      AGO
      ANGOLA
      AIA
      ANGUILLA
      ALA
      ÅLAND ISLANDS
      ALB
      ALBANIA
      AND
      ANDORRA
      ARE
      UNITED ARAB EMIRATES
      ARG
      ARGENTINA
      ARM
      ARMENIA
      ASM
      AMERICAN SAMOA
      ATA
      ANTARCTICA
      ATF
      FRENCH SOUTHERN TERRITORIES
      ATG
      ANTIGUA AND BARBUDA
      AUS
      AUSTRALIA
      AUT
      AUSTRIA
      AZE
      AZERBAIJAN
      BDI
      BURUNDI
      BEL
      BELGIUM
      BEN
      BENIN
      BES
      BONAIRE, SINT EUSTATIUS AND SABA
      BFA
      BURKINA FASO
      BGD
      BANGLADESH
      BGR
      BULGARIA
      BHR
      BAHRAIN
      BHS
      BAHAMAS
      BIH
      BOSNIA AND HERZEGOVINA
      BLM
      SAINT KITTS AND NEVIS
      BLR
      BELARUS
      BLZ
      BELIZE
      BMU
      BERMUDA
      BOL
      BOLIVIA, PLURINATIONAL STATE OF
      BRA
      BRAZIL
      BRB
      BARBADOS
      BRN
      BRUNEI DARUSSALAM
      BTN
      BHUTAN
      BVT
      BOUVET ISLAND
      BWA
      BOTSWANA
      CAF
      CENTRAL AFRICAN REPUBLIC
      CAN
      CANADA
      CCK
      COCOS (KEELING) ISLANDS
      CHE
      SWITZERLAND
      CHL
      CHILE
      CHN
      CHINA
      CIV
      CÔTE D’IVOIRE
      CMR
      CAMEROON
      COD
      CONGO, THE DEMOCRATIC REPUBLIC OF THE
      COG
      CONGO
      COK
      COOK ISLANDS
      COL
      COLOMBIA
      COM
      COMOROS
      CPV
      CAPE VERDE
      CRI
      COSTA RICA
      CUB
      CUBA
      CUW
      CURAÇAO
      CXR
      CHRISTMAS ISLAND
      CYM
      CAYMAN ISLANDS
      CYP
      CYPRUS
      CZE
      CZECH REPUBLIC
      DEU
      GERMANY
      DJI
      DJIBOUTI
      DMA
      DOMINICA
      DNK
      DENMARK
      DOM
      DOMINICAN REPUBLIC
      DZA
      ALGERIA
      ECU
      ECUADOR
      EGY
      EGYPT
      ERI
      ERITREA
      ESH
      WESTERN SAHARA
      ESP
      SPAIN
      EST
      ESTONIA
      ETH
      ETHIOPIA
      FIN
      FINLAND
      FJI
      FIJI
      FLK
      FALKLAND ISLANDS (MALVINAS)
      FRA
      FRANCE
      FRO
      FAROE ISLANDS
      FSM
      MICRONESIA, FEDERATED STATES OF
      GAB
      GABON
      GBR
      UNITED KINGDOM
      GEO
      GEORGIA
      GGY
      GUERNSEY
      GHA
      GHANA
      GIB
      GIBRALTAR
      GIN
      GUINEA
      GLP
      GUADELOUPE
      GMB
      GAMBIA
      GNB
      GUINEA-BISSAU
      GNQ
      EQUATORIAL GUINEA
      GRC
      GREECE
      GRD
      GRENADA
      GRL
      GREENLAND
      GTM
      GUATEMALA
      GUF
      FRENCH GUIANA
      GUM
      GUAM
      GUY
      GUYANA
      HKG
      HONG KONG
      HMD
      HEARD ISLAND AND MCDONALD ISLANDS
      HND
      HONDURAS
      HRV
      CROATIA
      HTI
      HAITI
      HUN
      HUNGARY
      IDN
      INDONESIA
      IMN
      ISLE OF MAN
      IND
      INDIA
      IOT
      BRITISH INDIAN OCEAN TERRITORY
      IRL
      IRELAND
      IRN
      IRAN, ISLAMIC REPUBLIC OF
      IRQ
      IRAQ
      ISL
      ICELAND
      ISR
      ISRAEL
      ITA
      ITALY
      JAM
      JAMAICA
      JEY
      JERSEY
      JOR
      JORDAN
      JPN
      JAPAN
      KAZ
      KAZAKHSTAN
      KEN
      KENYA
      KGZ
      KYRGYZSTAN
      KHM
      CAMBODIA
      KIR
      KIRIBATI
      KNA
      SAINT BARTHÉLEMY
      KOR
      KOREA, REPUBLIC OF
      KWT
      KUWAIT
      LAO
      LAO PEOPLE’S DEMOCRATIC REPUBLIC
      LBN
      LEBANON
      LBR
      LIBERIA
      LBY
      LIBYA
      LCA
      SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
      LIE
      LIECHTENSTEIN
      LKA
      SRI LANKA
      LSO
      LESOTHO
      LTU
      LITHUANIA
      LUX
      LUXEMBOURG
      LVA
      LATVIA
      MAC
      MACAO
      MAF
      SAINT MARTIN (FRENCH PART)
      MAR
      MOROCCO
      MCO
      MONACO
      MDA
      MOLDOVA, REPUBLIC OF
      MDG
      MADAGASCAR
      MDV
      MALDIVES
      MEX
      MEXICO
      MHL
      MARSHALL ISLANDS
      MKD
      MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
      MLI
      MALI
      MLT
      MALTA
      MMR
      MYANMAR
      MNE
      MONTENEGRO
      MNG
      MONGOLIA
      MNP
      NORTHERN MARIANA ISLANDS
      MOZ
      MOZAMBIQUE
      MRT
      MAURITANIA
      MSR
      MONTSERRAT
      MTQ
      MARTINIQUE
      MUS
      MAURITIUS
      MWI
      MALAWI
      MYS
      MALAYSIA
      MYT
      MAYOTTE
      NAM
      NAMIBIA
      NCL
      NEW CALEDONIA
      NER
      NIGER
      NFK
      NORFOLK ISLAND
      NGA
      NIGERIA
      NIC
      NICARAGUA
      NIU
      NIUE
      NLD
      NETHERLANDS
      NOR
      NORWAY
      NPL
      NEPAL
      NRU
      NAURU
      NZL
      NEW ZEALAND
      OMN
      OMAN
      PAK
      PAKISTAN
      PAN
      PANAMA
      PCN
      PITCAIRN
      PER
      PERU
      PHL
      PHILIPPINES
      PLW
      PALAU
      PNG
      PAPUA NEW GUINEA
      POL
      POLAND
      PRI
      PUERTO RICO
      PRK
      KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
      PRT
      PORTUGAL
      PRY
      PARAGUAY
      PSE
      PALESTINIAN TERRITORY, OCCUPIED
      PYF
      FRENCH POLYNESIA
      QAT
      QATAR
      REU
      RÉUNION
      ROU
      ROMANIA
      RUS
      RUSSIAN FEDERATION
      RWA
      RWANDA
      SAU
      SAUDI ARABIA
      SDN
      SUDAN
      SEN
      SENEGAL
      SGP
      SINGAPORE
      SGS
      SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
      SHN
      SAN MARINO
      SJM
      SVALBARD AND JAN MAYEN
      SLB
      SOLOMON ISLANDS
      SLE
      SIERRA LEONE
      SLV
      EL SALVADOR
      SMR
      SINT MAARTEN (DUTCH PART)
      SOM
      SOMALIA
      SPM
      HOLY SEE (VATICAN CITY STATE)
      SRB
      SERBIA
      SSD
      SOUTH SUDAN
      STP
      SAO TOME AND PRINCIPE
      SUR
      SURINAME
      SVK
      SLOVAKIA
      SVN
      SLOVENIA
      SWE
      SWEDEN
      SWZ
      SWAZILAND
      SXM
      SAINT PIERRE AND MIQUELON
      SYC
      SEYCHELLES
      SYR
      SYRIAN ARAB REPUBLIC
      TCA
      TURKS AND CAICOS ISLANDS
      TCD
      CHAD
      TGO
      TOGO
      THA
      THAILAND
      TJK
      TAJIKISTAN
      TKL
      TOKELAU
      TKM
      TURKMENISTAN
      TLS
      TIMOR-LESTE
      TON
      TONGA
      TTO
      TRINIDAD AND TOBAGO
      TUN
      TUNISIA
      TUR
      TURKEY
      TUV
      TUVALU
      TWN
      TAIWAN, PROVINCE OF CHINA
      TZA
      TANZANIA, UNITED REPUBLIC OF
      UGA
      UGANDA
      UKR
      UKRAINE
      UMI
      UNITED STATES MINOR OUTLYING ISLANDS
      URY
      URUGUAY
      USA
      UNITED STATES
      UZB
      UZBEKISTAN
      VAT
      SAINT VINCENT AND THE GRENADINES
      VCT
      SAINT LUCIA
      VEN
      VENEZUELA, BOLIVARIAN REPUBLIC OF
      VGB
      VIRGIN ISLANDS, BRITISH
      VIR
      VIRGIN ISLANDS, U.S.
      VNM
      VIET NAM
      VUT
      VANUATU
      WLF
      WALLIS AND FUTUNA
      WSM
      SAMOA
      YEM
      YEMEN
      ZAF
      SOUTH AFRICA
      ZMB
      ZAMBIA
      ZWE
      ZIMBABWE
    • issuingCountryCode
      presence
      Optional
      Interface version XML
      19
      Interface version CSV
      19

      Country code in which the card has been issued. This data is called cardIssuingCountryCode in the reports.

      List of values
      ABW
      ARUBA
      AFG
      AFGHANISTAN
      AGO
      ANGOLA
      AIA
      ANGUILLA
      ALA
      ÅLAND ISLANDS
      ALB
      ALBANIA
      AND
      ANDORRA
      ARE
      UNITED ARAB EMIRATES
      ARG
      ARGENTINA
      ARM
      ARMENIA
      ASM
      AMERICAN SAMOA
      ATA
      ANTARCTICA
      ATF
      FRENCH SOUTHERN TERRITORIES
      ATG
      ANTIGUA AND BARBUDA
      AUS
      AUSTRALIA
      AUT
      AUSTRIA
      AZE
      AZERBAIJAN
      BDI
      BURUNDI
      BEL
      BELGIUM
      BEN
      BENIN
      BES
      BONAIRE, SINT EUSTATIUS AND SABA
      BFA
      BURKINA FASO
      BGD
      BANGLADESH
      BGR
      BULGARIA
      BHR
      BAHRAIN
      BHS
      BAHAMAS
      BIH
      BOSNIA AND HERZEGOVINA
      BLM
      SAINT KITTS AND NEVIS
      BLR
      BELARUS
      BLZ
      BELIZE
      BMU
      BERMUDA
      BOL
      BOLIVIA, PLURINATIONAL STATE OF
      BRA
      BRAZIL
      BRB
      BARBADOS
      BRN
      BRUNEI DARUSSALAM
      BTN
      BHUTAN
      BVT
      BOUVET ISLAND
      BWA
      BOTSWANA
      CAF
      CENTRAL AFRICAN REPUBLIC
      CAN
      CANADA
      CCK
      COCOS (KEELING) ISLANDS
      CHE
      SWITZERLAND
      CHL
      CHILE
      CHN
      CHINA
      CIV
      CÔTE D’IVOIRE
      CMR
      CAMEROON
      COD
      CONGO, THE DEMOCRATIC REPUBLIC OF THE
      COG
      CONGO
      COK
      COOK ISLANDS
      COL
      COLOMBIA
      COM
      COMOROS
      CPV
      CAPE VERDE
      CRI
      COSTA RICA
      CUB
      CUBA
      CUW
      CURAÇAO
      CXR
      CHRISTMAS ISLAND
      CYM
      CAYMAN ISLANDS
      CYP
      CYPRUS
      CZE
      CZECH REPUBLIC
      DEU
      GERMANY
      DJI
      DJIBOUTI
      DMA
      DOMINICA
      DNK
      DENMARK
      DOM
      DOMINICAN REPUBLIC
      DZA
      ALGERIA
      ECU
      ECUADOR
      EGY
      EGYPT
      ERI
      ERITREA
      ESH
      WESTERN SAHARA
      ESP
      SPAIN
      EST
      ESTONIA
      ETH
      ETHIOPIA
      FIN
      FINLAND
      FJI
      FIJI
      FLK
      FALKLAND ISLANDS (MALVINAS)
      FRA
      FRANCE
      FRO
      FAROE ISLANDS
      FSM
      MICRONESIA, FEDERATED STATES OF
      GAB
      GABON
      GBR
      UNITED KINGDOM
      GEO
      GEORGIA
      GGY
      GUERNSEY
      GHA
      GHANA
      GIB
      GIBRALTAR
      GIN
      GUINEA
      GLP
      GUADELOUPE
      GMB
      GAMBIA
      GNB
      GUINEA-BISSAU
      GNQ
      EQUATORIAL GUINEA
      GRC
      GREECE
      GRD
      GRENADA
      GRL
      GREENLAND
      GTM
      GUATEMALA
      GUF
      FRENCH GUIANA
      GUM
      GUAM
      GUY
      GUYANA
      HKG
      HONG KONG
      HMD
      HEARD ISLAND AND MCDONALD ISLANDS
      HND
      HONDURAS
      HRV
      CROATIA
      HTI
      HAITI
      HUN
      HUNGARY
      IDN
      INDONESIA
      IMN
      ISLE OF MAN
      IND
      INDIA
      IOT
      BRITISH INDIAN OCEAN TERRITORY
      IRL
      IRELAND
      IRN
      IRAN, ISLAMIC REPUBLIC OF
      IRQ
      IRAQ
      ISL
      ICELAND
      ISR
      ISRAEL
      ITA
      ITALY
      JAM
      JAMAICA
      JEY
      JERSEY
      JOR
      JORDAN
      JPN
      JAPAN
      KAZ
      KAZAKHSTAN
      KEN
      KENYA
      KGZ
      KYRGYZSTAN
      KHM
      CAMBODIA
      KIR
      KIRIBATI
      KNA
      SAINT BARTHÉLEMY
      KOR
      KOREA, REPUBLIC OF
      KWT
      KUWAIT
      LAO
      LAO PEOPLE’S DEMOCRATIC REPUBLIC
      LBN
      LEBANON
      LBR
      LIBERIA
      LBY
      LIBYA
      LCA
      SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
      LIE
      LIECHTENSTEIN
      LKA
      SRI LANKA
      LSO
      LESOTHO
      LTU
      LITHUANIA
      LUX
      LUXEMBOURG
      LVA
      LATVIA
      MAC
      MACAO
      MAF
      SAINT MARTIN (FRENCH PART)
      MAR
      MOROCCO
      MCO
      MONACO
      MDA
      MOLDOVA, REPUBLIC OF
      MDG
      MADAGASCAR
      MDV
      MALDIVES
      MEX
      MEXICO
      MHL
      MARSHALL ISLANDS
      MKD
      MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
      MLI
      MALI
      MLT
      MALTA
      MMR
      MYANMAR
      MNE
      MONTENEGRO
      MNG
      MONGOLIA
      MNP
      NORTHERN MARIANA ISLANDS
      MOZ
      MOZAMBIQUE
      MRT
      MAURITANIA
      MSR
      MONTSERRAT
      MTQ
      MARTINIQUE
      MUS
      MAURITIUS
      MWI
      MALAWI
      MYS
      MALAYSIA
      MYT
      MAYOTTE
      NAM
      NAMIBIA
      NCL
      NEW CALEDONIA
      NER
      NIGER
      NFK
      NORFOLK ISLAND
      NGA
      NIGERIA
      NIC
      NICARAGUA
      NIU
      NIUE
      NLD
      NETHERLANDS
      NOR
      NORWAY
      NPL
      NEPAL
      NRU
      NAURU
      NZL
      NEW ZEALAND
      OMN
      OMAN
      PAK
      PAKISTAN
      PAN
      PANAMA
      PCN
      PITCAIRN
      PER
      PERU
      PHL
      PHILIPPINES
      PLW
      PALAU
      PNG
      PAPUA NEW GUINEA
      POL
      POLAND
      PRI
      PUERTO RICO
      PRK
      KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
      PRT
      PORTUGAL
      PRY
      PARAGUAY
      PSE
      PALESTINIAN TERRITORY, OCCUPIED
      PYF
      FRENCH POLYNESIA
      QAT
      QATAR
      REU
      RÉUNION
      ROU
      ROMANIA
      RUS
      RUSSIAN FEDERATION
      RWA
      RWANDA
      SAU
      SAUDI ARABIA
      SDN
      SUDAN
      SEN
      SENEGAL
      SGP
      SINGAPORE
      SGS
      SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
      SHN
      SAN MARINO
      SJM
      SVALBARD AND JAN MAYEN
      SLB
      SOLOMON ISLANDS
      SLE
      SIERRA LEONE
      SLV
      EL SALVADOR
      SMR
      SINT MAARTEN (DUTCH PART)
      SOM
      SOMALIA
      SPM
      HOLY SEE (VATICAN CITY STATE)
      SRB
      SERBIA
      SSD
      SOUTH SUDAN
      STP
      SAO TOME AND PRINCIPE
      SUR
      SURINAME
      SVK
      SLOVAKIA
      SVN
      SLOVENIA
      SWE
      SWEDEN
      SWZ
      SWAZILAND
      SXM
      SAINT PIERRE AND MIQUELON
      SYC
      SEYCHELLES
      SYR
      SYRIAN ARAB REPUBLIC
      TCA
      TURKS AND CAICOS ISLANDS
      TCD
      CHAD
      TGO
      TOGO
      THA
      THAILAND
      TJK
      TAJIKISTAN
      TKL
      TOKELAU
      TKM
      TURKMENISTAN
      TLS
      TIMOR-LESTE
      TON
      TONGA
      TTO
      TRINIDAD AND TOBAGO
      TUN
      TUNISIA
      TUR
      TURKEY
      TUV
      TUVALU
      TWN
      TAIWAN, PROVINCE OF CHINA
      TZA
      TANZANIA, UNITED REPUBLIC OF
      UGA
      UGANDA
      UKR
      UKRAINE
      UMI
      UNITED STATES MINOR OUTLYING ISLANDS
      URY
      URUGUAY
      USA
      UNITED STATES
      UZB
      UZBEKISTAN
      VAT
      SAINT VINCENT AND THE GRENADINES
      VCT
      SAINT LUCIA
      VEN
      VENEZUELA, BOLIVARIAN REPUBLIC OF
      VGB
      VIRGIN ISLANDS, BRITISH
      VIR
      VIRGIN ISLANDS, U.S.
      VNM
      VIET NAM
      VUT
      VANUATU
      WLF
      WALLIS AND FUTUNA
      WSM
      SAMOA
      YEM
      YEMEN
      ZAF
      SOUTH AFRICA
      ZMB
      ZAMBIA
      ZWE
      ZIMBABWE
  • cardExpiryDate
    presence
    Optional
    Interface version XML
    16
    Interface version CSV
    16
    Order
    49

    Card expiry date. If the card does not have any expiry date, this field is empty.

  • complementaryCode
    presence
    Optional
    Interface version
    4
    Order
    24

    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
    4
    Order
    25

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

  • customerEmail
    presence
    Optional
    Interface version
    4
    Order
    8

    Depreciated, replaced by “email” in the container customerContact.

  • customerId
    presence
    Optional
    Interface version
    4
    Order
    9

    Customer identifier

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

  • customerIpAddress
    presence
    Optional
    Interface version
    4
    Order
    10

    Buyer’s IP address.

  • deliveryAddress
    presence
    Optional
    Interface version XML
    8

    Contains the delivery address information.

    Contains
  • deliveryContact
    presence
    Optional
    Interface version XML
    8

    Contains the delivery contact’s information.

    Contains
  • deliveryData
    presence
    Optional
    Interface version XML
    8

    Contains the delivery information.

    Contains
  • fraudData
    presence
    Optional
    Interface version
    4
    Order
    20

    Contains the transaction’s antifraud rules parameters, allowing the merchant to dynamically customise the rules registered in the merchant configuration.

    Contains
    • allowedIpCountryList
      presence
      Optional
      Interface version
      4

      List of buyer IP country codes allowed to make a paymentISO 3166 list of country codes.

      Contains
      • country
        presence
        Optional
        Interface version
        4

        Country code for the address.

        List of values
        ABW
        ARUBA
        AFG
        AFGHANISTAN
        AGO
        ANGOLA
        AIA
        ANGUILLA
        ALA
        ÅLAND ISLANDS
        ALB
        ALBANIA
        AND
        ANDORRA
        ARE
        UNITED ARAB EMIRATES
        ARG
        ARGENTINA
        ARM
        ARMENIA
        ASM
        AMERICAN SAMOA
        ATA
        ANTARCTICA
        ATF
        FRENCH SOUTHERN TERRITORIES
        ATG
        ANTIGUA AND BARBUDA
        AUS
        AUSTRALIA
        AUT
        AUSTRIA
        AZE
        AZERBAIJAN
        BDI
        BURUNDI
        BEL
        BELGIUM
        BEN
        BENIN
        BES
        BONAIRE, SINT EUSTATIUS AND SABA
        BFA
        BURKINA FASO
        BGD
        BANGLADESH
        BGR
        BULGARIA
        BHR
        BAHRAIN
        BHS
        BAHAMAS
        BIH
        BOSNIA AND HERZEGOVINA
        BLM
        SAINT KITTS AND NEVIS
        BLR
        BELARUS
        BLZ
        BELIZE
        BMU
        BERMUDA
        BOL
        BOLIVIA, PLURINATIONAL STATE OF
        BRA
        BRAZIL
        BRB
        BARBADOS
        BRN
        BRUNEI DARUSSALAM
        BTN
        BHUTAN
        BVT
        BOUVET ISLAND
        BWA
        BOTSWANA
        CAF
        CENTRAL AFRICAN REPUBLIC
        CAN
        CANADA
        CCK
        COCOS (KEELING) ISLANDS
        CHE
        SWITZERLAND
        CHL
        CHILE
        CHN
        CHINA
        CIV
        CÔTE D’IVOIRE
        CMR
        CAMEROON
        COD
        CONGO, THE DEMOCRATIC REPUBLIC OF THE
        COG
        CONGO
        COK
        COOK ISLANDS
        COL
        COLOMBIA
        COM
        COMOROS
        CPV
        CAPE VERDE
        CRI
        COSTA RICA
        CUB
        CUBA
        CUW
        CURAÇAO
        CXR
        CHRISTMAS ISLAND
        CYM
        CAYMAN ISLANDS
        CYP
        CYPRUS
        CZE
        CZECH REPUBLIC
        DEU
        GERMANY
        DJI
        DJIBOUTI
        DMA
        DOMINICA
        DNK
        DENMARK
        DOM
        DOMINICAN REPUBLIC
        DZA
        ALGERIA
        ECU
        ECUADOR
        EGY
        EGYPT
        ERI
        ERITREA
        ESH
        WESTERN SAHARA
        ESP
        SPAIN
        EST
        ESTONIA
        ETH
        ETHIOPIA
        FIN
        FINLAND
        FJI
        FIJI
        FLK
        FALKLAND ISLANDS (MALVINAS)
        FRA
        FRANCE
        FRO
        FAROE ISLANDS
        FSM
        MICRONESIA, FEDERATED STATES OF
        GAB
        GABON
        GBR
        UNITED KINGDOM
        GEO
        GEORGIA
        GGY
        GUERNSEY
        GHA
        GHANA
        GIB
        GIBRALTAR
        GIN
        GUINEA
        GLP
        GUADELOUPE
        GMB
        GAMBIA
        GNB
        GUINEA-BISSAU
        GNQ
        EQUATORIAL GUINEA
        GRC
        GREECE
        GRD
        GRENADA
        GRL
        GREENLAND
        GTM
        GUATEMALA
        GUF
        FRENCH GUIANA
        GUM
        GUAM
        GUY
        GUYANA
        HKG
        HONG KONG
        HMD
        HEARD ISLAND AND MCDONALD ISLANDS
        HND
        HONDURAS
        HRV
        CROATIA
        HTI
        HAITI
        HUN
        HUNGARY
        IDN
        INDONESIA
        IMN
        ISLE OF MAN
        IND
        INDIA
        IOT
        BRITISH INDIAN OCEAN TERRITORY
        IRL
        IRELAND
        IRN
        IRAN, ISLAMIC REPUBLIC OF
        IRQ
        IRAQ
        ISL
        ICELAND
        ISR
        ISRAEL
        ITA
        ITALY
        JAM
        JAMAICA
        JEY
        JERSEY
        JOR
        JORDAN
        JPN
        JAPAN
        KAZ
        KAZAKHSTAN
        KEN
        KENYA
        KGZ
        KYRGYZSTAN
        KHM
        CAMBODIA
        KIR
        KIRIBATI
        KNA
        SAINT BARTHÉLEMY
        KOR
        KOREA, REPUBLIC OF
        KWT
        KUWAIT
        LAO
        LAO PEOPLE’S DEMOCRATIC REPUBLIC
        LBN
        LEBANON
        LBR
        LIBERIA
        LBY
        LIBYA
        LCA
        SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
        LIE
        LIECHTENSTEIN
        LKA
        SRI LANKA
        LSO
        LESOTHO
        LTU
        LITHUANIA
        LUX
        LUXEMBOURG
        LVA
        LATVIA
        MAC
        MACAO
        MAF
        SAINT MARTIN (FRENCH PART)
        MAR
        MOROCCO
        MCO
        MONACO
        MDA
        MOLDOVA, REPUBLIC OF
        MDG
        MADAGASCAR
        MDV
        MALDIVES
        MEX
        MEXICO
        MHL
        MARSHALL ISLANDS
        MKD
        MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
        MLI
        MALI
        MLT
        MALTA
        MMR
        MYANMAR
        MNE
        MONTENEGRO
        MNG
        MONGOLIA
        MNP
        NORTHERN MARIANA ISLANDS
        MOZ
        MOZAMBIQUE
        MRT
        MAURITANIA
        MSR
        MONTSERRAT
        MTQ
        MARTINIQUE
        MUS
        MAURITIUS
        MWI
        MALAWI
        MYS
        MALAYSIA
        MYT
        MAYOTTE
        NAM
        NAMIBIA
        NCL
        NEW CALEDONIA
        NER
        NIGER
        NFK
        NORFOLK ISLAND
        NGA
        NIGERIA
        NIC
        NICARAGUA
        NIU
        NIUE
        NLD
        NETHERLANDS
        NOR
        NORWAY
        NPL
        NEPAL
        NRU
        NAURU
        NZL
        NEW ZEALAND
        OMN
        OMAN
        PAK
        PAKISTAN
        PAN
        PANAMA
        PCN
        PITCAIRN
        PER
        PERU
        PHL
        PHILIPPINES
        PLW
        PALAU
        PNG
        PAPUA NEW GUINEA
        POL
        POLAND
        PRI
        PUERTO RICO
        PRK
        KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
        PRT
        PORTUGAL
        PRY
        PARAGUAY
        PSE
        PALESTINIAN TERRITORY, OCCUPIED
        PYF
        FRENCH POLYNESIA
        QAT
        QATAR
        REU
        RÉUNION
        ROU
        ROMANIA
        RUS
        RUSSIAN FEDERATION
        RWA
        RWANDA
        SAU
        SAUDI ARABIA
        SDN
        SUDAN
        SEN
        SENEGAL
        SGP
        SINGAPORE
        SGS
        SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
        SHN
        SAN MARINO
        SJM
        SVALBARD AND JAN MAYEN
        SLB
        SOLOMON ISLANDS
        SLE
        SIERRA LEONE
        SLV
        EL SALVADOR
        SMR
        SINT MAARTEN (DUTCH PART)
        SOM
        SOMALIA
        SPM
        HOLY SEE (VATICAN CITY STATE)
        SRB
        SERBIA
        SSD
        SOUTH SUDAN
        STP
        SAO TOME AND PRINCIPE
        SUR
        SURINAME
        SVK
        SLOVAKIA
        SVN
        SLOVENIA
        SWE
        SWEDEN
        SWZ
        SWAZILAND
        SXM
        SAINT PIERRE AND MIQUELON
        SYC
        SEYCHELLES
        SYR
        SYRIAN ARAB REPUBLIC
        TCA
        TURKS AND CAICOS ISLANDS
        TCD
        CHAD
        TGO
        TOGO
        THA
        THAILAND
        TJK
        TAJIKISTAN
        TKL
        TOKELAU
        TKM
        TURKMENISTAN
        TLS
        TIMOR-LESTE
        TON
        TONGA
        TTO
        TRINIDAD AND TOBAGO
        TUN
        TUNISIA
        TUR
        TURKEY
        TUV
        TUVALU
        TWN
        TAIWAN, PROVINCE OF CHINA
        TZA
        TANZANIA, UNITED REPUBLIC OF
        UGA
        UGANDA
        UKR
        UKRAINE
        UMI
        UNITED STATES MINOR OUTLYING ISLANDS
        URY
        URUGUAY
        USA
        UNITED STATES
        UZB
        UZBEKISTAN
        VAT
        SAINT VINCENT AND THE GRENADINES
        VCT
        SAINT LUCIA
        VEN
        VENEZUELA, BOLIVARIAN REPUBLIC OF
        VGB
        VIRGIN ISLANDS, BRITISH
        VIR
        VIRGIN ISLANDS, U.S.
        VNM
        VIET NAM
        VUT
        VANUATU
        WLF
        WALLIS AND FUTUNA
        WSM
        SAMOA
        YEM
        YEMEN
        ZAF
        SOUTH AFRICA
        ZMB
        ZAMBIA
        ZWE
        ZIMBABWE
    • bypassInfoList
      presence
      Optional
      Interface version
      4

      List of information provided by the merchant to bypass fraud information.

      List of values
      Card
      Bypass informations about card
      IpCountry
      Bypass all information
    • deniedCardCountryList
      presence
      Optional
      Interface version
      4

      List of country codes for cards not authorised to make a payment

      Contains
      • country
        presence
        Optional
        Interface version
        4

        Country code for the address.

        List of values
        ABW
        ARUBA
        AFG
        AFGHANISTAN
        AGO
        ANGOLA
        AIA
        ANGUILLA
        ALA
        ÅLAND ISLANDS
        ALB
        ALBANIA
        AND
        ANDORRA
        ARE
        UNITED ARAB EMIRATES
        ARG
        ARGENTINA
        ARM
        ARMENIA
        ASM
        AMERICAN SAMOA
        ATA
        ANTARCTICA
        ATF
        FRENCH SOUTHERN TERRITORIES
        ATG
        ANTIGUA AND BARBUDA
        AUS
        AUSTRALIA
        AUT
        AUSTRIA
        AZE
        AZERBAIJAN
        BDI
        BURUNDI
        BEL
        BELGIUM
        BEN
        BENIN
        BES
        BONAIRE, SINT EUSTATIUS AND SABA
        BFA
        BURKINA FASO
        BGD
        BANGLADESH
        BGR
        BULGARIA
        BHR
        BAHRAIN
        BHS
        BAHAMAS
        BIH
        BOSNIA AND HERZEGOVINA
        BLM
        SAINT KITTS AND NEVIS
        BLR
        BELARUS
        BLZ
        BELIZE
        BMU
        BERMUDA
        BOL
        BOLIVIA, PLURINATIONAL STATE OF
        BRA
        BRAZIL
        BRB
        BARBADOS
        BRN
        BRUNEI DARUSSALAM
        BTN
        BHUTAN
        BVT
        BOUVET ISLAND
        BWA
        BOTSWANA
        CAF
        CENTRAL AFRICAN REPUBLIC
        CAN
        CANADA
        CCK
        COCOS (KEELING) ISLANDS
        CHE
        SWITZERLAND
        CHL
        CHILE
        CHN
        CHINA
        CIV
        CÔTE D’IVOIRE
        CMR
        CAMEROON
        COD
        CONGO, THE DEMOCRATIC REPUBLIC OF THE
        COG
        CONGO
        COK
        COOK ISLANDS
        COL
        COLOMBIA
        COM
        COMOROS
        CPV
        CAPE VERDE
        CRI
        COSTA RICA
        CUB
        CUBA
        CUW
        CURAÇAO
        CXR
        CHRISTMAS ISLAND
        CYM
        CAYMAN ISLANDS
        CYP
        CYPRUS
        CZE
        CZECH REPUBLIC
        DEU
        GERMANY
        DJI
        DJIBOUTI
        DMA
        DOMINICA
        DNK
        DENMARK
        DOM
        DOMINICAN REPUBLIC
        DZA
        ALGERIA
        ECU
        ECUADOR
        EGY
        EGYPT
        ERI
        ERITREA
        ESH
        WESTERN SAHARA
        ESP
        SPAIN
        EST
        ESTONIA
        ETH
        ETHIOPIA
        FIN
        FINLAND
        FJI
        FIJI
        FLK
        FALKLAND ISLANDS (MALVINAS)
        FRA
        FRANCE
        FRO
        FAROE ISLANDS
        FSM
        MICRONESIA, FEDERATED STATES OF
        GAB
        GABON
        GBR
        UNITED KINGDOM
        GEO
        GEORGIA
        GGY
        GUERNSEY
        GHA
        GHANA
        GIB
        GIBRALTAR
        GIN
        GUINEA
        GLP
        GUADELOUPE
        GMB
        GAMBIA
        GNB
        GUINEA-BISSAU
        GNQ
        EQUATORIAL GUINEA
        GRC
        GREECE
        GRD
        GRENADA
        GRL
        GREENLAND
        GTM
        GUATEMALA
        GUF
        FRENCH GUIANA
        GUM
        GUAM
        GUY
        GUYANA
        HKG
        HONG KONG
        HMD
        HEARD ISLAND AND MCDONALD ISLANDS
        HND
        HONDURAS
        HRV
        CROATIA
        HTI
        HAITI
        HUN
        HUNGARY
        IDN
        INDONESIA
        IMN
        ISLE OF MAN
        IND
        INDIA
        IOT
        BRITISH INDIAN OCEAN TERRITORY
        IRL
        IRELAND
        IRN
        IRAN, ISLAMIC REPUBLIC OF
        IRQ
        IRAQ
        ISL
        ICELAND
        ISR
        ISRAEL
        ITA
        ITALY
        JAM
        JAMAICA
        JEY
        JERSEY
        JOR
        JORDAN
        JPN
        JAPAN
        KAZ
        KAZAKHSTAN
        KEN
        KENYA
        KGZ
        KYRGYZSTAN
        KHM
        CAMBODIA
        KIR
        KIRIBATI
        KNA
        SAINT BARTHÉLEMY
        KOR
        KOREA, REPUBLIC OF
        KWT
        KUWAIT
        LAO
        LAO PEOPLE’S DEMOCRATIC REPUBLIC
        LBN
        LEBANON
        LBR
        LIBERIA
        LBY
        LIBYA
        LCA
        SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
        LIE
        LIECHTENSTEIN
        LKA
        SRI LANKA
        LSO
        LESOTHO
        LTU
        LITHUANIA
        LUX
        LUXEMBOURG
        LVA
        LATVIA
        MAC
        MACAO
        MAF
        SAINT MARTIN (FRENCH PART)
        MAR
        MOROCCO
        MCO
        MONACO
        MDA
        MOLDOVA, REPUBLIC OF
        MDG
        MADAGASCAR
        MDV
        MALDIVES
        MEX
        MEXICO
        MHL
        MARSHALL ISLANDS
        MKD
        MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
        MLI
        MALI
        MLT
        MALTA
        MMR
        MYANMAR
        MNE
        MONTENEGRO
        MNG
        MONGOLIA
        MNP
        NORTHERN MARIANA ISLANDS
        MOZ
        MOZAMBIQUE
        MRT
        MAURITANIA
        MSR
        MONTSERRAT
        MTQ
        MARTINIQUE
        MUS
        MAURITIUS
        MWI
        MALAWI
        MYS
        MALAYSIA
        MYT
        MAYOTTE
        NAM
        NAMIBIA
        NCL
        NEW CALEDONIA
        NER
        NIGER
        NFK
        NORFOLK ISLAND
        NGA
        NIGERIA
        NIC
        NICARAGUA
        NIU
        NIUE
        NLD
        NETHERLANDS
        NOR
        NORWAY
        NPL
        NEPAL
        NRU
        NAURU
        NZL
        NEW ZEALAND
        OMN
        OMAN
        PAK
        PAKISTAN
        PAN
        PANAMA
        PCN
        PITCAIRN
        PER
        PERU
        PHL
        PHILIPPINES
        PLW
        PALAU
        PNG
        PAPUA NEW GUINEA
        POL
        POLAND
        PRI
        PUERTO RICO
        PRK
        KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
        PRT
        PORTUGAL
        PRY
        PARAGUAY
        PSE
        PALESTINIAN TERRITORY, OCCUPIED
        PYF
        FRENCH POLYNESIA
        QAT
        QATAR
        REU
        RÉUNION
        ROU
        ROMANIA
        RUS
        RUSSIAN FEDERATION
        RWA
        RWANDA
        SAU
        SAUDI ARABIA
        SDN
        SUDAN
        SEN
        SENEGAL
        SGP
        SINGAPORE
        SGS
        SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
        SHN
        SAN MARINO
        SJM
        SVALBARD AND JAN MAYEN
        SLB
        SOLOMON ISLANDS
        SLE
        SIERRA LEONE
        SLV
        EL SALVADOR
        SMR
        SINT MAARTEN (DUTCH PART)
        SOM
        SOMALIA
        SPM
        HOLY SEE (VATICAN CITY STATE)
        SRB
        SERBIA
        SSD
        SOUTH SUDAN
        STP
        SAO TOME AND PRINCIPE
        SUR
        SURINAME
        SVK
        SLOVAKIA
        SVN
        SLOVENIA
        SWE
        SWEDEN
        SWZ
        SWAZILAND
        SXM
        SAINT PIERRE AND MIQUELON
        SYC
        SEYCHELLES
        SYR
        SYRIAN ARAB REPUBLIC
        TCA
        TURKS AND CAICOS ISLANDS
        TCD
        CHAD
        TGO
        TOGO
        THA
        THAILAND
        TJK
        TAJIKISTAN
        TKL
        TOKELAU
        TKM
        TURKMENISTAN
        TLS
        TIMOR-LESTE
        TON
        TONGA
        TTO
        TRINIDAD AND TOBAGO
        TUN
        TUNISIA
        TUR
        TURKEY
        TUV
        TUVALU
        TWN
        TAIWAN, PROVINCE OF CHINA
        TZA
        TANZANIA, UNITED REPUBLIC OF
        UGA
        UGANDA
        UKR
        UKRAINE
        UMI
        UNITED STATES MINOR OUTLYING ISLANDS
        URY
        URUGUAY
        USA
        UNITED STATES
        UZB
        UZBEKISTAN
        VAT
        SAINT VINCENT AND THE GRENADINES
        VCT
        SAINT LUCIA
        VEN
        VENEZUELA, BOLIVARIAN REPUBLIC OF
        VGB
        VIRGIN ISLANDS, BRITISH
        VIR
        VIRGIN ISLANDS, U.S.
        VNM
        VIET NAM
        VUT
        VANUATU
        WLF
        WALLIS AND FUTUNA
        WSM
        SAMOA
        YEM
        YEMEN
        ZAF
        SOUTH AFRICA
        ZMB
        ZAMBIA
        ZWE
        ZIMBABWE
    • allowedCardArea
      presence
      Optional
      Interface version
      4

      List identifier of card countries allowed to make a payment. Countries are grouped by geographical area.

      List of values
      EEA
      Member States in the European Economic Area: AUT, BEL, BGR, CHE, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ISL, ITA, LIE, LTU, LUX, LVA, MLT, NLD, NOR, POL, PRT, ROM, SVK, SVN, SWE
      EFTA
      Member States in the free trade zone (European Free Trade Association): ISL, LIE, NOR, CHE
      FRJEL
      List of countries authorised for French online games: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, MLT, NLD, NOR, POL, PRT, ROM, HUN, IRL, ISL, ITA, LTU, LUX, LVA, SVK, SVN, SWE
      UEUR
      The Member States in the European Union: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ITA, LTU, LUX, LVA, MLT, NLD, POL, PRT, ROM, SVK, SVN, SWE
      ZEURO
      Member States in the Eurozone (EMU: Economic and Monetary Union): AUT, BEL, CYP, DEU, ESP, EST, FIN, FRA, GRC, IRL, ITA, LTU, LUX, LVA, MLT, NLD, PRT, SVK, SVN
    • deniedCardArea
      presence
      Optional
      Interface version
      4

      Identifier of a predefined list of card countries refused by the merchant.

      List of values
      EEA
      Member States in the European Economic Area: AUT, BEL, BGR, CHE, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ISL, ITA, LIE, LTU, LUX, LVA, MLT, NLD, NOR, POL, PRT, ROM, SVK, SVN, SWE
      EFTA
      Member States in the free trade zone (European Free Trade Association): ISL, LIE, NOR, CHE
      FRJEL
      List of countries authorised for French online games: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, MLT, NLD, NOR, POL, PRT, ROM, HUN, IRL, ISL, ITA, LTU, LUX, LVA, SVK, SVN, SWE
      UEUR
      The Member States in the European Union: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ITA, LTU, LUX, LVA, MLT, NLD, POL, PRT, ROM, SVK, SVN, SWE
      ZEURO
      Member States in the Eurozone (EMU: Economic and Monetary Union): AUT, BEL, CYP, DEU, ESP, EST, FIN, FRA, GRC, IRL, ITA, LTU, LUX, LVA, MLT, NLD, PRT, SVK, SVN
    • allowedCardCountryList
      presence
      Optional
      Interface version
      4

      List of card country codes allowed to make a payment. ISO 3166 list of country codes.

      Contains
      • country
        presence
        Optional
        Interface version
        4

        Country code for the address.

        List of values
        ABW
        ARUBA
        AFG
        AFGHANISTAN
        AGO
        ANGOLA
        AIA
        ANGUILLA
        ALA
        ÅLAND ISLANDS
        ALB
        ALBANIA
        AND
        ANDORRA
        ARE
        UNITED ARAB EMIRATES
        ARG
        ARGENTINA
        ARM
        ARMENIA
        ASM
        AMERICAN SAMOA
        ATA
        ANTARCTICA
        ATF
        FRENCH SOUTHERN TERRITORIES
        ATG
        ANTIGUA AND BARBUDA
        AUS
        AUSTRALIA
        AUT
        AUSTRIA
        AZE
        AZERBAIJAN
        BDI
        BURUNDI
        BEL
        BELGIUM
        BEN
        BENIN
        BES
        BONAIRE, SINT EUSTATIUS AND SABA
        BFA
        BURKINA FASO
        BGD
        BANGLADESH
        BGR
        BULGARIA
        BHR
        BAHRAIN
        BHS
        BAHAMAS
        BIH
        BOSNIA AND HERZEGOVINA
        BLM
        SAINT KITTS AND NEVIS
        BLR
        BELARUS
        BLZ
        BELIZE
        BMU
        BERMUDA
        BOL
        BOLIVIA, PLURINATIONAL STATE OF
        BRA
        BRAZIL
        BRB
        BARBADOS
        BRN
        BRUNEI DARUSSALAM
        BTN
        BHUTAN
        BVT
        BOUVET ISLAND
        BWA
        BOTSWANA
        CAF
        CENTRAL AFRICAN REPUBLIC
        CAN
        CANADA
        CCK
        COCOS (KEELING) ISLANDS
        CHE
        SWITZERLAND
        CHL
        CHILE
        CHN
        CHINA
        CIV
        CÔTE D’IVOIRE
        CMR
        CAMEROON
        COD
        CONGO, THE DEMOCRATIC REPUBLIC OF THE
        COG
        CONGO
        COK
        COOK ISLANDS
        COL
        COLOMBIA
        COM
        COMOROS
        CPV
        CAPE VERDE
        CRI
        COSTA RICA
        CUB
        CUBA
        CUW
        CURAÇAO
        CXR
        CHRISTMAS ISLAND
        CYM
        CAYMAN ISLANDS
        CYP
        CYPRUS
        CZE
        CZECH REPUBLIC
        DEU
        GERMANY
        DJI
        DJIBOUTI
        DMA
        DOMINICA
        DNK
        DENMARK
        DOM
        DOMINICAN REPUBLIC
        DZA
        ALGERIA
        ECU
        ECUADOR
        EGY
        EGYPT
        ERI
        ERITREA
        ESH
        WESTERN SAHARA
        ESP
        SPAIN
        EST
        ESTONIA
        ETH
        ETHIOPIA
        FIN
        FINLAND
        FJI
        FIJI
        FLK
        FALKLAND ISLANDS (MALVINAS)
        FRA
        FRANCE
        FRO
        FAROE ISLANDS
        FSM
        MICRONESIA, FEDERATED STATES OF
        GAB
        GABON
        GBR
        UNITED KINGDOM
        GEO
        GEORGIA
        GGY
        GUERNSEY
        GHA
        GHANA
        GIB
        GIBRALTAR
        GIN
        GUINEA
        GLP
        GUADELOUPE
        GMB
        GAMBIA
        GNB
        GUINEA-BISSAU
        GNQ
        EQUATORIAL GUINEA
        GRC
        GREECE
        GRD
        GRENADA
        GRL
        GREENLAND
        GTM
        GUATEMALA
        GUF
        FRENCH GUIANA
        GUM
        GUAM
        GUY
        GUYANA
        HKG
        HONG KONG
        HMD
        HEARD ISLAND AND MCDONALD ISLANDS
        HND
        HONDURAS
        HRV
        CROATIA
        HTI
        HAITI
        HUN
        HUNGARY
        IDN
        INDONESIA
        IMN
        ISLE OF MAN
        IND
        INDIA
        IOT
        BRITISH INDIAN OCEAN TERRITORY
        IRL
        IRELAND
        IRN
        IRAN, ISLAMIC REPUBLIC OF
        IRQ
        IRAQ
        ISL
        ICELAND
        ISR
        ISRAEL
        ITA
        ITALY
        JAM
        JAMAICA
        JEY
        JERSEY
        JOR
        JORDAN
        JPN
        JAPAN
        KAZ
        KAZAKHSTAN
        KEN
        KENYA
        KGZ
        KYRGYZSTAN
        KHM
        CAMBODIA
        KIR
        KIRIBATI
        KNA
        SAINT BARTHÉLEMY
        KOR
        KOREA, REPUBLIC OF
        KWT
        KUWAIT
        LAO
        LAO PEOPLE’S DEMOCRATIC REPUBLIC
        LBN
        LEBANON
        LBR
        LIBERIA
        LBY
        LIBYA
        LCA
        SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
        LIE
        LIECHTENSTEIN
        LKA
        SRI LANKA
        LSO
        LESOTHO
        LTU
        LITHUANIA
        LUX
        LUXEMBOURG
        LVA
        LATVIA
        MAC
        MACAO
        MAF
        SAINT MARTIN (FRENCH PART)
        MAR
        MOROCCO
        MCO
        MONACO
        MDA
        MOLDOVA, REPUBLIC OF
        MDG
        MADAGASCAR
        MDV
        MALDIVES
        MEX
        MEXICO
        MHL
        MARSHALL ISLANDS
        MKD
        MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
        MLI
        MALI
        MLT
        MALTA
        MMR
        MYANMAR
        MNE
        MONTENEGRO
        MNG
        MONGOLIA
        MNP
        NORTHERN MARIANA ISLANDS
        MOZ
        MOZAMBIQUE
        MRT
        MAURITANIA
        MSR
        MONTSERRAT
        MTQ
        MARTINIQUE
        MUS
        MAURITIUS
        MWI
        MALAWI
        MYS
        MALAYSIA
        MYT
        MAYOTTE
        NAM
        NAMIBIA
        NCL
        NEW CALEDONIA
        NER
        NIGER
        NFK
        NORFOLK ISLAND
        NGA
        NIGERIA
        NIC
        NICARAGUA
        NIU
        NIUE
        NLD
        NETHERLANDS
        NOR
        NORWAY
        NPL
        NEPAL
        NRU
        NAURU
        NZL
        NEW ZEALAND
        OMN
        OMAN
        PAK
        PAKISTAN
        PAN
        PANAMA
        PCN
        PITCAIRN
        PER
        PERU
        PHL
        PHILIPPINES
        PLW
        PALAU
        PNG
        PAPUA NEW GUINEA
        POL
        POLAND
        PRI
        PUERTO RICO
        PRK
        KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
        PRT
        PORTUGAL
        PRY
        PARAGUAY
        PSE
        PALESTINIAN TERRITORY, OCCUPIED
        PYF
        FRENCH POLYNESIA
        QAT
        QATAR
        REU
        RÉUNION
        ROU
        ROMANIA
        RUS
        RUSSIAN FEDERATION
        RWA
        RWANDA
        SAU
        SAUDI ARABIA
        SDN
        SUDAN
        SEN
        SENEGAL
        SGP
        SINGAPORE
        SGS
        SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
        SHN
        SAN MARINO
        SJM
        SVALBARD AND JAN MAYEN
        SLB
        SOLOMON ISLANDS
        SLE
        SIERRA LEONE
        SLV
        EL SALVADOR
        SMR
        SINT MAARTEN (DUTCH PART)
        SOM
        SOMALIA
        SPM
        HOLY SEE (VATICAN CITY STATE)
        SRB
        SERBIA
        SSD
        SOUTH SUDAN
        STP
        SAO TOME AND PRINCIPE
        SUR
        SURINAME
        SVK
        SLOVAKIA
        SVN
        SLOVENIA
        SWE
        SWEDEN
        SWZ
        SWAZILAND
        SXM
        SAINT PIERRE AND MIQUELON
        SYC
        SEYCHELLES
        SYR
        SYRIAN ARAB REPUBLIC
        TCA
        TURKS AND CAICOS ISLANDS
        TCD
        CHAD
        TGO
        TOGO
        THA
        THAILAND
        TJK
        TAJIKISTAN
        TKL
        TOKELAU
        TKM
        TURKMENISTAN
        TLS
        TIMOR-LESTE
        TON
        TONGA
        TTO
        TRINIDAD AND TOBAGO
        TUN
        TUNISIA
        TUR
        TURKEY
        TUV
        TUVALU
        TWN
        TAIWAN, PROVINCE OF CHINA
        TZA
        TANZANIA, UNITED REPUBLIC OF
        UGA
        UGANDA
        UKR
        UKRAINE
        UMI
        UNITED STATES MINOR OUTLYING ISLANDS
        URY
        URUGUAY
        USA
        UNITED STATES
        UZB
        UZBEKISTAN
        VAT
        SAINT VINCENT AND THE GRENADINES
        VCT
        SAINT LUCIA
        VEN
        VENEZUELA, BOLIVARIAN REPUBLIC OF
        VGB
        VIRGIN ISLANDS, BRITISH
        VIR
        VIRGIN ISLANDS, U.S.
        VNM
        VIET NAM
        VUT
        VANUATU
        WLF
        WALLIS AND FUTUNA
        WSM
        SAMOA
        YEM
        YEMEN
        ZAF
        SOUTH AFRICA
        ZMB
        ZAMBIA
        ZWE
        ZIMBABWE
    • deniedIpCountryList
      presence
      Optional
      Interface version
      4

      List of buyer IP country codes not authorised to make a paymentISO 3166 list of country codes.

      Contains
      • country
        presence
        Optional
        Interface version
        4

        Country code for the address.

        List of values
        ABW
        ARUBA
        AFG
        AFGHANISTAN
        AGO
        ANGOLA
        AIA
        ANGUILLA
        ALA
        ÅLAND ISLANDS
        ALB
        ALBANIA
        AND
        ANDORRA
        ARE
        UNITED ARAB EMIRATES
        ARG
        ARGENTINA
        ARM
        ARMENIA
        ASM
        AMERICAN SAMOA
        ATA
        ANTARCTICA
        ATF
        FRENCH SOUTHERN TERRITORIES
        ATG
        ANTIGUA AND BARBUDA
        AUS
        AUSTRALIA
        AUT
        AUSTRIA
        AZE
        AZERBAIJAN
        BDI
        BURUNDI
        BEL
        BELGIUM
        BEN
        BENIN
        BES
        BONAIRE, SINT EUSTATIUS AND SABA
        BFA
        BURKINA FASO
        BGD
        BANGLADESH
        BGR
        BULGARIA
        BHR
        BAHRAIN
        BHS
        BAHAMAS
        BIH
        BOSNIA AND HERZEGOVINA
        BLM
        SAINT KITTS AND NEVIS
        BLR
        BELARUS
        BLZ
        BELIZE
        BMU
        BERMUDA
        BOL
        BOLIVIA, PLURINATIONAL STATE OF
        BRA
        BRAZIL
        BRB
        BARBADOS
        BRN
        BRUNEI DARUSSALAM
        BTN
        BHUTAN
        BVT
        BOUVET ISLAND
        BWA
        BOTSWANA
        CAF
        CENTRAL AFRICAN REPUBLIC
        CAN
        CANADA
        CCK
        COCOS (KEELING) ISLANDS
        CHE
        SWITZERLAND
        CHL
        CHILE
        CHN
        CHINA
        CIV
        CÔTE D’IVOIRE
        CMR
        CAMEROON
        COD
        CONGO, THE DEMOCRATIC REPUBLIC OF THE
        COG
        CONGO
        COK
        COOK ISLANDS
        COL
        COLOMBIA
        COM
        COMOROS
        CPV
        CAPE VERDE
        CRI
        COSTA RICA
        CUB
        CUBA
        CUW
        CURAÇAO
        CXR
        CHRISTMAS ISLAND
        CYM
        CAYMAN ISLANDS
        CYP
        CYPRUS
        CZE
        CZECH REPUBLIC
        DEU
        GERMANY
        DJI
        DJIBOUTI
        DMA
        DOMINICA
        DNK
        DENMARK
        DOM
        DOMINICAN REPUBLIC
        DZA
        ALGERIA
        ECU
        ECUADOR
        EGY
        EGYPT
        ERI
        ERITREA
        ESH
        WESTERN SAHARA
        ESP
        SPAIN
        EST
        ESTONIA
        ETH
        ETHIOPIA
        FIN
        FINLAND
        FJI
        FIJI
        FLK
        FALKLAND ISLANDS (MALVINAS)
        FRA
        FRANCE
        FRO
        FAROE ISLANDS
        FSM
        MICRONESIA, FEDERATED STATES OF
        GAB
        GABON
        GBR
        UNITED KINGDOM
        GEO
        GEORGIA
        GGY
        GUERNSEY
        GHA
        GHANA
        GIB
        GIBRALTAR
        GIN
        GUINEA
        GLP
        GUADELOUPE
        GMB
        GAMBIA
        GNB
        GUINEA-BISSAU
        GNQ
        EQUATORIAL GUINEA
        GRC
        GREECE
        GRD
        GRENADA
        GRL
        GREENLAND
        GTM
        GUATEMALA
        GUF
        FRENCH GUIANA
        GUM
        GUAM
        GUY
        GUYANA
        HKG
        HONG KONG
        HMD
        HEARD ISLAND AND MCDONALD ISLANDS
        HND
        HONDURAS
        HRV
        CROATIA
        HTI
        HAITI
        HUN
        HUNGARY
        IDN
        INDONESIA
        IMN
        ISLE OF MAN
        IND
        INDIA
        IOT
        BRITISH INDIAN OCEAN TERRITORY
        IRL
        IRELAND
        IRN
        IRAN, ISLAMIC REPUBLIC OF
        IRQ
        IRAQ
        ISL
        ICELAND
        ISR
        ISRAEL
        ITA
        ITALY
        JAM
        JAMAICA
        JEY
        JERSEY
        JOR
        JORDAN
        JPN
        JAPAN
        KAZ
        KAZAKHSTAN
        KEN
        KENYA
        KGZ
        KYRGYZSTAN
        KHM
        CAMBODIA
        KIR
        KIRIBATI
        KNA
        SAINT BARTHÉLEMY
        KOR
        KOREA, REPUBLIC OF
        KWT
        KUWAIT
        LAO
        LAO PEOPLE’S DEMOCRATIC REPUBLIC
        LBN
        LEBANON
        LBR
        LIBERIA
        LBY
        LIBYA
        LCA
        SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
        LIE
        LIECHTENSTEIN
        LKA
        SRI LANKA
        LSO
        LESOTHO
        LTU
        LITHUANIA
        LUX
        LUXEMBOURG
        LVA
        LATVIA
        MAC
        MACAO
        MAF
        SAINT MARTIN (FRENCH PART)
        MAR
        MOROCCO
        MCO
        MONACO
        MDA
        MOLDOVA, REPUBLIC OF
        MDG
        MADAGASCAR
        MDV
        MALDIVES
        MEX
        MEXICO
        MHL
        MARSHALL ISLANDS
        MKD
        MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
        MLI
        MALI
        MLT
        MALTA
        MMR
        MYANMAR
        MNE
        MONTENEGRO
        MNG
        MONGOLIA
        MNP
        NORTHERN MARIANA ISLANDS
        MOZ
        MOZAMBIQUE
        MRT
        MAURITANIA
        MSR
        MONTSERRAT
        MTQ
        MARTINIQUE
        MUS
        MAURITIUS
        MWI
        MALAWI
        MYS
        MALAYSIA
        MYT
        MAYOTTE
        NAM
        NAMIBIA
        NCL
        NEW CALEDONIA
        NER
        NIGER
        NFK
        NORFOLK ISLAND
        NGA
        NIGERIA
        NIC
        NICARAGUA
        NIU
        NIUE
        NLD
        NETHERLANDS
        NOR
        NORWAY
        NPL
        NEPAL
        NRU
        NAURU
        NZL
        NEW ZEALAND
        OMN
        OMAN
        PAK
        PAKISTAN
        PAN
        PANAMA
        PCN
        PITCAIRN
        PER
        PERU
        PHL
        PHILIPPINES
        PLW
        PALAU
        PNG
        PAPUA NEW GUINEA
        POL
        POLAND
        PRI
        PUERTO RICO
        PRK
        KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
        PRT
        PORTUGAL
        PRY
        PARAGUAY
        PSE
        PALESTINIAN TERRITORY, OCCUPIED
        PYF
        FRENCH POLYNESIA
        QAT
        QATAR
        REU
        RÉUNION
        ROU
        ROMANIA
        RUS
        RUSSIAN FEDERATION
        RWA
        RWANDA
        SAU
        SAUDI ARABIA
        SDN
        SUDAN
        SEN
        SENEGAL
        SGP
        SINGAPORE
        SGS
        SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
        SHN
        SAN MARINO
        SJM
        SVALBARD AND JAN MAYEN
        SLB
        SOLOMON ISLANDS
        SLE
        SIERRA LEONE
        SLV
        EL SALVADOR
        SMR
        SINT MAARTEN (DUTCH PART)
        SOM
        SOMALIA
        SPM
        HOLY SEE (VATICAN CITY STATE)
        SRB
        SERBIA
        SSD
        SOUTH SUDAN
        STP
        SAO TOME AND PRINCIPE
        SUR
        SURINAME
        SVK
        SLOVAKIA
        SVN
        SLOVENIA
        SWE
        SWEDEN
        SWZ
        SWAZILAND
        SXM
        SAINT PIERRE AND MIQUELON
        SYC
        SEYCHELLES
        SYR
        SYRIAN ARAB REPUBLIC
        TCA
        TURKS AND CAICOS ISLANDS
        TCD
        CHAD
        TGO
        TOGO
        THA
        THAILAND
        TJK
        TAJIKISTAN
        TKL
        TOKELAU
        TKM
        TURKMENISTAN
        TLS
        TIMOR-LESTE
        TON
        TONGA
        TTO
        TRINIDAD AND TOBAGO
        TUN
        TUNISIA
        TUR
        TURKEY
        TUV
        TUVALU
        TWN
        TAIWAN, PROVINCE OF CHINA
        TZA
        TANZANIA, UNITED REPUBLIC OF
        UGA
        UGANDA
        UKR
        UKRAINE
        UMI
        UNITED STATES MINOR OUTLYING ISLANDS
        URY
        URUGUAY
        USA
        UNITED STATES
        UZB
        UZBEKISTAN
        VAT
        SAINT VINCENT AND THE GRENADINES
        VCT
        SAINT LUCIA
        VEN
        VENEZUELA, BOLIVARIAN REPUBLIC OF
        VGB
        VIRGIN ISLANDS, BRITISH
        VIR
        VIRGIN ISLANDS, U.S.
        VNM
        VIET NAM
        VUT
        VANUATU
        WLF
        WALLIS AND FUTUNA
        WSM
        SAMOA
        YEM
        YEMEN
        ZAF
        SOUTH AFRICA
        ZMB
        ZAMBIA
        ZWE
        ZIMBABWE
    • deniedIpArea
      presence
      Optional
      Interface version
      4

      Name of a pre-established list of buyer IP country codes not authorised to make a payment.

      List of values
      EEA
      Member States in the European Economic Area: AUT, BEL, BGR, CHE, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ISL, ITA, LIE, LTU, LUX, LVA, MLT, NLD, NOR, POL, PRT, ROM, SVK, SVN, SWE
      EFTA
      Member States in the free trade zone (European Free Trade Association): ISL, LIE, NOR, CHE
      FRJEL
      List of countries authorised for French online games: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, MLT, NLD, NOR, POL, PRT, ROM, HUN, IRL, ISL, ITA, LTU, LUX, LVA, SVK, SVN, SWE
      UEUR
      The Member States in the European Union: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ITA, LTU, LUX, LVA, MLT, NLD, POL, PRT, ROM, SVK, SVN, SWE
      ZEURO
      Member States in the Eurozone (EMU: Economic and Monetary Union): AUT, BEL, CYP, DEU, ESP, EST, FIN, FRA, GRC, IRL, ITA, LTU, LUX, LVA, MLT, NLD, PRT, SVK, SVN
    • bypassCtrlList
      presence
      Optional
      Interface version
      4

      List of antifraud rules provided by the merchant to bypass current transaction rules.

      List of values
      3DSStatus
      Disable the 3-D Secure authentication rule
      All
      Disable all rules
      BlackBic
      Disable the BIC blacklist rule
      BlackBinCard
      Disable the BIN range blacklist rule
      BlackCard
      Disable the Card number blacklist rule
      BlackCustomerId
      Disable the Customer ID blacklist rule
      BlackCustomerName
      Disable the Customer name blacklist rule
      BlackEmail
      Disable the E-mail address blackslit rule
      BlackIban
      Disable the IBAN blacklist rule
      BlackIp
      Disable the IP address blacklist rule
      BlackMandate
      Disable the Mandate blacklist rule
      BlackPhoneNumber
      Disable the Phone number blacklist rule
      BlackPostalCode
      Disable the Postal code blacklist rule
      CBScheme
      Disable the CB scheme card rule
      CapCollarAmount
      Disable the Amount range rule
      CardCountry
      Disable the Card country rule
      CommercialCard
      Disable the Commercial card (and card country) rule
      ECard
      Disable the Virtual card rule
      EmailSyntax
      Disable the E-mail address syntax rule
      ExpiryDate
      Disable the Card expiry date rule
      FreeEmail
      Disable the Free e-mail address rule
      GreyBic
      Disable the BIC greylist rule
      GreyBinCard
      Disable the BIN range greylist rule
      GreyCard
      Disable the Card number greylist rule
      GreyCustomerId
      Disable the Customer ID greylist rule
      GreyCustomerName
      Disable the Customer name greylist rule
      GreyEmail
      Disable the E-mail address greylist rule
      GreyIban
      Disable the IBAN greylist rule
      GreyIp
      Disable the IP address greylist rule
      GreyMandate
      Disable the Mandate greylist rule
      GreyPhoneNumber
      Disable the Phone number greylist rule
      GreyPostalCode
      Disable the postal code greylist rule
      HotList
      Disable the Lost and stolen card rule
      IbanCountry
      Disable the IBAN country rule
      IpCountry
      Disable the IP address country rule
      IpReputations
      Disable the IP address reputation rule
      MaxCardPerCustomerId
      Disable the Number of cards per customer rule
      MaxCardPerIp
      Disable the Number of cards per IP address rule
      MaxCustidPerIban
      Disable the Number of customers per IBAN rule
      MaxCustomerIdPerCard
      Disable the Number of customers per card rule
      MaxIbanPerCustid
      Disable the Number of IBAN per customer rule
      MaxIbanPerIp
      Disable the Number of IBAN per IP address rule
      MaxIpPerIban
      Disable the Number of IP address per IBAN rule
      MaxMandatePerIp
      Disable the Number of mandates per IP address rule
      MaxQuantityPerProduct
      Disable the Product quantity rule
      PrepaidCardForbidden
      Disable the prepaid card rule
      RiskyProductList
      Disable the Risky product list rule
      RiskyProductQuantity
      Disable the Risky product quantity rule
      RiskyProductRatio
      Disable the Risky product ratio rule
      SimilarityBillingCardCountry
      Disable the Delivery and card country rule
      SimilarityDeliveryBillingCountry
      Disable the Delivery and billing country rule
      SimilarityDeliveryBillingPostalCode
      Disable the delivery and billing postal code rule
      SimilarityDeliveryCardCountry
      Disable the Delivery and card country rule
      SimilarityDeliveryIbanCountry
      Disable the Delivery and IBAN country rule
      SimilarityIpCardCountry
      Disable the IP and card country rule
      SimilarityIpIbanCountry
      Disable the IBAN country rule
      SimilarityPhoneIbanCountry
      Disable the Phone and IBAN country rule
      SystematicAuthorizationCard
      Disable the Systematic authorisation card rule
      VelocityCard
      Disable the Card velocity rule
      VelocityCustomerId
      Disable the Customer ID velocity rule
      VelocityIban
      Disable the IBAN velocity rule
      VelocityIp
      Disable the IP address velocity rule
      VelocityMandate
      Disable the Mandate velocity rule
      WhiteBic
      Disable the BIC whitelist rule
      WhiteBinCard
      Disable the BIN range whitelist rule
      WhiteCard
      Disable the Card number whitelist rule
      WhiteCustomerId
      Disable the Customer ID whitelist rule
      WhiteCustomerName
      Disable the Customer name whitelist rule
      WhiteEmail
      Disable the E-mail address whitelist rule
      WhiteIban
      Disable the IBAN whitelist rule
      WhiteIp
      Disable the IP address whitelist rule
      WhiteMandate
      Disable the Mandate whitelist rule
      WhitePhoneNumber
      Disable the Phone number whitelist rule
      WhitePostalCode
      Disable the Postal code whitelist rule
    • bypass3DS
      presence
      Optional
      Interface version
      4

      Indicator used by the merchant to bypass the 3-D Secure procedure.

      List of values
      ALL
      Bypass the 3DS procedure (for CB, VISA, MASTERCARD payments)
      MERCHANT_WALLET
      Bypass the 3DS procedure during “OneClick” payment for CB, VISA, MASTERCARD payments
      WIP_BANCONTACT
      Bypass the 3DS procedure during “OneClick” payment for BANCONTACT payment
    • allowedIpArea
      presence
      Optional
      Interface version
      4

      List identifier of IP countries allowed to make a payment.

      List of values
      EEA
      Member States in the European Economic Area: AUT, BEL, BGR, CHE, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ISL, ITA, LIE, LTU, LUX, LVA, MLT, NLD, NOR, POL, PRT, ROM, SVK, SVN, SWE
      EFTA
      Member States in the free trade zone (European Free Trade Association): ISL, LIE, NOR, CHE
      FRJEL
      List of countries authorised for French online games: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, MLT, NLD, NOR, POL, PRT, ROM, HUN, IRL, ISL, ITA, LTU, LUX, LVA, SVK, SVN, SWE
      UEUR
      The Member States in the European Union: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ITA, LTU, LUX, LVA, MLT, NLD, POL, PRT, ROM, SVK, SVN, SWE
      ZEURO
      Member States in the Eurozone (EMU: Economic and Monetary Union): AUT, BEL, CYP, DEU, ESP, EST, FIN, FRA, GRC, IRL, ITA, LTU, LUX, LVA, MLT, NLD, PRT, SVK, SVN
    • riskManagementDynamicSettingList
      presence
      Optional
      Interface version
      4

      List of parameters of th setting information related to the antifraud rules to be dynamically overwritten.

      Contains
      • riskManagementDynamicSetting
        presence
        Optional
        Interface version
        4

        Parameters of the Setting information related to the antifraud rule to be dynamically overwritten.

        Contains
        • riskManagementDynamicParam
          presence
          Optional

          Parameter regarding the antifraud rule that is to be dynamically overwritten.

          List of values
          AllowedBillingCardCountryCombiList
          Deprecated value. For the “Billing and card country” rule, the parameter contains the list of the combinations of allowed billing country and card country to overwrite.
          AllowedCardCountryList
          Deprecated value. For the “Card country” rule, the parameter contains the list of allowed card countries to overwrite.
          AllowedCommercialCardCountryList
          Deprecated value. For “Commercial card (and card country)” rule, the parameter contains the list of allowed commercial card countries to overwrite.
          AllowedDeliveryCardCountryCombiList
          Deprecated value. For the “Delivery and card country” rule, the parameter contains the list of the combinations of allowed delivery country and card country to overwrite.
          AllowedIpCardCountryCombiList
          Deprecated value. For the “IP and card country” rule, the parameter contains the list of the combinations of allowed card country and IP address country to overwrite.
          AllowedIpCountryList
          Deprecated value. For the “IP address country” rule, the parameter contains the list of allowed IP address countries to overwrite.
          DeniedBillingCardCountryCombiList
          Deprecated value. For the “Billing and card country” rule, the parameter contains the list of the combinations of denied billing country and card country to overwrite.
          DeniedCardCountryList
          Deprecated value. For the “Card country” rule, the parameter contains the list of denied card countries to overwrite.
          DeniedCommercialCardCountryList
          Deprecated value. For “Commercial card (and card country)” rule, the parameter contains the list of denied commercial card countries to overwrite.
          DeniedDeliveryCardCountryCombiList
          Deprecated value. For the “Delivery and card country” rule, the parameter contains the list of the combinations of denied delivery country and card country to overwrite.
          DeniedIpCardCountryCombiList
          Deprecated value. For the “IP and card country” rule, the parameter contains the list of the combinations of denied card country and IP address country to overwrite.
          DeniedIpCountryList
          Deprecated value. For the “IP address country” rule, the parameter contains the list of denied IP address countries to overwrite.
          NDeniedBillingCardCountryCombiList
          Denied card and billing country combinations list
          NDeniedCardCountryList
          Denied card country list
          NDeniedCommercialCardCountryList
          Denied corprate card country list
          NDeniedDeliveryCardCountryCombiList
          Denied card and delivery country combinations list
          NDeniedDeliveryIbanCountryCombiList
          Denied IBAN and delivery country combinations list
          NDeniedExceptBillingCardCountryCombiList
          Denied card and billing country combinations except…
          NDeniedExceptCardCountryList
          Denied card countries except…
          NDeniedExceptCommercialCardCountryList
          Denied corprate card countries except…
          NDeniedExceptDeliveryCardCountryCombiList
          Denied card and delivery country combinations except…
          NDeniedExceptDeliveryIbanCountryCombiList
          Denied IBAN and delivery country combinations except…
          NDeniedExceptIbanCountryList
          Denied IBAN countries except…
          NDeniedExceptIpCardCountryCombiList
          Denied card and IP address country combinations except…
          NDeniedExceptIpCountryList
          Denied IP address countries except…
          NDeniedExceptIpIbanCountryCombiList
          Denied IBAN and IP address country combinations except…
          NDeniedExceptPhoneIbanCountryCombiList
          Denied phone number and delivery country combinations except…
          NDeniedIbanCountryList
          Denied IBAN country list
          NDeniedIpCardCountryCombiList
          Denied card and IP address country combinations list
          NDeniedIpCountryList
          Denied IP address country list
          NDeniedIpIbanCountryCombiList
          Denied IBAN and IP address country combinations list
          NDeniedPhoneIbanCountryCombiList
          Denied phone number and delivery country combinations list
          PAllowedBillingCardCountryCombiList
          Encouraged card and billing country combinations list
          PAllowedCardCountryList
          Encouraged card country list
          PAllowedCommercialCardCountryList
          Encouraged corprate card country list
          PAllowedDeliveryCardCountryCombiList
          Encouraged card and delivery country combinations list
          PAllowedDeliveryIbanCountryCombiList
          Encouraged IBAN and delivery country combinations list
          PAllowedEncouragedIbanCountryList
          Encouraged IBAN country list
          PAllowedExceptBillingCardCountryCombiList
          Encouraged card and billing country combinations except…
          PAllowedExceptCardCountryList
          Encouraged card countries except…
          PAllowedExceptCommercialCardCountryList
          Encouraged corprate card countries except…
          PAllowedExceptDeliveryCardCountryCombiList
          Encouraged card and delivery country combinations except…
          PAllowedExceptDeliveryIbanCountryCombiList
          Encouraged IBAN and delivery country combinations except…
          PAllowedExceptIpCardCountryCombiList
          Encouraged card and IP address country combinations except…
          PAllowedExceptIpCountryList
          Encouraged IP address countries except…
          PAllowedExceptIpIbanCountryCombiList
          Encouraged IBAN and IP address country combinations except…
          PAllowedExceptPhoneIbanCountryCombiList
          Encouraged phone number and delivery country combinations except…
          PAllowedIbanCountryList
          Encouraged IBAN countries except…
          PAllowedIpCardCountryCombiList
          Encouraged card and IP address country combinations list
          PAllowedIpCountryList
          Encouraged IP address country list
          PAllowedIpIbanCountryCombiList
          Encouraged IBAN and IP address country combinations list
          PAllowedPhoneIbanCountryCombiList
          Encouraged phone number and delivery country combinations list
        • riskManagementDynamicValue
          presence
          Optional

          New parameter value regarding to the antifraud rule to be dynamically overwritten.

  • guaranteeIndicator
    presence
    Optional
    Interface version
    4
    Order
    26

    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
  • holderAuthentRelegation
    presence
    Optional
    Interface version
    4
    Order
    27

    Please see “holderAuthentRelegationCode”. This data is used by Sips Office for versions lower than 2.17.

  • holderAuthentStatus
    presence
    Optional
    Interface version
    4
    Order
    28

    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.
  • holderContact
    presence
    Optional
    Interface version XML
    8

    Contains contact details of the payment mean holder.

    Contains
  • initialAuthenticationData
    presence
    Optional
    Interface version XML
    21
    Interface version CSV
    21
    Order
    54

    Contains the information on the initial cardholder’s authentication (CIT).

    Contains
    • initialAuthentDateTime
      presence
      Optional
      Interface version XML
      21
      Interface version CSV
      21

      UTC date and time of the initial authentication.

    • initialChallengeMode3DS
      presence
      Optional
      Interface version XML
      21
      Interface version CSV
      21

      Holder authentication level requested on initial transaction.

      List of values
      CHALLENGE
      The merchant desired authentication challenge mode is to have a client authentication. In other words, it is a “challenge” request
      CHALLENGE_MANDATE
      The merchant need is to apply the regulatory mode to have a strong customer authentication (for example for the first payment of payment schedule)
      NO_CHALLENGE
      The merchant desired authentication challenge mode is to have no customer authentication. In other words, it is a “challenge” request
      NO_CHALLENGE_DTA
      The merchant does not want customer authentication in a Direct to Authorize kinematics
      NO_CHALLENGE_TRA_ACQ
      The merchant desired no authentication of the cardholder by invoking the TRA acquirer exemption. It’s a request for “Frictionless”.
      NO_CHALLENGE_TRA_ACQ_DTA
      The merchant wishes to bypass cardholder authentication by invoking the Acquirer TRA exemption. This is a Direct to Authorize request.
      NO_PREFERENCE
      The merchant has no desired authentication challenge mode
    • initialHolderAuthentProgram
      presence
      Optional
      Interface version XML
      21
      Interface version CSV
      21

      Authentication program on initial transaction

      List of values
      1EUROCOM
      Cofidis Pay 5x10x20x authentication
      3DS
      3-D Secure authentication
      3DS_V2
      3-D Secure v2 authentication program. This value is accepted for the following versions Since the version 2.24 for Sips Paypage Since the version 2.24 for Sips Office Since the version 2.5 for Sips In-App
      APPLEPAY
      Apple Pay authentication
      ARP
      ARP authentication
      BCMCMOBILE
      BCMC authentication
      MASTERPASS
      MasterPass authentication
      NOT_SPECIFIED
      No specified authentication program
      NO_AUTHENT
      Equivalent to NO_AUTHENT_METHOD it is an alternative value used in the transaction report
      NO_AUTHENT_METHOD
      no authentication program
      PAYLIB
      Paylib authentication
      SAMSUNGPAY
      Samsung Pay authentication
      THREE_DS
      Equivalent to 3DS it is an alternative value used in the transaction report
    • initialHolderAuthentType
      presence
      Optional
      Interface version XML
      21
      Interface version CSV
      21

      Cardholder authentication type applied by the issuer of the card on initial transaction. Field valued in 3-D Secure v2.

      List of values
      CHALLENGE
      Authentication on challenge flow (redirection of authentication pages to cardholder)
      FRICTIONLESS
      Authentication on frictionless flow
      FRICTIONLESS_DELEGATE
      Deprecated - Authentication on delegated frictionless flow (DS manage the authentication instead of issuer in case of technical issues
      NONE
      No authentication could be implemented
  • initialSchemeTransactionIdentifier
    presence
    Optional
    Interface version XML
    14
    Interface version CSV
    14
    Order
    48

    Transaction reference used to perform MIT-CIT chaining.

  • maskedPan
    presence
    Optional
    Interface version
    4
    Order
    29

    Masked Primary Account Number. In the case of wallets, masked PAN of the payment mean registered in the wallet.

  • merchantTransactionDateTime
    presence
    Optional
    Interface version
    4
    Order
    11

    Date and time of the transaction, set by the merchant at the merchant’s local time (in the merchant’s time zone)

  • orderContext
    presence
    Optional
    Interface version XML
    8

    Contains specific information regarding the order context

    Contains
  • orderId
    presence
    Optional
    Interface version
    4
    Order
    13

    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

  • paymentAccountReference
    presence
    Optional
    Interface version XML
    12
    Interface version CSV
    12
    Order
    43

    Reference of the bank account associated to the card used for the payment.

  • paymentMeanData
    presence
    Optional
    Interface version XML
    14
    Interface version CSV
    14
    Order
    47

    Contains specific information regarding the payment method used by the buyer.

    Contains
  • paymentMeanId
    presence
    Optional
    Interface version
    4
    Order
    14

    Payment mean rank in Worldline Sips wallet.

  • paymentMeansBrand
    presence
    Optional
    Interface version XML
    13
    Interface version CSV
    13
    Order
    45

    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_3X_SANSFRAIS
    CACF Payment in 3 installments free of charge paymentMeanBrandType: ONLINE_CREDIT
    CACF_4X
    CACF Payment in 4 installments paymentMeanBrandType: ONLINE_CREDIT
    CACF_4X_SANSFRAIS
    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 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
  • paymentMeansBrandSelectionStatus
    presence
    Optional
    Interface version XML
    13
    Interface version CSV
    13
    Order
    46

    Status of the processing of the brand application selection on paypage.

    List of values
    APPLIED_DEFAULT
    The cardholder accepted the default merchant choice
    APPLIED_HOLDER
    The cardholder selected a card brand different from the default merchant choice
    Empty
    Transaction not processed according to the payment mean brand selection rules
    NOT_APPLICABLE
    Card number filled is not a cobadged card
  • paymentPattern
    presence
    Optional
    Interface version CSV
    5
    Order
    35

    Type of payment (per operation, 1st recurring payment etc).

    List of values
    INSTALMENT
    transactionInitiator : CIT, MIT Payment by instalment
    MULTIPLE_1
    transactionInitiator : CIT First payment for a purchase dispatched in several shipments
    MULTIPLE_N
    transactionInitiator : MIT Nth payment for a purchase dispatched in several shipments
    ONE_SHOT
    transactionInitiator : CIT One shot payment (default value)
    RECURRING_1
    transactionInitiator : CIT Subscription payment first
    RECURRING_N
    transactionInitiator : MIT Abonnement Nème paiement
  • preAuthorisationProfile
    presence
    Optional
    Interface version XML
    6

    Name of the applied pre-authorisation profile.

  • preAuthorisationProfileValue
    presence
    Optional
    Interface version XML
    6

    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 XML
    6

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

    Contains
  • reattemptEndDateTime
    presence
    Optional
    Interface version XML
    20
    Interface version CSV
    20
    Order
    53

    End date of the allowed-reattempt period, where trying again an authorization request on a refused transaction is allowed

  • reattemptMax
    presence
    Optional
    Interface version XML
    20
    Interface version CSV
    20
    Order
    51

    Maximal number of allowed reattempts during the allowed-reattempt period

  • reattemptMode
    presence
    Optional
    Interface version XML
    20
    Interface version CSV
    20
    Order
    50

    Condition for a reattempt after a refused authorization.

    List of values
    LATER
    Try again later
    NEVER
    Never try again
    UPDATE
    Provide new information before trying again
  • reattemptStartDateTime
    presence
    Optional
    Interface version XML
    20
    Interface version CSV
    20
    Order
    52

    Start date of the allowed-reattempt period, where trying again an authorization request on a refused transaction is allowed

  • responseCode
    presence
    Optional
    Interface version
    4
    Order
    31

    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
  • returnContext
    presence
    Optional
    Interface version
    4
    Order
    15

    Context of a buyer’’s order.All information transmitted in this field by the merchant during the payment request is sent back in the response without amendment.Attention : the following characters “|”, “«”, “»”, and «”» are not recommended in this field. If they are used, they will be returned as provided but they will be replaced by blanks in the Worldline Sips database.

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

  • s10TransactionReference
    presence
    Optional
    Interface version XML
    5
    Interface version CSV
    5
    Order
    21

    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
  • schemeTransactionIdentifier
    presence
    Optional
    Interface version XML
    12
    Interface version CSV
    12
    Order
    42

    Unique reference of the transaction calculated by the SAE (Authorisation server of the issuer) and returned in ther authorisation response.It allows to chain a MIT (Merchant Initiating Transaction) to a origin CIT (Customer Initiating Transaction)(Future use via the field initialSchemeTransactionIdentifier). Clarification on the format which is dependent on protocols and schemes: CB2A: ANS50 (FR acquirer) BXAP: N15 (BE acquirer) AMEX: N15 PAYPAL : ANS56

  • settlementArchivingReference
    presence
    Optional
    Interface version XML
    22
    Interface version CSV
    22
    Order
    55

    Data provided to the acquirer for processing settlements and reconciliations. By default generated by the Worldline Sips platform. Its supply by the merchant is subject to strong constraints. Contact Worldline Sips to use this data in requests.

  • shoppingCartDetail
    presence
    Optional
    Interface version XML
    8

    Information specific to the basket.

    Contains