creditHolder
To search in the page use Ctrl+F on your keyboard
This function allows the merchant who has the banking data of their clients to credit their account without any prior transaction.
Recommended interfaceVersion: CR_WS_2.58
Endpoints
-
- PROD
-
https://office-server.sips-services.com/rs-services/v2/cashManagement/creditHolder - method
- POST
-
- TEST
-
https://office-server.test.sips-services.com/rs-services/v2/cashManagement/creditHolder - method
- POST
-
- PROD
-
https://office-server.sips-services.com/services/v2/cashManagement?wsdl - method
- POST
-
- TEST
-
https://office-server.test.sips-services.com/services/v2/cashManagement?wsdl - method
- POST
Request
Required
-
amount- presence
- Required
- Interface version
- 2.0
Transaction amount. The amount must be transmitted in the smallest currency unit.For example in euros: an amount of EUR 10.50 must be transmitted in the form 1050.
-
currencyCode- presence
- Required
- Interface version
- 2.0
Currency code for the transaction. This code is ISO 4217 compatible.
List of values
032- Argentinean Peso
036- Australian Dollar
048- Bahrain Dinar
116- Cambodian Riel
124- Canadian Dollar
144- Sri Lanka Rupee
156- China Yuan Renminbi
191- Croatia Kuna
203- Czech Republic Koruna
208- Danes crown
344- Hong Kong dollar
348- Hungary Forint
352- Iceland Rupee
356- Indian rupee
376- Israel Shekel
392- Japanese Yen
410- South Korean Won
414- Kuwait Dinar
458- Malaysia Ringgit
480- Mauritius Rupee
484- Mexican Peso
524- Nepal Rupee
554- New Zealand Dollar
578- Norwegian crown
634- Qatar Riyal
643- Russia Ruble
682- Saudi Arabia Riyal
702- Singapore Dollar
710- South Africa Rand
752- Swedish crown
756- Swiss Franc
764- Thailand Baht
784- United Arab Emirates Dirham
788- Tunisia Dinar
826- Pound
840- American Dollar
901- Taiwan Dollar
941- Serbian Dinar
946- Roumania New Leu
949- New Turkish Lira
952- CFA Franc
953- CFP Franc
975- Bulgaria Lev
978- Euro
980- Ukraine Hryvnia
985- Poland Zloty
986- Brazilian Real
-
interfaceVersion- presence
- Required
- Interface version
- 2.0
Version of the interface used. It is composed of a prefix that varies according to the function used and a version number (e.g. IR_WS_2.47).
Please refer to the function page for the value to use. Use the latest interface version number.
List of values
CR_WS_2.- Sips Office (SOAP/JSON) interface for Cash Management functions.
-
keyVersion- presence
- Required
- Interface version
- 2.0
Version of the merchant’s secret key used to calculate the imprint of the message (key stored by the merchant to verify the imprint of the automatic and manual notifications).
-
merchantId- presence
- Required
- Interface version
- 2.0
Identifier of the shop, this value is provided to the merchant by Worldline Sips during the shop registration.
-
seal- presence
- Required
- Interface version
- 2.0
Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.
Optional
-
cardEffectiveDate- presence
- Optional
- Interface version
- 2.0
Indicates wether the card has a validity start date.
-
cardExpiryDate- presence
- Optional
- Interface version
- 2.0
Card expiry date. If the card does not have any expiry date, this field is empty.
-
cardNumber- presence
- Optional
- Interface version
- 2.0
Card number (format N19 unless the card number is a Token, and in this case, the format is ANS128).
-
cardScheme- presence
- Optional
- Interface version
- 2.0
Network name associated with the card.
List of values
ACCORD- Accord scheme
AMEX- American Express scheme
BCMC- Bancontact scheme
CB- Carte Bancaire 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)
-
cardSeqNumber- presence
- Optional
- Interface version
- 2.0
Card sequence number allocated by the issuer.
-
customerContact- presence
- Optional
- Interface version
- 2.39
Contains the customer’s information.
Contains
-
email- presence
- Optional
- Interface version
- 2.39
Contact’s email address.
-
firstname- presence
- Optional
- Interface version
- 2.39
First name of the contact.
-
gender- presence
- Optional
- Interface version
- 2.39
Gender of the contact, male (=M) or female (=F).
-
initials- presence
- Optional
- Interface version
- 2.39
contact initals
-
lastname- presence
- Optional
- Interface version
- 2.39
Last name of the contact.
-
mobile- presence
- Optional
- Interface version
- 2.39
Mobile phone number for the contact.
-
phone- presence
- Optional
- Interface version
- 2.39
Telephone number for the contact.
-
title- presence
- Optional
- Interface version
- 2.39
Title of the contact.
-
customerEmail- presence
- Optional
- Interface version
- 2.0
Depreciated, replaced by “email” in the container customerContact.
-
customerId- presence
- Optional
- Interface version
- 2.0
Customer identifier
Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data
As a subcontractor, Worldline processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.
Thus:
- The personal data specified in the DPA must only be transmitted to Worldline via the fields provided for this purpose (see data dictionary).
- All other personal data not listed in the DPA must not be transmitted to Worldline.
-
customerIpAddress- presence
- Optional
- Interface version
- 2.0
Buyer’s IP address.
-
holderContact- presence
- Optional
- Interface version
- 2.41
Contains contact details of the payment mean holder.
Contains
-
email- presence
- Optional
- Interface version
- 2.39
Contact’s email address.
-
firstname- presence
- Optional
- Interface version
- 2.39
First name of the contact.
-
gender- presence
- Optional
- Interface version
- 2.39
Gender of the contact, male (=M) or female (=F).
-
initials- presence
- Optional
- Interface version
- 2.39
contact initals
-
lastname- presence
- Optional
- Interface version
- 2.39
Last name of the contact.
-
mobile- presence
- Optional
- Interface version
- 2.39
Mobile phone number for the contact.
-
phone- presence
- Optional
- Interface version
- 2.39
Telephone number for the contact.
-
title- presence
- Optional
- Interface version
- 2.39
Title of the contact.
-
intermediateServiceProviderId- presence
- Optional
- Interface version
- 2.12
Identifier of the Service used by the merchant for the exchanges with the Worldline Sips platform.
-
invoiceReference- presence
- Optional
- Interface version
- 2.38
Invoice reference.
-
merchantLocationId- presence
- Optional
- Interface version
- 2.48
Merchant data identifying the location of his shop.
-
orderChannel- presence
- Optional
- Interface version
- 2.0
Order channel used (Internet, Telephone, Post, Fax etc), Internet is the default value.Use of this field should be reconciled with the conditions defined in the acquirer contract.
List of values
FAX- Fax order channel Acquiring contract: MOTO
INAPP- Order from a service inside an application (eg mobile) Acquiring contract: INTERNET
INTERNET- Internet order channel Acquiring contract: INTERNET
IVR- IVR order channel Acquiring contract: MOTO
MAIL_ORDER- Mail order channel Acquiring contract: MOTO
MINITEL- Obsolete
MOTO- Mail order or Telephone order channel without distinction (deprecated, use MAIL_ORDER or TELEPHONE_ORDER) Acquiring contract: MOTO
PROXI_ATTENDED- Obsolete
PROXI_SEMIATTENDED- Obsolete
PROXI_UNATTENDED- Obsolete
TELEPHONE_ORDER- Telephone order channel Acquiring contract: MOTO
-
orderContext- presence
- Optional
- Interface version
- 2.38
Contains specific information regarding the order context
Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data
As a subcontractor, Worldline processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.
Thus:
- The personal data specified in the DPA must only be transmitted to Worldline via the fields provided for this purpose (see data dictionary).
- All other personal data not listed in the DPA must not be transmitted to Worldline.
Contains
-
customerBrowserType- presence
- Optional
- Interface version
- 2.38
Browser type used by the customer. Example: Mozilla, AOL Explorer 9.5, MSN IE 9, MSN IE 10, MSN IE 11, etc …
-
customerANI- presence
- Optional
- Interface version
- 2.38
Phone number that customer used to checkout captured automatically by the merchant.
-
customerANIInformationIdentifier- presence
- Optional
- Interface version
- 2.38
Telephone company provided ANI Information Identifier associated with customerANI and it indicates call type. For example: cellular (61-63), payphone (27), toll free (24, 25), etc.
-
merchantOrderSpecificDataList- presence
- Optional
- Interface version
- 2.38
List of merchantOrderSpecificData objects. This list is limited to 20 items.
Contains
-
merchantOrderSpecificData- presence
- Optional
- Interface version
- 2.38
Contains the specific information of an order which can be transmitted to the acquirer according to the means of payment.
Contains
-
merchantOrderSpecificDataReference- presence
- Optional
- Interface version
- 2.38
Reference of the specific order data (the accepted values depend on the means of payment).
-
merchantOrderSpecificDataType- presence
- Optional
- Interface version
- 2.38
Type of the specific order data (the accepted values depend on the means of payment).
-
merchantOrderSpecificDataValue- presence
- Optional
- Interface version
- 2.38
Value of the specific order data.
-
customerHostName- presence
- Optional
- Interface version
- 2.38
Name of server to which customer is connected. Example: PHX.QW.AOL.COM.
-
orderId- presence
- Optional
- Interface version
- 2.0
Order number associated with the payment transaction.
Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data
As a subcontractor, Worldline processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.
Thus:
- The personal data specified in the DPA must only be transmitted to Worldline via the fields provided for this purpose (see data dictionary).
- All other personal data not listed in the DPA must not be transmitted to Worldline.
-
panType- presence
- Optional
- Interface version
- 2.1
Format of the Primary Account Number provided in the data cardNumber
List of values
CSE- The PAN provided is encrypted by CSE Javascript library (Client Side Encryption)
PAN- The PAN is provided in clear text
STKPAN- The provided PAN is a SchemeToken
TOKEN_PAN- The PAN provided is a token
VCO_PAN- Obsolete
-
paymentToken- presence
- Optional
- Interface version
- 2.39
Hosted Fields payment token to be sent when making calls to Sips Office and allowing you to find card payment information for classic or 3-D Secure payment, by wallet or not.
-
returnContext- presence
- Optional
- Interface version
- 2.0
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
As a subcontractor, Worldline processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.
Thus:
- The personal data specified in the DPA must only be transmitted to Worldline via the fields provided for this purpose (see data dictionary).
- All other personal data not listed in the DPA must not be transmitted to Worldline.
-
s10TransactionReference- presence
- Optional
- Interface version
- 2.6
Contains the identification of the transaction (to be compliant with Worldline Sips 1.0).Contains the data pair (s10TransactionId, s10TransactionIdDAte) which ensures the uniqueness of the transaction 1.0.
Contains
-
s10TransactionId- presence
- Optional
- Interface version
- 2.6
- Format
-
N6Any character is accepted
The merchant can choose between transactionId and transactionReference (by default) to identify his transactions.s10TransactionId is an alternative identifier for the transaction to be compliant with Worldline Sips 1.0. The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction.
-
s10TransactionIdDate- presence
- Optional
- Interface version
- 2.6
Date of the transaction (expressed in the Worldline Sips server time zone).The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction 1.0.The use of this couple instead of transactionReference depends on an option in the merchant configuration.
-
sealAlgorithm- presence
- Optional
- Interface version
- 2.12
Algorithm applied to calculate the seal encryption.
List of values
HMAC-SHA-256- The encryption algorithm applied is HMAC-SHA-256
HMAC-SHA-512- The encryption algorithm applied is HMAC-SHA-512
SHA-256- The encryption algorithm applied is SHA-256
-
settlementArchivingReference- presence
- Optional
- Interface version
- 2.33
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.
-
settlementMerchantSpecificData- presence
- Optional
- Interface version
- 2.33
Specific data provided by the merchant and transmitted to the acquirer for processing remittances. To use this data, please contact Worldline Sips.
-
shoppingCartDetail- presence
- Optional
- Interface version
- 2.38
Information specific to the basket.
Contains
-
giftCardAmount- presence
- Optional
- Interface version
- 2.39
For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major units. Example: gift card amount is USD 123.45. Values accepted:123 0123 00123.
-
giftCardCurrencyCode- presence
- Optional
- Interface version
- 2.39
For prepaid or gift card purchase, ISO 4217 threedigit currency code of the gift card.
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
-
mainProduct- presence
- Optional
- Interface version
- 2.38
The most expensive product in the shopping cart.
-
giftCardCount- presence
- Optional
- Interface version
- 2.39
For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
-
shoppingCartItemList- presence
- Optional
- Interface version
- 2.38
List of items in the basket. This list is limited to 300 products (maximum number of shoppingCartItem occurrences).
Contains
-
shoppingCartItem- presence
- Optional
- Interface version
- 2.38
Information specific to an item of the basket.
Contains
-
productName- presence
- Optional
- Interface version
- 2.38
Name of the ordered product.
-
productUnitTaxAmount- presence
- Optional
- Interface version
- 2.38
Monetary value of the tax for the product (unit). The amount must be transmitted in the smallest unit of currency.
-
productDescription- presence
- Optional
- Interface version
- 2.38
Detailed description of the ordered product.
-
productSKU- presence
- Optional
- Interface version
- 2.38
Merchant’s product identifier code, sent back in the response without modification.
-
productQuantity- presence
- Optional
- Interface version
- 2.38
Quantity of products in the shopping cart.
-
productTaxRate- presence
- Optional
- Interface version
- 2.38
Tax rate for the product. For decimal numbers, use a dot instead of a comma (eg. 0.1999).
-
productUnitAmount- presence
- Optional
- Interface version
- 2.38
Unit amount of the product. The amount must be transmitted in the smallest unit of currency.
-
productCode- presence
- Optional
- Interface version
- 2.38
Code of the ordered product.
-
productCategory- presence
- Optional
- Interface version
- 2.38
Category of the ordered product (for example digital).
-
productTaxCategory- presence
- Optional
- Interface version
- 2.38
Future Use.Tax category for the product (eg. 1:High, 2:Low, …).
-
travelData- presence
- Optional
- Interface version
- 2.38
Contains specific information regarding the travel.
Contains
-
travelCardPeriod- presence
- Optional
- Interface version
- 2.38
Duration of the subscription card.
-
journeyDataList- presence
- Optional
- Interface version
- 2.38
List of container journeyData. This list is limited to 25 items.
Contains
-
journeyData- presence
- Optional
- Interface version
- 2.38
Contains trip information.
Contains
-
journeyAmount- presence
- Optional
- Interface version
- 2.41
Journey amount.
-
carrierIdentifier- presence
- Optional
- Interface version
- 2.38
Identifier of the carrier.
-
classLevel- presence
- Optional
- Interface version
- 2.38
Class level of the trip.
-
departureDateTime- presence
- Optional
- Interface version
- 2.38
Departure date of the trip.
-
arrivalLocation- presence
- Optional
- Interface version
- 2.38
Arrival place of the journey.
-
destinationCountry- presence
- Optional
- Interface version
- 2.38
Country of destination of the journey.
-
fareBasis- presence
- Optional
- Interface version
- 2.38
Fare Basis. Example: business class, economy class, …
-
carrierName- presence
- Optional
- Interface version
- 2.38
The carrier’s name.
-
journeyCancellableIndicator- presence
- Optional
- Interface version
- 2.38
Trip cancellation / modification option indicator.
List of values
false- Boolean indicator is false
true- Boolean indicator is true
-
departureLocation- presence
- Optional
- Interface version
- 2.38
Place of departure of the journey.
-
journeyInsurance- presence
- Optional
- Interface version
- 2.38
Insurance taken out for the trip.
-
journeyInsuranceIndicator- presence
- Optional
- Interface version
- 2.38
Trip indicator with insurance.
List of values
false- Boolean indicator is false
true- Boolean indicator is true
-
journeyModality- presence
- Optional
- Interface version
- 2.38
Method of borrowing the trip.
List of values
FEE- Service fee
MULTIPLE- Multi stop journey
ONEWAY- One way ticket
OTHER_CANCELLATION- Cancellation of an additional purchase of a service linked to the journey
PURCHASING- Additional purchase of a service linked to the journey
RESERVATION- Journey reservation
ROUTING_INFORMATION- Information related to the journey steps
TICKET_CANCELLATION- Ticket cancellation
TWOWAY- Round journey
-
journeyMode- presence
- Optional
- Interface version
- 2.38
Mode of transport of the trip.
List of values
AIR- Airline
CRUISE- Cruise
RAIL- Railway
RENTAL- Car rental
-
journeyNature- presence
- Optional
- Interface version
- 2.41
Journey nature. Accepted values could depend on acquirer.
-
journeySequence- presence
- Optional
- Interface version
- 2.38
Trip occurrence number within the trip.
-
journeyStage- presence
- Optional
- Interface version
- 2.38
Nature of the stage of the trip.
List of values
OUTWARD- An outward journey
RETURN- A return journey
TRANSIT- Stage of the transitory journey
-
luggageSupplementIndicator- presence
- Optional
- Interface version
- 2.38
Luggage supplement indicator.
List of values
false- Boolean indicator is false
true- Boolean indicator is true
-
numberOfTickets- presence
- Optional
- Interface version
- 2.38
Number of tickets.
-
ticketExchangeabilityIndicator- presence
- Optional
- Interface version
- 2.38
Ticket exchangeability indicator.
List of values
false- Boolean indicator is false
true- Boolean indicator is true
-
ticketIssueCity- presence
- Optional
- Interface version
- 2.38
City of issue of the ticket.
-
ticketIssueDate- presence
- Optional
- Interface version
- 2.38
Issue date of the ticket.
-
ticketIssuerName- presence
- Optional
- Interface version
- 2.38
Name of the organization issuing the ticket.
-
ticketReference- presence
- Optional
- Interface version
- 2.38
Ticket reference of the transport ticket.
-
stayDataList- presence
- Optional
- Interface version
- 2.38
List of accommodations. This list is limited to 25 items.
Contains
-
stayData- presence
- Optional
- Interface version
- 2.38
Contains accommodation information.
Contains
-
stayCategory- presence
- Optional
- Interface version
- 2.38
Nature of service for the stay.
List of values
HOTEL- Hotel
OTHER- Other
RENTAL- Rental
TOUR- Tour operator
-
numberOfNights- presence
- Optional
- Interface version
- 2.38
Number of nights.
-
stayCompany- presence
- Optional
- Interface version
- 2.38
Name of the accommodation provider.
-
stayArrivalDateTime- presence
- Optional
- Interface version
- 2.38
Arrival date of stay.
-
numberOfPeopleStaying- presence
- Optional
- Interface version
- 2.38
Number of people accommodated.
-
roomServiceLevel- presence
- Optional
- Interface version
- 2.38
Room service level.
-
stayDepartureDateTime- presence
- Optional
- Interface version
- 2.38
Departure date of stay.
-
stayInsurance- presence
- Optional
- Interface version
- 2.38
Insurance taken out for accommodation.
-
stayInsuranceIndicator- presence
- Optional
- Interface version
- 2.38
Stay indicator with insurance.
List of values
false- Boolean indicator is false
true- Boolean indicator is true
-
stayLocation- presence
- Optional
- Interface version
- 2.38
Place of accommodation.
-
stayNumberOfRooms- presence
- Optional
- Interface version
- 2.38
Number of rooms.
-
stayRentalCarIndicator- presence
- Optional
- Interface version
- 2.38
Indicator of stay with rental vehicle.
List of values
false- Boolean indicator is false
true- Boolean indicator is true
-
passportDataList- presence
- Optional
- Interface version
- 2.38
List of travelers’ passports. This list is limited to 30 items.
Contains
-
passportData- presence
- Optional
- Interface version
- 2.38
Contains passport information.
Contains
-
passportExpirationDate- presence
- Optional
- Interface version
- 2.38
Passport expiration date.
-
passportIssueCountry- presence
- Optional
- Interface version
- 2.38
Country of issue of passport.
-
mainTravelerFirstName- presence
- Optional
- Interface version
- 2.46
Traveler first name.
-
travelCardType- presence
- Optional
- Interface version
- 2.38
Subscription card code.
-
bookingData- presence
- Optional
- Interface version
- 2.41
Contains specific data concerning travel booking.
Contains
-
bookerFirstName- presence
- Optional
- Interface version
- 2.41
Booker first name.
-
bookerLastName- presence
- Optional
- Interface version
- 2.41
Booker last name.
-
bookingId- presence
- Optional
- Interface version
- 2.41
Merchant travel booking identifier.
-
bookingPlatform- presence
- Optional
- Interface version
- 2.41
Travel booking platform.
-
bookingPlatformOrderId- presence
- Optional
- Interface version
- 2.41
Travel booking platform order identifier.
-
mainTravelerLastName- presence
- Optional
- Interface version
- 2.46
Traveler last name.
-
numberOfTravelers- presence
- Optional
- Interface version
- 2.38
Number of travelers.
-
travelEndDateTime- presence
- Optional
- Interface version
- 2.38
Travel end date.
-
travelingPayerIndicator- presence
- Optional
- Interface version
- 2.38
Indicator if the payer is a traveler.
List of values
false- Boolean indicator is false
true- Boolean indicator is true
-
travelReason- presence
- Optional
- Interface version
- 2.38
Purpose of the trip.
-
travelStartDateTime- presence
- Optional
- Interface version
- 2.38
Start date of the trip.
-
shoppingCartTotalAmount- presence
- Optional
- Interface version
- 2.38
Total amount of all products in the basket. This amount includes taxes but doesn’t include any charges, fees and discounts.
-
shoppingCartTotalQuantity- presence
- Optional
- Interface version
- 2.38
Total quantity of all products in the basket.
-
shoppingCartTotalTaxAmount- presence
- Optional
- Interface version
- 2.38
Total amount of taxes in the basket.
-
statementReference- presence
- Optional
- Interface version
- 2.19
Reference provided by the merchant which is sent in the payment collection flow. This reference appears on the account statements of the cardholder.
-
transactionOrigin- presence
- Optional
- Interface version
- 2.0
Origin of a transaction (for example: name of the programme), set by the merchant. Exemple: “Website A v1.32”.
-
transactionReference- presence
- Optional
- Interface version
- 2.0
The merchant can choose of referencing his transactions by a transactionId or a transactionReference.transactionReference uniquely identifies a transaction throughout the life of the shop.
Request sample
Response
Required
-
seal- presence
- Required
- Interface version
- 2.0
Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.
Optional
-
acquirerResponseCode- presence
- Optional
- Interface version
- 2.0
Response code returned by the acquirer during an authorisation request.
List of values
00- Transaction approved or processed successfully
02- Contact payment mean issuer
03- Invalid acceptor
04- Keep the payment mean
05- Do not honour
07- Keep the payment mean, special conditions
08- Approve after identification
12- Invalid transaction
13- Invalid amount
14- Invalid PAN
15- Unknown payment mean issuer
17- Payment aborted by the buyer
20- Invalid response (error in server domain)
24- Operation not authorised
25- Transaction not found
30- Format error
31- Id of the acquiring organisation unknown
33- payment mean expired (Paypal / Cofidis)
34- Fraud suspicion
40- Function not supported
41- Payment mean lost
43- Payment mean stolen
46- Business specific error
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
6P- Verification data failed
75- Exceeded number of PAN attempts
77- Closed account
78- Card not yet activated, or temporarily blocked
82- Card verification method failed for CAM, dCVV, iCVV or CVV
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
R0- Stop payment order
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
- 2.35
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
- 2.0
Authorisation ID returned by the acquirer if the authorisation request is accepted.
-
cardData- presence
- Optional
- Interface version
- 2.35
Contains specific information regarding a card
Contains
-
cardBrand- presence
- Optional
- Interface version
- 2.35
Please see “paymentMeanBrand”.
-
cardCorporateIndicator- presence
- Optional
- Interface version
- 2.35
Indicates whether the card is an Enterprise / Commercial card or not.
List of values
Empty- Unknown
N- The card is not a corporate card
Y- The card is a corporate card
-
cardEffectiveDateIndicator- presence
- Optional
- Interface version
- 2.35
Indicator of existence of a card effective date (Y/N/Empty)
-
cardProductCode- presence
- Optional
- Interface version
- 2.35
Product code of the card.
-
cardProductName- presence
- Optional
- Interface version
- 2.35
Product name of the card.
-
cardProductProfile- presence
- Optional
- Interface version
- 2.35
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
- 2.45
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
- 2.35
Network name associated with the card.
List of values
ACCORD- Accord scheme
AMEX- American Express scheme
BCMC- Bancontact scheme
CB- Carte Bancaire 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)
-
cardSeqNumberIndicator- presence
- Optional
- Interface version
- 2.35
Indicator of existence of an issue number
List of values
1- Card issue number of length 1
2- Card issue number of length 2
3- Card issue number of length 3
Empty- Unknown
N- No card issue number
-
issuerCode- presence
- Optional
- Interface version
- 2.35
Issuer code of the card. This data is called cardIssuerCode in the reports.
-
issuerCountryCode- presence
- Optional
- Interface version
- 2.35
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
-
issuerName- presence
- Optional
- Interface version
- 2.35
Issuer name of the card. This data is called cardIssuerName in the reports.
-
issuerRegionCode- presence
- Optional
- Interface version
- 2.35
region code of the card issuer
List of values
1- USA: California, Hawaii, Nevada
2- USA: West except California, Hawaii, Nevada
3- USA: Central North
4- USA: Central South
5- USA: Great Lakes states
6- USA: South East
7- USA: Extreme North East
8- USA: North East
9- USA: Florida and Georgia
A- Canada
B- South America
C- Oceania Asia
D- Europe
E- Africa and middle east
Empty- Unknown
-
issuingCountryCode- presence
- Optional
- Interface version
- 2.44
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
-
panCheckAlgorithm- presence
- Optional
- Interface version
- 2.35
Control algorithm applied on the PAN (L/V/N/Empty)
List of values
Empty- Unknown PAN control algorithm
L- PAN control with Lühn Key algorithm
N- No PAN control algorithm
V- PAN control with Visa Modulus 10 algorithm
-
panLengthMax- presence
- Optional
- Interface version
- 2.35
Maximum length of the PAN
-
panLengthMin- presence
- Optional
- Interface version
- 2.35
Minimal length of the PAN
-
virtualCardIndicator- presence
- Optional
- Interface version
- 2.35
Indicates whether the card is a virtual card
List of values
Empty- Unknown
N- The card is not a virtual card
Y- The card is a virtual card
-
errorFieldName- presence
- Optional
- Interface version
- 2.21
Error field name of the incoming request. Present when responseCode = 12 or 30.
-
maskedPan- presence
- Optional
- Interface version
- 2.0
Masked Primary Account Number. In the case of wallets, masked PAN of the payment mean registered in the wallet.
-
newStatus- presence
- Optional
- Interface version
- 2.0
Status of the transaction updated after a checkout operation. The status of a transaction is described by different keywords which change during the operations it undergoes.
List of values
ABORTED- Transaction totally aborted
CANCELLED- Transaction totally cancelled
CAPTURED- Transaction sent to the bank
CAPTURE_REFUSED- Capture refused
CREDITED- Transaction totally refund
ENDED- Transaction ended
EXPIRED- Transaction expired
PENDING- Transaction waiting for the authorisation request response
PREPROD- Transaction of a merchant which is in the pre-production mode. It cannot be settled.
REFUSED- Transaction refused
TO_AUTHORIZE- Transaction waiting for the authorisation request
TO_CAPTURE- Transaction to send to the bank to debit the user
TO_CHALLENGE- Transaction with a fraud suspicion
TO_CONFIRM_AUTHOR- Transaction waiting for confirmation of authorization.
TO_CONFIRM_CAPTURE- Transaction waiting for confirmation of settlement
TO_CONFIRM_CREDITTO_CREDIT- Transaction to send to the bank to credit the user
TO_REPLAY- Transaction waiting for a validation with authorization request
TO_VALIDATE- Transaction waiting for a validation
UNDEFINED- Transaction status not defined
WAITING_AUTHOR- Technical status for transaction in a temporarily state waiting for a authorisation batch response
-
operationDateTime- presence
- Optional
- Interface version
- 2.0
Date and time calculated by Worldline Sips on which the transaction has been completed.
-
responseCode- presence
- Optional
- Interface version
- 2.0
Worldline Sips server response code.
List of values
00- Operation accepted
01- For panToToken and tokenToPan methods, partial success
02- Request of authorized on via telephone with the issuer because of exceeding the card authorization threshold
03- Invalid merchant contract
05- Refused authorization
11- Used for differed check. The PAN is blocked
12- Invalid transaction. Please check the request parameters
14- Invalid PAN or payment mean data check is failed (e.g. card number or the visual cryptogram of the card or AVS address)
17- Customer cancellation
24- In response to a cash management operation: operation not authorized. The operation you wish to perform is not compliant with the transaction status or another operation is in progress at the same time
- In response to a payment creation: operation rejected, request already carried out with the same data and the same parameters
25- Transaction unknown by Worldline Sips
30- Format error
34- Fraud suspicion (seal erroneous)
40- Function not supported: the operation that you wish to perform is not part of the operation type for which you are authorized
51- Amount too high
54- Payment mean expiry date is past
55- Merchant doesn’t accept prepaid cards
57- Refund operation refused because the original transaction was subject of an unpaid
60- Transaction pending
62- Waiting the confirmation for the transaction (used by PayPal 1.0)
63- Security rules not observed, transaction stopped
75- Number of attempts to enter the data of the payment mean from Sips Paypage is exceeded
90- Service temporarily not available
94- Duplicated transaction: the transactionReference has been used previously
97- Session expired (no action from the user during 15 minutes), transaction refused
99- Temporarily problem with the payment server
-
s10TransactionReference- presence
- Optional
- Interface version
- 2.6
Contains the identification of the transaction (to be compliant with Worldline Sips 1.0).Contains the data pair (s10TransactionId, s10TransactionIdDAte) which ensures the uniqueness of the transaction 1.0.
Contains
-
s10TransactionId- presence
- Optional
- Interface version
- 2.6
- Format
-
N6Any character is accepted
The merchant can choose between transactionId and transactionReference (by default) to identify his transactions.s10TransactionId is an alternative identifier for the transaction to be compliant with Worldline Sips 1.0. The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction.
-
s10TransactionIdDate- presence
- Optional
- Interface version
- 2.6
Date of the transaction (expressed in the Worldline Sips server time zone).The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction 1.0.The use of this couple instead of transactionReference depends on an option in the merchant configuration.
-
settlementArchivingReference- presence
- Optional
- Interface version
- 2.49
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.
-
transactionPlatform- presence
- Optional
- Interface version
- 2.17
Platform where the transaction has been executed.
List of values
PRE-PROD- Pre-production transaction not sent to remittance
PROD- Production transaction
SIMU- Simulated transaction
UAT- User acceptance test transaction
-
transactionReference- presence
- Optional
- Interface version
- 2.6
The merchant can choose of referencing his transactions by a transactionId or a transactionReference.transactionReference uniquely identifies a transaction throughout the life of the shop.
Response sample
Changelog
