0% found this document useful (0 votes)

407 views371 pages

WebCollectTechnical Guide Q4 2019

This document provides technical documentation for WebCollect including release history, payment interfaces, API call formats, and descriptions of over 30 API calls. It details how to perform actions like payments, refunds, retrieving data, and managing orders using WebCollect's APIs. The document is intended as a guide for developers integrating with the WebCollect payment processing platform.

Uploaded by

Cristian Halus

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

407 views371 pages

WebCollectTechnical Guide Q4 2019

Uploaded by

Cristian Halus

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 371

WebCollect Technical Guide

Q4 2019
1. WebCollect Technical documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1 Latest Released documents (PDF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2 WebCollect Technical Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2.1 0 - Release History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.2.2 1 - Ingenico ePayments interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.2.2.1 Hosted Merchant Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.2.2.2 Merchant Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.2.3 2 - Payment Status Communicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
1.2.4 3 - Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.2.5 4 - API call format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
1.2.6 5 - API calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.2.6.1 CANCEL_PAYMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.2.6.2 CANCEL_PAYOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
1.2.6.3 CANCEL_REFUND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
1.2.6.4 CANCEL_SET_PAYMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1.2.6.5 CANCEL_SET_REFUND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.2.6.6 CONVERT_AMOUNT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
1.2.6.7 CONVERT_PAYMENTTOPROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
1.2.6.8 CREATE_PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
1.2.6.9 DO_AUTHENTICATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
1.2.6.10 DO_BANKVALIDATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
1.2.6.11 DO_BINLOOKUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
1.2.6.12 DO_CHECKENROLLMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
1.2.6.13 DO_FINISHPAYMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
1.2.6.13.1 DO_FINISHPAYMENT only for PAYPAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
1.2.6.14 DO_PAYMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
1.2.6.15 DO_PAYOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
1.2.6.16 DO_REFUND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
1.2.6.17 DO_RISKASSESSMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
1.2.6.18 DO_VALIDATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
1.2.6.19 GET_BANKDETAILS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
1.2.6.20 GET_DIRECTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
1.2.6.21 GET_ORDER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
1.2.6.22 GET_ORDERSTATUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
1.2.6.23 GET_PAYMENTPRODUCTFIELDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
1.2.6.24 GET_PAYMENTPRODUCTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
1.2.6.25 GET_RATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
1.2.6.26 INSERT_ORDER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
1.2.6.27 INSERT_ORDERWITHPAYMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
1.2.6.28 INVALIDATE_PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
1.2.6.29 MODIFY_ORDER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
1.2.6.30 PROCESS_CHALLENGED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
1.2.6.31 REJECT_ORDER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
1.2.6.32 SET_PAYMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
1.2.6.33 SET_PAYOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
1.2.6.34 SET_REFUND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
1.2.6.35 TEST_CONNECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
1.2.6.36 UPDATE_PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
1.2.6.37 VALIDATE_PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
1.2.7 Appendix A - ISO country codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
1.2.8 Appendix B - ISO language codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
1.2.9 Appendix C - ISO currency codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
1.2.10 Appendix D WebCollect status codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
1.2.11 Appendix E Payment Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
1.2.12 Appendix F Recurring orders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
1.2.13 Appendix G Adding a root certificate to PHP-cURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
1.2.14 Appendix H Country-specific direct debit keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
1.2.15 Appendix I Additional information about real-time bank transfers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
1.2.16 Appendix J 3D Secure authentication—Verified by Visa and Secure Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
1.2.16.1 3DS V1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
1.2.16.2 3DS V2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
1.2.17 Appendix K Bank validation errors and warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
1.2.18 Appendix L IBAN structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
1.2.19 Appendix M Fraud screening . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
1.2.20 Appendix N Address Verification Service (AVS) descrioptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
1.2.21 Appendix O Card Verification Value (CVV) descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
1.2.22 Appendix P Lunch Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
1.2.23 Appendix Q SEPA direct debit processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
1.2.24 Appendix R SEPA directdebitmandate amendmentrules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
1.2.25 Appendix S IP addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
WebCollect Technical documentation
This is the space where you will find:

WebCollect Technical Guide

WebCollect Error Codes Guide

Recent space activity Space contributors

Stavroula Perdiki Stavroula Perdiki (3 minutes ago)
INSERT_ORDERWITHPAYMENT updated 3 Paula Costa (45 days ago)
minutes ago • view change Melvin Schreijer (526 days ago)
Steven Hai (605 days ago)
GET_ORDERSTATUS updated Aug 29, 2019 • view Eda Sol (636 days ago)
change ...

Paula Costa
5 - WebCollect error codes 400000–499999 updated
Aug 23, 2019 • view change

6 - WebCollect error codes 430205–430245 with

additional information updated Aug 23, 2019 • view
change
Stavroula Perdiki
5 - WebCollect error codes 400000–499999 updated
Aug 21, 2019 • view change

File Modified

PNG File IePlogo.png Jan 05, 2018 by Paula Costa

PNG File IePlogo-2.png Jan 05, 2018 by Paula Costa

Drag and drop to upload or browse for files

Download All

Ingenico document - Reproduction or disclosure prohibited without written authorization

3
Latest Released documents (PDF)
Webcollect Technical Guide Q2 2019

Webcollect Error Codes Guide Q2 2019

Ingenico document - Reproduction or disclosure prohibited without written authorization

4
WebCollect Technical Guide
Disclaimer
All trademarks, service marks and trade names used in this document are the property of their respective owners. The information contained
here is for general informational purposes only. This document is not a complete description of all applicable Ingenico ePayments rules, policies,
and procedures. This document is subject to change without notice.

Global Collect BV shall not be responsible for any inaccurate or incomplete information. Nothing contained in this document is intended to
supplement, amend, or modify any applicable contract, rule, or regulation.

Contact
Ingenico ePayments

P.O Box 2001

2130 GE Hoofddorp The Netherlands

Merchant services

Worldwide [email protected]

24/7 emergency contact 00800 423407328 (00800GCDIRECT)

Ingenico document - Reproduction or disclosure prohibited without written authorization

5
0 - Release History

Docu Section Description

ment
date

All Previous history available on request

CREATE_PROFILE input keys

l MANDATEID changed to optional

l COUNTRYCODE changed to required DO_BANKVALIDATION return keys

l In the response keys, The RESULT field returns an OK value as long as Ingenico ePayments can validate the account
information. To confirm that the validation is successful, you must examine the check code results. In addition, if the BIC
check fails, no other checks are done

DO_PAYMENT input keys

l PAYMENTPRODUCTID is required if you are using the API call: INSERT_ORDER followed by the API call:
DO_PAYMENT. If you want to submit a payment for a recurring order (OrderType=4), PAYMENTPRODUCTID is optional
(not required)

DO_REFUND input keys

l Bank refund Spain (1012)—IBAN changed to optional

l SEPA bank refund (1070)—SURNAME (AN35) field added and required GET_DIRECTORY return keys

l ISSUERID changed to AN11

l COUNTRYNAMES (AN35) added

REJECT_ORDER return keys

2014 API calls l TYPE added

Q1
l Note added that: CODE, MESSAGE, and TYPE are always returned for rejected iDEAL transacations

These direct debit payment products are removed because they are replaced by SEPA direct debits (770)

l Netherlands (Eenmalige machtiging Nederland) (701)

l Germany (Lastschrift Deutschland) (702)

Appendix l Austria (Lastschrift Osterreich) (703)

E: Payment
products l France (704)

Docu Section Description

ment
date

l Belgium (706)

l Italy (708)

l Spain (709)

l Netherlands (Doorlopende machtiging Nederland) (711)

l Recurring Germany (712)

l Recurring Austria (713)

l Recurring France (714)

l Recurring Belgium (716)

l Recurring Italy (718)

l Recurring Spain (719)

l Recurring Germany (ELV) (720)

Ingenico document - Reproduction or disclosure prohibited without written authorization

6
Appendix H: Country-specific Country-specific direct debit keys that are replaced by SEPA direct debits (770) are removed
direct debit keys

Appendix I: Additional The test environment for GiroPay (Germany) is unavailable and has been removed
information about real-time
bank transfers

Appendix K: Bank validations Completely updated

and errors

New! Appendix S: IP l IP addresses for the Amsterdam data center

addresses
l IP addresses for the Miami data center

2014 All sections Document migration to topic-based authoring

Removed API call: DO_AUTHORIZE DO_REFUND

l Changed AMOUNT to optional, with footnote: AMOUNT is required for a partial refund

l Example XML added for 1-click refund

DO_PAYMENT and INSERT_ORDERWITHPAYMENT (input keys for credit card online),

DO_VALIDATE and GET_ORDERSTATUS (return keys)

l Added the Electronic Commerce Indicator (ECI) result for Diners Club (5=Successful authentication)

CREATE_PROFILE and UPDATE_PROFILE (input keys), GET_ PROFILE (return keys)

l Removed PRENOTIFICATION =2 and =3

DO_PAYMENT and INSERT_ORDERWITHPAYMENT input keys for real-time bank transfer

l Added IBAN, BIC

l Added footnote to IBAN: The IBAN, BIC, ACCOUNTNUMBER, and BANKCODE fields are optional
for Sofortüberweisung (836). This feature in Sofortüberweisung (836) is only supported in Germany
(DE)

DO_PAYMENT and INSERT_ORDERWITHPAYMENT input keys

l Removed ORDERID INSERT_ORDERWITHPAYMENT input keys

API calls

Docu Section Description

ment
date

l Added footnote to ORDERTYPE: ORDERTYPE must =4 for SEPA direct debit recurring
transactions using HostedMerchantLink

l Added TRANSACTIONTYPE, with footnote: Required for SEPA direct

debit transactions using HostedMerchantLink

l Added footnote to EMAIL: In addition, EMAIL is required for SEPA direct debit transactions using
HostedMerchantLink (HOSTEDINDICATOR=1) for which PRENOTIFICATION is switched on

l Added PRENOTIFICATION—Optional, with footnote:

PRENOTIFICATION is required for HostedMerchantLink transactions GET_ORDERSTATUS return

keys

l Added MANDATEID, PROFILETOKEN in returns for SEPA direct debit transactions

l Added IBAN, BIC in returns for iDEAL (NL), Giropay (DE), and

Sofortüberweisung (DE) transactions

Updated:

Connection l Connection > Security > Client authentication using a client certificate

Appendix I: Additional
information about real-time bank
transfers Reinstated test details and added BIC and IBAN test elements for Giropay

Ingenico document - Reproduction or disclosure prohibited without written authorization

7
l Updated process flow for MerchantLink one-off transactions and recurring transactions

Appendix Q: SEPA direct debit l Added process flows for HostedMerchantLink one-off transactions and
processing
recurring transactions

CREATE_PROFILE input keys, GET_PROFILE return keys, UPDATE_ PROFILE input keys

l Added values to TRANSACTIONTYPE

DO_PAYMENT additional input keys for direct debit and INSERT_ ORDERWITHPAYMENT
additional input keys for direct debit

l Added that TRANSACTIONTYPE is required for SEPA direct debit transactions (payment product
770)

DO_REFUND input keys

l Added note: MERCHANTORDERID is required when no order exists in WebCollect and you use
REFERENCEORIGPAYMENT to submit your API call: DO_REFUND

GET_ORDERSTATUS input keys

l Added note: ORDERID is require for GET_ORDERSTATUS v1.0

l Added note: MERCHANTORDERID is required for GET_ ORDERSTATUS v2.0

DO_REFUND input keys Changed Spain (1012)

2014 API calls
Q3 l BANKACCOUNTNUMBER: Optional

Docume Section Description

nt date

l IBAN: Required

Changed Indonesia-IDR (1036) and Indonesia-USD (1037)

l CITY: Required

Added to South Africa (1026)—The note referring to bank transfers in South Africa was moved here from Non-
country-specific (1001)

l FIRSTNAME: Required

l SURNAME: Required

Added Non-country-specific (1001)

l CITY: CITY is required for Argentina, Bahrain, Bulgaria, Croatia, Egypt, Greece, Iceland, Kuwait, Lithuania,
Mexico, Qatar, Turkey, the United Arab Emirates, and the United States of America

Connection Changed connection security protocol from SSL v3 to TLS v1

Changes to CUSTOMERID in DO_PAYMENT, INSERT_ORDER, and INSERT_ORDERWITHPAYMENT

l For UnionPay International, CUSTOMERID cannot contain spaces Added to DO_REFUND

l Guidelines for one-click refunds for payments made using direct debit, iDEAL, or Sofortüberweisung

2014 Q4 API calls

Added

Appendix E: l 56—UnionPay International (no authentication)

Payment
products l 430—UnionPay International (UPOP re-direct)

Ingenico document - Reproduction or disclosure prohibited without written authorization

8
DO_PAYMENT additional input keys for real-time bank transfer and INSERT_ORDERWITHPAYMENT additional
input keys for real-time bank transfer

l Changed ISSUERID type to AN11 and example to ABNANL2A—These changes are due to SEPA direct debit
transactions (payment product 770)

Clarified one-click refund in DO_REFUND

l Simplified and clarified description of one-click refund

l Added XML example for one-click refund GET_BANKDETAILS

l Removed Turkey from the List of European IBAN parameters by country—Ingenico ePayments does not support
Turkey for IBAN parameters

GET_PAYMENTPRODUCTS

l Added FILTERINDICATOR key, which indicates if the CURRENCYCODE filter is used to help determine the
payment products to be used—Default=0 (off)

Added these fields to INSERT_ORDERWITHPAYMENT additional for credit card online payments input fields

2015 Q2 API calls

Documen Section Description

t date

l CAVVALGORITHM

l VALIDATIONRESULT

Appendix I: Additional information about Real-time bank transfer test cases for iDEAL (Netherlands)
real-time bank transfers
l Changed ISSUERID to ABNANL2A or INGBNL2A—This change is due to SEPA direct
debit transactions (payment product 770)

Removed IP addreses that are no longer in use

Appendix S: IP addresses l For the Amsterdam data center, removed wpc2.gcsip.com:46.16.248.27

l For the Miami data center, removed all IP addresses that begin with 66

DO_REFUND additional input keys for SEPA direct debitAdded BANKCOUNTRYCODE

as a required field
2015 Q3 API calls
l debitAdded BANKCOUNTRYCODE as a required field

DO_PAYMENT and INSERT_ORDERWITHPAYMENT:

l Real Time Banking: ACCOUNTNUMBER and BANKCODE removed from explanation-

text and API

l Additional for PaySafeCard: Added MERCHANTCLIENTID DO_REFUND

l One click refund: add comments for SOFORT: Only possible for EUR countries
2016 Q1 API calls

DO_PAYMENT and INSERT_ORDERWITHPAYMENT:Additional for credit card online

payments:

l SCHEMETRANSACTIONIDENTIFIER added as a return key

2017 Q1 API calls
l AUTHTYPE added as an input key

INSERT_ORDER and INSERT_ORDERWITHPAYMENT:For Paypal

transactions:

l An explanation "Shipping information must be sent in shipping tags" is added

regarding shipping information.

DO_PAYMENT, INSERT_ORDERWITHPAYMENT, INSERT_ORDER and

DO_FINISHPAYMENT :

l 3 new input keys are added only for paypal transactions: SHIPPINGAMOUNT,
TAXAMOUNT, HANDLINGAMOUNT

Ingenico document - Reproduction or disclosure prohibited without written authorization

9
INSERT_ORDER and INSERT_ORDERWITHPAYMENT

l ITEMID, LINETAXAMOUNT are added as input keys per each orderline

DO_PAYMENT and INSERT_ORDERWITHPAYMENT: Additional for cash payments

Explanation text are changed for Boleto cash payments

l COMPANYNAME and FISCALNUMBER (CNPJ) are required for business consumer

transactions using Boleto Bancário

l FIRSTNAME and FISCALNUMBER (CPF) are required for non- business consumer
transactions using Boleto Bancário

l STREET, ZIP, CITY, STATECODE, are required for all transactions

2018 Q1 API calls DO_PAYMENT and INSERT_ORDERWITHPAYMENT: Additional for cash payments

Explanation text are changed for Boleto cash payments

l For all the below fields only uppercase letters (A-Z) and digits (0-9) are allowed . No
Portuguese diacritics are allowed.

l Only one space between words is allowed.

l Only "-" (dash) and " ' " (apostrophe) allowed as special characters.

l When "-" or " ' " are used, no spaces are allowed between words. For example: D'EL-
REI is correct, D'EL - REI is incorrect.

l For business consumer COMPANYNAME and FISCALNUMBER (CNPJ) are required.

l For non-business consumer FIRSTNAME, SURNAME and FISCALNUMBER (CPF) is

required.

l STREET, HOUSENUMBER and ADDITIONALADDRESSINFO combined must be less

than AN52.

Document Section Description

date

using Boleto Bancário

l HOUSENUMBER is required if the house number is not included in the STREET field for all transactions
using Boleto Bancário

l STATECODE is A2 only for Brazil.

l COMPANYNAME,FISCALNUMBER (CPF/CNPJ), ZIP, STATECODE

input keys are changed from optional to required

DO_REFUND: Following bank refund products are not supported anymore and removed

l Bank Refund Austria (1003)

l Bank Refund Belgium (1004)

l Bank Refund Finland (1006)

l Bank Refund France (1007)

l Bank Refund Germany (1008)

l Bank Refund Italy (1009)

l Bank Refund Netherlands (1010)

l Bank Refund Spain (1012)

l Bank Refund Portugal (1017) l Bank Refund Estonia (1020) l Bank Refund Ireland (1022)

l Bank Refund Latvia (1023)

l Bank Refund Slovenia (1025)

l Bank Refund Luxembourg (1029)

l Bank Refund Slovakia (1033)

Ingenico document - Reproduction or disclosure prohibited without written authorization

10
DO_PAYOUT: Following bank payout products are not supported anymore and removed

l Bank Payout Netherlands (1201)

l Bank Payout Germany (1202)

l Bank Payout Austria (1203) l Bank Payout France (1204) l Bank Payout Spain (1209)

Following products are removed from the table.

l Bank Refund Austria (1003)

l Bank Refund Belgium (1004)

l Bank Refund Finland (1006)

l Bank Refund France (1007)

l Bank Refund Germany (1008)

l Bank Refund Italy (1009)

l Bank Refund Netherlands (1010)

Appendix E: Payment l Bank Refund Spain (1012)

Products
l Bank Refund Portugal (1017) l Bank Refund Estonia (1020) l Bank Refund Ireland (1022)

l Bank Refund Latvia (1023)

l Bank Refund Slovenia (1025)

l Bank Refund Luxembourg (1029)

l Bank Refund Slovakia (1033)

l Bank Payouts Netherlands (1201)

added for CC Online UATP, MIR (Russia) HIPER (Brazil) and other local cards in Argentina

2018 Q1 API CALLS INSERT_ORDER with mandatory CUSTOMERID for UCOF

INSERT_ORDERWITHPAYMENT with mandatory CUSTOMERID for UCOF, UCOFINDICATOR and

UCOFREQUESTOR and new AUTHTYPE 3

DO_PAYMENT with UCOFINDICATOR and UCOFREQUESTOR and new AUTHTYPE 3

Document Section Description

date

l Bank Payout Germany (1202)

l Bank Payout Austria (1203) l Bank Payout France (1204) l Bank Payout Italy (1208)

l Bank Payout Spain (1209)

l Ukash

DO_PAYMENT and INSERT_ORDERWITHPAYMENT : Additional for PaySafeCard- Various countries

(830)

l The description of MERCHANTCLIENTID return key is changed to "Merchant Client Id for Paysafecard
(PPID:830)"

Ingenico ePayments All references to CustomerLink Interface is removed

interfaces

For hosted merchant link interface

EXPIRATIONPERIOD functionality is supported by eCard (402) and an explanation is added into it's
description.

DO_PAYMENT and INSERT_ORDERWITHPAYMENT : all input and returns keys are removed for check
payments and voucher payments.

l Additional for check payments

API Calls
l Addtional for voucher payments- Ukash

Ingenico document - Reproduction or disclosure prohibited without written authorization

11
DO_PAYOUT

API Calls l Additional input keys for SEPA Payout (1270) are added

DO_PAYMENT : Additional for real-time bank transfer payments

API Calls l EXPIRATIONPERIOD input tag is supported by eCard (402) and an explanation is added into it's
description.

INSERT_ORDERWITHPAYMENT : Additional for real-time bank transfer payments

l EXPIRATIONPERIOD input tag is supported by eCard (402) and an explanation is added into it's
description.
API Calls

DO_REFUND

API Calls l EFFORTID input key is mandatory only for recurring transactions.

2019 Q1 API Calls INSERT_ORDERWITHPAYMENT changes for 3dV2

DO_PAYMENT changes for 3dV2

DO_VALIDATE changes for 3dV2

DO_AUTHENTICATE (new) new api for 3dV2

2019 Q2 API Calls INSERT_ORDERWITHPAYMENT changes for PSD2 for Recurring and UCOF transactions (new fields in
Request and Response)

DO_PAYMENT changes for PSD2 for Recurring and UCOF transactions (new fields in Request and
Response)

GET_ORDERSTATUS Scheme Transaction ID passed in the response (PSD2)

Ingenico document - Reproduction or disclosure prohibited without written authorization

12
1 - Ingenico ePayments interfaces

There are three Ingenico ePayments interfaces

l MerchantLink

l HostedMerchantLink

Responsible party per interface

Action

MerchantLink HostedMerchantLink

Shopping cart and add products Merchant Merchant

Add shipping costs Merchant Merchant

Add taxes Merchant Merchant

Display during checkout Merchant Merchant

Multiple country support Merchant Merchant

Multiple language support Merchant Merchant

Multiple currency support Merchant Merchant

Payment method selection Merchant Merchant

Payment product selection Merchant Merchant

Collection of payment details (including input verification) Merchant Ingenico ePayments

Possible redirection to third parties Merchant Ingenico ePayments

Error handing Merchant Merchant

Consumer transaction feedback (success or failure) Merchant Merchant

The API call format is described in the API call Format section. The payment server returns a message with the result of the online payment request.
The result keys depend on the payment method used.

Ingenico document - Reproduction or disclosure prohibited without written authorization

13
Hosted Merchant Link
In flow, the consumer is redirected to WebCollect to finish the payment instead of an immediate processing of the transaction.

If you are using redirection payment methods such as real-time bank transfers, or if you want Ingenico ePayments to capture credit card data,
consumers are redirected to Ingenico ePayments first and not directly to the payment pages of the bank.

l Advantages of this technical implementation

l Identical for all payment products

l Faster implementation

l Additions to specific payment products require minimal or, in most cases, no new additional technical integration for you

l Credit cards and direct debit advantages

l No collection of PCI-sensitive data takes place on your website

l No need to differentiate between countries with various payment keys

l Real-time banking and other payment products requiring redirection advantages

l No need to develop payment-product-specific redirection and handling of returning consumers or completed payments

l Any possible changes to the interface of individual banks do not require any additional technical integration by you

Here are the process flows between the consumer, your web site and the WebCollect HostedMerchantLink.

Technical integration steps for HostedMerchantLink

Preparation—Setting up the Ingenico ePayments account and your website

With your Ingenico ePayments Implementation Manager, your account is configured with the relevant

l Payment products

l Currencies

l Services

Example: Delayed settlement, fraud screening, 3D Secure

To pick up the Daily report files, access to the Ingenico ePayments SFT server is set up

l .wrt in staging

l .wr1 or wx1. in production

You adapt your website to display

l Payment products

l Currencies

l Consumer error and confirmation messaging

In addition, develop redirections to third parties (3D Secure) and real-time banks, as needed

Staging—Accreditation testing

Ingenico document - Reproduction or disclosure prohibited without written authorization

14
Test

l Connection and API calls

l Redirections to third-party authentication and real-time banks

l Confirmation of order status

l Receipt of daily reports

l .wrt in staging

With the approval of your Ingenico ePayments Implementation Manager, your Ingenico ePayments account is switched on in production

Switch the API call requests to the production URL:

The switch is from HTTPS://ps.gcsip.nl/wdl/wdl to HTTPS://ps.gcsip.com/wdl/wdl

Process flow

The consumer selects payment and submits his or her data on your website

Submit the order information to WebCollect

For more information, see API call: INSERT_ORDERWITHPAYMENT

The consumer submits additional PCI-sensitive data or missing payment information on the Ingenico ePayments HostedMerchantLink site

Submits the order information to WebCollect

For more information, see API call: INSERT_ORDERWITHPAYMENT

WebCollect responds online with authorization results

Verify the status of the payment if redirection to third parties has been used to determine if the order can be released to

Reports and remittance off-line data flows

This daily report is important for payment confirmation in case of any revised off-line bank transfers

l Daily report file—.wr1 or wx1. in production

Depending on your transaction volumes, you can choose to receive these reports daily or weekly

l Collection report

l Appendix to the collection report

l Financial statement

This is sent out monthly

l Ingenico ePayments invoice

Step-by-step how to—Implementing HostedMerchantLink

Step one—Pre-requisites
Before the connection between your system and WebCollect can be set up, provide this information to your Ingenico ePayments Implementation
Manager.

For more information about the IP-addresses used to connect you to WebCollect or about certificates, see Connection.

lFortheIngenicoePaymentsaccountconfiguration

Ingenico document - Reproduction or disclosure prohibited without written authorization

15
l The IP address from which your requests are sent

l The Hosted Indicator, if you use HostedMerchantLink in combination with MerchantLink

l Set up of the payment products, currencies, and extra services Example: Delayed settlement, fraud screening, 3D Secure

l Customization of the Hosted Page, if you want it

l Your website

l Adaptation of your website to include the new payment products

l Development of the API calls and the redirections to WebCollect

l Store your order—For your reference, store the ORDERID in your system

l For further reference and to help reconciliation, an additional, unique MERCHANTREFERENCE is required with each order

l Public key certificate—For security reasons, you may choose to store the ps.gcsip.com or the ca.gcsip.com public

key certificate in your key store

Step two—Submitting the order

The consumer selects a payment product from your website.

You submit the payment request with

l Any merchant-required payment information (Example, DirectDebitText for a direct debit)

l The return URL to which the consumer is to be returned

The insert order with payment API call is always used with the HostedMerchantLink. For more information, see API call:
INSERT_ORDERWITHPAYMENT.

If there are additional keys required to process the payment successfully, you can either capture the data on your website or let WebCollect present a
site to capture the missing data.

Request API calls should be sent to the WebCollect payment server using HTTPS POST with the order and the payment details.

Important input keys

Key Description

l This is a unique order identifier that Ingenico ePayments generates

ORDERID l ORDERID is used to communicate with the Ingenico ePayments payment server

l You cannot change the ORDERID

MERCHANTOR l You can optionally send an order identifier that you generate in MERCHANTORDERID
DERID
l MERCHANTORDERID does not have to be unique

l MERCHANTREFERENCE can be used for reconciliation with Daily reports

MERCHANTREF l MERCHANTREFERENCE must be unique

ERENCE
l Do not include trailing spaces in MERCHANTREFERENCE

l RETURNURL determines the URL via which the consumer is returned to your site

RETURNURL l This can be sent per transaction or configured for all transactions on the account in collaboration with your Ingenico
ePayments Implementation Manager

Ingenico document - Reproduction or disclosure prohibited without written authorization

16
l EXPIRATIONPERIOD is optional and can be used to overrule any default time-limit setting for a specific transaction

EXPIRATIONPE l This is only supported by iDEAL (payment product ID 809) and eCard (payment prodict
RIOD
ID 402)

l HOSTEDINDICATOR can be turned on or off on a per transaction or configured for all transactions on the account in
collaboration with your Ingenico ePayments Implementation Manager

l You can use HostedMerchantLink by submitting HOSTEDINDICATOR=1 when using

HOSTEDINDICA
TOR HostedMerchantLink, or HOSTEDINDICATOR=0 to turn it off when using MerchantLink

Important return keys

Key Description

FORMACTION The URL that the consumer should be redirected to

A reference number for this order consisting of

l The MERCHANTID (10 digits)

REF l The ORDERID (10 digits)

l The EFFORTID (5 digits)

l The ATTEMPTID (5 digits)

A Message Authentication Code (MAC) is used to authenticate the redirection back to you after the payment

RETURNMAC Combined with REF, it forms a unique key for the transaction which is used by you to check if the

Key Description

redirection is authentic, and to determine the payment attempt involved

Status

The status of the payment attempt is now 20 – PENDING AT MERCHANT.

Step three—Redirecting the consumer to WebCollect

Using the URL specified in the FORMACTION, the consumer is redirected from your web shop to the HostedMerchantLink site. The redirection from
you to WebCollect is standardized and identical for all the payment products.

Step four—WebCollect verifies the redirection

When the consumer is redirected to the Ingenico ePayments HostedMerchantLink site, WebCollect verifies the REF and MAC, which are a part of the
FORMACTION.

If the REF and MAC are incorrect or expired

l A no-access page appears

l WebCollect is unable to redirect the consumer back to your site because WebCollect cannot authenticate the redirection and cannot determine
which merchant the faulty redirection comes from

If the REF and MAC are correct

l The payment attempt is retrieved If all required data is present

l The payment attempt is verified If all the required data is not present

l The enter-missing-details page appears to the consumer Here are possible missing details

Ingenico document - Reproduction or disclosure prohibited without written authorization

17
l Credit card details—Examples: The card number, the CVV code

l Direct debit details

l In the case of GiroPay, the bank account number (Konto nr.) and bank code (Bankleitzahl)

l In the case of iDEAL, this is the selection of the issuing bank of the consumer (ISSUERID)

The enter-missing-details page contains

l A customizable header and footer

l Text telling the consumer which missing data to enter

This text is the same for all payment products per payment method

Status
When the consumer has not submitted any payment details that were missing, the status of the payment attempt is 25 – PENDING AT Ingenico
ePayments.

After the submission when all the necessary details are captured, the status of the payment attempt changes to 30 – PENDING AT Ingenico
ePayments.

Step five—The consumer is redirected to a third-party payment site

For transactions requiring authentication (3D Secure), payments on the local bank site (real-time banking), or other payment products requiring
redirection (like eWallets) the consumer is redirected to a third-party payment site.

The site, which redirects the consumer to the third-party site, contains

l A header and footer

l Text telling the consumer that he or she is being redirected

The consumer is redirected automatically using a JavaScript on-load script. A real redirection is not possible using HTTPS POST.

In cases where the consumer browser does not allow the use of JavaScript to submit a POST automatically to perform the redirection to the third
party site, the page contains a link or a button for the consumer to perform the POST manually.

Status
The status of the payment attempt is now 50 – PENDING AT BANK.

The consumer authenticates or authorizes the payment using the method provided by the third party or by the local bank.

Step six—The consumer is redirected back to you

After completion of the payment, the third party or bank redirects the consumer back to WebCollect.

When the consumer is redirected back to WebCollect

l WebCollect captures and verifies the data

l The status of the payment is updated

l The consumer is redirected back to your site using an HTTPS 302 (temporary moved), so no site is actually presented to the consumer by Ingenico
ePayments

If the payment attempt is unsuccessful, WebCollect does not display the failure to the consumer. The status of the payment attempt can vary
depending on the results of the verification.

The redirection back to your site is standardized and identical for all the payment products.

Keys that are appended to the RETURNURL

Ingenico document - Reproduction or disclosure prohibited without written authorization

18
Key Definition Type Example

REF Reference AN50 000000999121100001480000100001

Signature to be used by WebCollect in combination with the provided RETURNURL

and the REF
RETURNM AN512 8USyNDgjCEF2iVVYguLo5SE2RC967FTKTpW5SB
AC eCrwI=

You must validate that the REF and the RETURNMAC form a unique pair known to you.

Step seven—You verify the payment status

Using API call: GET_ORDERSTATUS v2.0, you can verify the status of the payment.

The response to this call can be

l OK, STATUSID < 50—The consumer was not redirected to the bank payment site

The payment is not successful

l OK, STATUSID=50 or 650—The consumer was redirected to the bank payment site

A final status of the payment was not obtained by WebCollect from the bank

l OK, STATUSID>=800, PAYMENTPRODUCTID <> 11—The payment was successful and was confirmed to WebCollect

l OK, STATUSID>=800, PAYMENTPRODUCTID=11—It is unclear if the payment was successful and WebCollect

stopped trying to acquire the status of the payment at the third party

Some reasons for a NOK are

l The consumer cancelled the payment at the bank payment site

l The bank rejected the payment for undisclosed reasons, usually low funds

l The transaction failed at the bank

l The transaction expired because the consumer did not perform the payment within the given time period, usually the consumer closed his or her
browser at the third party site without completing the payment

For a successful payment, the return page on your site can display a success message to the consumer such as “Thank you for your order”.

For an unsuccessful payment, you may want to offer the consumer the option to pay using a different payment method. If the consumer does not
return to the specified RETURNURL, you can submit the API call: GET_ORDERSTATUS v2.0 to retrieve the status of the payment.

URLs for Staging and Production—Transfer to Production

After successful testing of the connections on the staging environment, Ingenico ePayments can authorize you for production.

The connections should be changed

l If you are not using client authentication, change from HTTPS://ps.gcsip.nl to HTTPS://ps.gcsip.com

l If you are using client authentication, change from HTTPS://ca.gcsip.nl to HTTPS://ca.gcsip.com

Style sheets and Ingenico ePayments hosted sites

A generic template is supplied by Ingenico ePayments by default. All elements in the Ingenico ePayments -controlled part of the page use classes
and IDs with which you can change the page layout. All payment products can be customized using a merchant-specific cascading style sheet (CSS).

The HostedMerchantLink pages can be set up to use an external style sheet hosted by you. To do this, supply this information to your Ingenico
ePayments Implementation Manager

l The CSS style sheet to be used for the site—Supply a link to an outside-hosted CSS

Ingenico document - Reproduction or disclosure prohibited without written authorization

19
The CSS must be hosted on an HTTPS server to avoid security warnings in the consumer browser

Any images used in the CSS must use a full path and must be hosted on an HTTPS server to avoid security warnings in the consumer browser

l An HTML header—The HTML that appears between the body tag and the WebCollect-controlled part of the page

Any images used in the HTML header must use a full path and must be hosted on an HTTPS server to avoid security warnings in the consumer
browser

l HTML footer—The HTML that appears between the WebCollect-controlled part of the page and the closing of the

body and HTML tags

Any images used in the HTML part must use a full URL and must be hosted on an HTTPS server to avoid security warnings in the consumer browser

Advanced CSS options

Ask your Ingenico ePayments Implementation Manager about appending MERCHANTREFERENCE and ORDERID as a query string to the URL of
the style sheet. You can use them as identifiers to serve up a transaction-specific style sheet.

Ingenico document - Reproduction or disclosure prohibited without written authorization

20
Merchant Link
Here are the process flows between the consumer, your site, and WebCollect.

Process flow between consumer, merchant, and WebCollect MerchantLink

Choose between process A and process B.

Process A
1. Process order with payment.

You have a limited number of payment methods or have all the logic stored on your server.

If the consumer has chosen his or her preferred payment method for a definitive payment on the WebCollect server, you can send the payment
information directly using the API call: INSERT_ORDERWITHPAYMENT.

1. Accept order and set payment (API calls: Accept order, SET_PAYMENT).

You should accept an order in the following situations:

When a consumer mandate is needed for a direct debit. Whether the order is singular or recurring, you must accept the order and register the
mandates.

When you choose to settle a credit card. These orders must be accepted within a week to ensure the validity of the authorization.

You can use either the WebCollect Payment Console or API calls to accept or reject orders. When you agree to an order, the API call: Accept order is
expected. Otherwise, you should send the API call: REJECT_ORDER. If a recurring order has failed and the corrected payment is made with a direct
debit, you should use the API call: SET_ PAYMENT to register the mandate.

1. Process corrections and recurring payments.

Ingenico ePayments sends physical recurring invoices via postal mail.

You can choose to offer a consumer the option to pay these invoices on your website.

When the consumer and order are identified on your site, you can optionally get the order status with the API call: GET_ORDERSTATUS, before
doing a new payment (step 4). Go to step 4.

Process B
1. Process order.

The consumer shops in your web shop and proceeds to check out.

You insert an order at the payment server (API call: INSERT_ORDER) and information about available payment products is returned based on the
country and amount.

1. Select payment product.

You list the available payment products for the consumer to select one.

1. Input Payment keys.

Ingenico document - Reproduction or disclosure prohibited without written authorization

21
You retrieve information about payment product keys for a payment product. To improve performance this information can be stored in memory at
your site.

Complete process (A and B)

1. Process payment.

The consumer submits payment information to your site. This information is then submitted to the payment server

(API call: DO_PAYMENT), which processes the payment and returns the payment status to you.

This step can be repeated for corrected payments. New variable-amount recurring payments also use this function.

Technical integration steps for MerchantLink

Preparation—Setting up the Ingenico ePayments account and your website

With your Ingenico ePayments Implementation Manager, your account is configured with the relevant

l Payment products

l Currencies

l Services

Example: Delayed settlement, fraud screening, 3D Secure

To pick up the Daily report files, access to the Ingenico ePayments SFT (secure file transfer) server is set up

l .wrt in staging

l .wr1 or wx1. in production

You adapt your website to display

l Payment products

l Currencies

l Consumer error and confirmation messages

In addition, develop redirections to third parties (3D Secure) and real-time banks, as needed

Staging—Accreditation testing

Test

l Connection and API calls

l Redirections to third-party authentication and real-time banks

l Confirmation of order status

l Receipt of Daily reports

l .wrt in staging

l .wr1 or wx1. in production

With the approval of your Ingenico ePayments Implementation Manager, your Ingenico ePayments account is switched on in production

Ingenico document - Reproduction or disclosure prohibited without written authorization

22
Switch your API call s to the production URL:

The switch is from HTTPS://ps.gcsip.nl/wdl/wdl to HTTPS://ps.gcsip.com/wdl/wdl

Process flow

The consumer selects payment and submits his or her data on your website

You submit the order information to WebCollect

For more information, see API call: INSERT_ORDERWITHPAYMENT

Process flow

WebCollect responds with authorization

You verify the status of the payment to determine if the order can be released to the consumer

Reports and remittance off-line data flows

This daily report is important for payment confirmation in case of any revised off-line bank transfers

l Daily report file—.wr1 or wx1. in production

Depending on your transaction volumes, you can choose to receive these reports daily or weekly

l Collection report

l Appendix to the collection report

l Financial statement

This is sent out monthly

l Ingenico ePayments invoice

Step-by-step how to—Setting up the MerchantLink connection

Step one—Pre-requisites
Before the connection between your system and WebCollect can be set up, provide this information to Ingenico ePayments

l IP addresses of your computer that connects to WebCollect or your Certificate information

l Public key certificate—For security reasons, you may choose to store the ps.gcsip.com or the ca.gcsip.com public key certificate in your key store

Step two—Store your order

For later use and reference, you must store the order in your system. You can store it in a database or a file. Storing the order is required for your
order to be fulfilled.

You must be able to retrieve the order by ORDERID when Ingenico ePayments has confirmed a payment for it through the Daily report file (.wr1 or
wx1.).

An ORDERID combined with a payment number is called an EFFORTID. The EFFORTID identifies a recurring payment.

For further reference and to help reconciliation, an additional, unique MERCHANTREFERENCE is required with each order.

Ingenico document - Reproduction or disclosure prohibited without written authorization

23
Step three—Sending API calls
A request should be HTTPS POSTed with the order or payment details to the WebCollect Payment Server. The string is an API call containing the
details of the request.

The payment server returns the result of the online payment request. The result keys depend on the payment method used.

Step four—Transfer to production

After successfully testing the connections on the staging environment, Ingenico ePayments can authorize you for production.

At that point

l If you are not using client authentication, change the connections used in your system from HTTPS://ps.gcsip.nl/wdl/wdl to HTTPS://ps.gcsip.com
/wdl/wdl

l If you are using client authentication, change the connection from HTTPS://ca.gcsip.nl/wdl/wdl to

HTTPS://ca.gcsip.com/wdl/wdl

Ingenico document - Reproduction or disclosure prohibited without written authorization

24
2 - Payment Status Communicator
Ingenico ePayments uses the Payment Status Communicator to provide you with status information on successful orders. This service communicates
the results of a payment from the payment server to you within two minutes of processing.

To enable this service, you must

l Set up an HTTPS web server site to accept the status posting

l Ask Ingenico ePayments to configure the account with the URL

The Payment Status Communicator expects an OK or NOK to be returned as a response. No white spaces, redundant new lines, HTML tags, or any
other characters should be returned.

Payment Status Communicator messages are sent on successful orders with a status of equal to or greater than 500 only.

Parameters for payment messages

Key Definition Type Example

MERCHANTID Merchant identifier N10 1

ORDERID Unique order identifier generated by Ingenico ePayments N10 212121

EFFORTID The sequence number for recurring orders N5 1

ATTEMPTID Identifier of the last successful payment attempt N5 1

AMOUNT Amount of payment in cents N12 29990 (=299.90)

CURRENCYCODE ISO 4217 currency code of payment AN3 USD

Payment reference identifier

Use this value as REFERENCEORIGPAYMENT in case of

ADDITIONALREFERE refunds—See API call: DO_REFUND AN30 00000000010000212121000010

NCE 0001

Payment Reference generated by WebCollect or taken from the tag

OVERWRITEPAYMENTREFERENCE for

l Bank transfer

l Online banking
PAYMENTREFERENCE AN20 191900000001
l Real-time banking

Key Definition Type Example

l Check payments

PAYMENTMETHODID Chosen payment method N5 1 (credit card online)

PAYMENTPRODUCTID Chosen payment product N5 1 (VISA)

STATUSID Status of the order N5 See WebCollect status codes

Status date of the payment

STATUSDATE Format: CCYYMMDDHH24MISS N14 20030828152500

RECEIVEDDATE Date on which the payment is received N14 20030828152500

PROFILETOKEN Token of the profile used with this order AN40 84c19ac1-f64b-492d-ae25-
41724afcf086

MERCHANTORDERID Order ID generated by the merchant N10 123

MERCHANTREFERENCE Unique payment reference used by the merchant AN50 VAL123456

Last four digits of the credit card number— Only when

PSCCOMMUNICATECCDETAILS is
CCLASTFOURDIGITS N4 1234
configured

Ingenico document - Reproduction or disclosure prohibited without written authorization

25
Expiry date—Only when PSCCOMMUNICATECCDETAILS is

configured

EXPIRYDATE Format: MMYY N4 1213

Card security code (CVV) result—Only when PSCCOMMUNICATECCDETAILS is

CVVRESULT configured AN1 N

Address Verification Service (AVS) result— Only when

PSCCOMMUNICATECCDETAILS is
AVSRESULT AN1 N
configured

Fraud check result—Only when PSCCOMMUNICATECCDETAILS is

FRAUDRESULT configured AN1 N

Expected response with each message

\n indicates a new line

Message Meaning Description

OK\n ACCEPTED The message is received and successfully processed

NOK\n REJECTED The message is received but not accepted

Sample PSC message with PSCCOMMUNICATECCDETAILS configured

ONALREFERENCE=1234567890&PAYMENTMETHODID=1&PAYMENTPRODUCTID=3&STATUSID=625&STAT
USDATE=20120314144539&RECEIVEDDATE=20120314144334&CURRENCYCODE=EUR&AMOUNT=1000&CV
VRESULT=0&FRAUDRESULT=A&CCLASTFOURDIGITS=1111&EXPIRYDATE=0113

Sample PSC message without PSCCOMMUNICATECCDETAILS configured

MERCHANTID=9991&ORDERID=98765432&EFFORTID=1&ATTEMPTID=2&PAYMENTREFERENCE=99910111
1119&ADDITIONALREFERENCE=911121242154&PAYMENTMETHODID=7&PAYMENTPRODUCTID=11&STAT
USID=800&STATUSDATE=20120314143420&RECEIVEDDATE=20120314143420&CURRENCYCODE=EUR&AM OUNT=150

Ingenico document - Reproduction or disclosure prohibited without written authorization

26
3 - Connection
Send all API calls to Ingenico ePayments using

l HTTPS 1.1 POST using TLS v1.0

l An API call cannot have a content size greater than 256Kb

Content-Type and character set

l The Content-Type must be “text/xml; charset=utf-8”

l The default character set in the system is UTF-8

In all cases ensure that the data that you send to WebCollect is encoded as specified in the HTTPS header. It is possible to specify a different
character set, but this could result in receiving inappropriate characters.

Security checks
To ensure that only you, the configured merchant, can send requests on behalf of your own account, one of these two possible checks is performed.

IP check
When a request is sent to the payment server, the IP address or the IP address range from where the connection was made is verified.

l If it matches the IP address that you set up with Ingenico ePayments, the request is processed

l If information is missing or incorrect, the payment server responds with an error message indicating the error in the request

Client authentication using a client certificate

l A trusted third party such as VeriSign, Thawte, or Cybertrust must sign this certificate

l You must generate a key-pair

l Secure the private key

l Send the public key to the certificate authority to be incorporated in a certificate request

l When a signed certificate is created using the certificate authority, it must be installed by the client—Then the client can load it and present it when
needed

l When a certificate is requested, the subject of the certificate must be communicated to Ingenico ePayments. For

example, the subject of the Ingenico ePayments certificate (ps.gcsip.com) might include these details

l C=NL

l L=Hoofddorp

l S or ST=Noord Holland

l O=Ingenico ePayments Services B.V.

l CN=*.gcsip.com

These details are verified by WebCollect and as such are mandatory in the subject of the client certificate

Ingenico document - Reproduction or disclosure prohibited without written authorization

27
Abbreviation X.509 specification field name WebCollect name Description

C countryName DNCOUNTRY Country

L locality DNLOCALITY Locality

S or ST stateOrProvinceName DNSTATE State or province name

O organizationName DNORGANIZATION Organization name

OU organizationalUnitName DNORGANIZATIONALUNIT Organizational unit name

CN commonName DNCOMMONNAME Common name

For security reasons you may store the ps.gcsip.nl and the ps.gcsip.com public key certificate in your key store.

If you do not do so, make sure that the certificate is renewed every year. A renewal reminder is distributed one month in advance of the renewal date.

For information on specific environments visit

l HTTPS://support.microsoft.com/default.aspx?scid=kb;EN-US;q301429

l HTTP://www.thawte.com/resources/index.html

For information on adding a root certificate to your PHP-cURL environment, see Adding a root certificate to PHP-cURL.

Supported certificate authorities

The certificate authorities supported by WebCollect are

l GTE Cybertrust Global Root

l GTE Cybertrust Root CA

l Thawte Premium Server CA

l Thawte Server CA

l Verisign Class3 Secure Server CA—Verisign, Inc.

URLs—Staging environment

Link Description

For IP-check HTTPS://ps.gcsip.nl/wdl/wdl

MerchantLink For client authentication HTTPS://ca.gcsip.nl/wdl/wdl

For IP-check HTTPS://wpc.gcsip.nl/wpc

WebCollect Payment Console For client authentication HTTPS://ca.gcsip.nl/wpc/wpc

URLs—Production environment

Link Description

For IP-check HTTPS://ps.gcsip.com/wdl/wdl

MerchantLink For client authentication HTTPS://ca.gcsip.com/wdl/wdl

Ingenico document - Reproduction or disclosure prohibited without written authorization

28
For IP-check HTTPS://wpc.gcsip.com/wpc

WebCollect Payment Console For client authentication HTTPS://ca.gcsip.com/wpc/wpc

Recommended timeout—70 seconds

Ingenico ePayments recommends a time-out value of 70 seconds.

Service disruption—Failover environment

In case of a service disruption, Ingenico ePayments uses a failover environment. To ensure that your system automatically switches to the failover
environment, you must

l Target the DNS name in the URLs—Production environment instead of an IP address

l Minimize your system refresh intervals to guarantee a timely automatic switch to the failover environment

Verify your connection

To verify that your connection is working correctly, use API call: TEST_CONNECTION.

l If the response is OK, the connection is working correctly

l If the response is NOK, the connection is not working correctly—Check your settings on your end If your connection is still not working correctly,
contact Ingenico ePayments

Ingenico document - Reproduction or disclosure prohibited without written authorization

29
4 - API call format
Understanding API calls
Ingenico ePayments API calls use modified XML.

The format of an API call to post is

<XML><REQUEST><ACTION>..action..</ACTION>..Input keys..</REQUEST></XML>

The API call contains a number of key value pairs

<KEY>..value..</KEY>

The API response is generally formatted as

<XML>

... Input keys...

<ROW>

...Result keys... depends on request

</ROW>

</RESPONSE>

</REQUEST>

<XML>

... Input keys...

<META>

<RESPONSEDATETIME>yyyymmddhh24miss</RESPONSEDATETIME>

<REQUESTID>request ID</REQUESTID>

</META>

<ERROR>

<CODE>... error code ...</CODE>

<MESSAGE>... message ...</MESSAGE>

</ERROR>

...

</RESPONSE>

</REQUEST>

<XML>

REQUESTIPADDRESS is added by WebCollect in the first META tags of your response. Optionally, empty key values can be left out completely.

Ingenico document - Reproduction or disclosure prohibited without written authorization

30
Components of an API call explained

Column Explanation

Key Name of the key

Definition Description of, or more information about, the key

Type and length of the key

l AN—Alphanumeric: A combination of letters and numbers

Type l N—Numeric: Numbers

l D—Date: Numbers

Whether the key is required or optional

Req l R—Required

l O—Optional

Example An example of the API call

List of API calls

Depending on the Ingenico ePayments system you choose for your web shop, here are the API calls you can use to configure your system.

API call method Description

Cancels a payment request

CANCEL_PAYMENT Only applicable to payments with a status that is not yet final

CANCEL_PAYOUT Cancels a payout

CANCEL_REFUND Cancels a refund

CANCEL_SET_PAYMENT Cancels a set payment

CANCEL_SET_REFUND Cancels a set refund

CONVERT_AMOUNT Converts an amount to another currency

CONVERT_ PAYMENTTOPROFILE Creates a token based on an existing payment

CREATE_PROFILE Informs Ingenico ePayments about the intent to generate a mandate and request its

API call method Description

storage

DO_BANKVALIDATION Validates bank details against country-specific rules

DO_BINLOOKUP Returns the country where the card was issued for a given credit card BIN, if known

Checks if a credit card is enrolled in a 3D Secure program

DO_CHECKENROLLMENT l Verified by VISA

l MasterCard SecureCode

DO_FINISHPAYMENT Attempts an online credit card authorization and, optionally, the fraud check in cases where no valid
authentication result was obtained

DO_PAYMENT Inserts a payment attempt on an existing order

Ingenico document - Reproduction or disclosure prohibited without written authorization

31
DO_PAYOUT Inserts a payout request

DO_REFUND Inserts a refund request

DO_RISKASSESSMENT Performs a fraud check without continuing to process the payment

DO_VALIDATE Performs an authentication validation for an online credit card transaction

GET_BANKDETAILS Converts and compares bank details such as BBAN and IBAN information

GET_DIRECTORY Retrieves a directory for use with a specific payment product

GET_ORDER Retrieves the information to redirect the consumer to the Hosted Payment Pages

GET_ORDERSTATUS Retrieves the status and additional information on an outstanding order

GET_ PAYMENTPRODUCTFI Retrieves input keys that are applicable for a payment with a payment product
ELDS

GET_PAYMENTPRODUCTS Retrieves the payment products that are available

GET_PROFILE Retrieves the details of a mandate that must be printed and signed by the consumer

GET_RATE Retrieves dynamic currency conversion (DCC) parameters, if applicable

INSERT_ORDER Inserts an order and retrieves the available payment products for the order

INSERT_ ORDERWITHPAYM Inserts an order and a payment attempt in a single API call
ENT

INVALIDATE_PROFILE Informs Ingenico ePayments about the cancellation of a mandate

MODIFY_ORDER Changes some order data on the payments left on a recurring order

PROCESS_CHALLENGED Processes payments with a fraud result of challenged 525: Authorized and checked, waiting for explicit
instructions for settlement

REJECT_ORDER Rejects a recurring order and the payment done by a consumer

SET_PAYMENT Used either for settle request, for authorized credit card payments, or to register mandates for direct debit

SET_PAYOUT Used to confirm a payout that displays a status of pending

SET_REFUND Approves a pending refund request

TEST_CONNECTION Tests your connection

UPDATE_PROFILE Informs Ingenico ePayments of a mandate modification

VALIDATE_PROFILE Informs Ingenico ePayments that you received a mandate

Ingenico document - Reproduction or disclosure prohibited without written authorization

32
5 - API calls
CANCEL_PAYMENT
CANCEL_PAYOUT
CANCEL_REFUND
CANCEL_SET_PAYMENT
CANCEL_SET_REFUND
CONVERT_AMOUNT
CONVERT_PAYMENTTOPROFILE
CREATE_PROFILE
DO_BANKVALIDATION
DO_BINLOOKUP
DO_CHECKENROLLMENT
DO_FINISHPAYMENT
DO_FINISHPAYMENT only for PAYPAL
DO_PAYMENT
DO_PAYOUT
DO_REFUND
DO_RISKASSESSMENT
DO_VALIDATE
GET_BANKDETAILS
GET_DIRECTORY
GET_ORDER
GET_ORDERSTATUS
GET_PAYMENTPRODUCTFIELDS
GET_PAYMENTPRODUCTS
GET_RATE
INSERT_ORDER
INSERT_ORDERWITHPAYMENT
INVALIDATE_PROFILE
MODIFY_ORDER
PROCESS_CHALLENGED
REJECT_ORDER
SET_PAYMENT
SET_PAYOUT
SET_REFUND
TEST_CONNECTION
UPDATE_PROFILE
VALIDATE_PROFILE
DO_AUTHENTICATE

Ingenico document - Reproduction or disclosure prohibited without written authorization

33
CANCEL_PAYMENT
This API call is used for payments with a status that is not already final. Payments that can be cancelled are

l Direct debit payments that are on hold waiting for a mandate

l Authorized credit card transactions that are not sent to Ingenico ePayments for settlement

l If cancel payment is configured to act as a void, the payment is cancelled with WebCollect and you, and the information is sent to the issuer

For more information about configuring this API call to act as a void, contact your Ingenico ePayments merchant implementation manager

The cancel payment structure is REQUEST

ACTION META PARAMS

PAYMENT

CANCEL_PAYMENT input keys

Key Definition Type Req Example

ACTION CANCEL_PAYMENT AN R CANCEL_ PAYMENT

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

PAYMENT Marker (no key) – – –

ORDERID Order ID of payment to cancel N10 R 9998890004

EFFORTID Payment number to cancel N5 R 1

ATTEMPTID Attempt ID of payment to cancel N5 R 1

AUTHORIZATIONREVERSALINDICATOR Indicates if a transaction should be N1 O 1

Key Definition Type Req Example

reversed—Overrides configured value

l 0=Do not reverse authorization

l 1=Reverse authorization

ENDPAYMENT Marker (no key) – – –

ENDPARAMS Marker (no key) – – –

CANCEL_PAYMENT return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Ingenico document - Reproduction or disclosure prohibited without written authorization

34
Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

VOIDRESPONSEID Result of the request N3 98

ENDROW Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 400210

MESSAGE Message for error or event AN4000 REQUEST 2491 UNKNOWN ORDER OR NOT CANCELLABLE

ENDERROR Marker (no key) – –

CANCEL_PAYMENT example

<XML>

<ACTION>CANCEL_PAYMENT</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

CANCEL_PAYMENT possible response

<XML>

<ACTION>CANCEL_PAYMENT</ACTION>

<META>

</META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

35
<ORDERID>9998890004</ORDERID>

</PAYMENT>

</PARAMS>

<META>

</META>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

36
CANCEL_PAYOUT
This API call is used for payouts with a status that is not already final. The cancel payout structure is

REQUEST

ACTION

META

PARAMS

PAYMENT

CANCEL_PAYOUT input keys

Key Definition Type Req Example

ACTION CANCEL_PAYOUT AN R CANCEL_PAYOUT

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

Key Definition Type Req Example

PARAMS Marker (no key) – R –

PAYMENT Marker (no key) – – –

ORDERID Order ID of payment to cancel N10 R 9998890004

-1

EFFORTID Payment number to cancel N5 R EFFORTID must be set to -1

ATTEMPTID Attempt ID of payment to cancel N5 R 1

ENDPAYMENT Marker (no key) – – –

ENDPARAMS Marker (no key) – – –

CANCEL_PAYOUT return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 400210

MESSAGE Message for error or event AN4000 REQUEST 2491 UNKNOWN ORDER OR NOT CANCELLABLE

ENDERROR Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

37
CANCEL_PAYOUT example

<XML>

<ACTION>CANCEL_PAYOUT</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

CANCEL_PAYOUT possible response

<XML>

<ACTION>CANCEL_PAYOUT</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

38
</META>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

39
CANCEL_REFUND
This API call is used for a payment that has a status but is not final. Refunds that can be cancelled are

l On hold waiting for an approval with a status of 600

l Approved or ready to be processed by Ingenico ePayments with a status of 800 The cancel refund structure is

REQUEST ACTION META PARAMS

PAYMENT

CANCEL_REFUND input keys

Key Definition Type Req Example

ACTION CANCEL_REFUND AN R CANCEL_ REFUND

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

Key Definition Type Req Example

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

PAYMENT Marker (no key) – – –

ORDERID Order ID of payment to cancel N10 R 9998890004

EFFORTID Payment number to cancel N5 R -1

ATTEMPTID Attempt ID of payment to cancel N5 R 1

ENDPAYMENT Marker (no key) – – –

ENDPARAMS Marker (no key) – – –

CANCEL_REFUND return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 1000300

MESSAGE Message for error or event AN4000 NOT_A_REFUND

ENDERROR Marker (no key) – –

CANCEL_REFUND example

<XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

40
<REQUEST>

<ACTION>CANCEL_REFUND</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

CANCEL_REFUND possible response

<XML>

<ACTION>CANCEL_REFUND</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

<META>

</META>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

41
Ingenico document - Reproduction or disclosure prohibited without written authorization
42
CANCEL_SET_PAYMENT
This API call is used for payments with a ready status of 800; it returns the payment to a pending state with a status of 600.

The cancel set payment structure is REQUEST

ACTION META PARAMS

PAYMENT

CANCEL_SET_PAYMENT input keys

Key Definition Type Req Example

ACTION CANCEL_SET_PAYMENT AN R CANCEL_SET_PAYMENT

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

Key Definition Type Req Example

PARAMS Marker (no key) – R –

PAYMENT Marker (no key) – – –

ORDERID Order ID of payment to return to pending state N10 R 9998890004

EFFORTID Payment number to return to pending state N5 O 1

ATTEMPTID Attempt ID of payment to return to pending state N5 O 1

ENDPAYMENT Marker (no key) – – –

ENDPARAMS Marker (no key) – – –

CANCEL_SET_PAYMENT return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

Format:
YYYYMMDDHHMMSS
RESPONSEDATETIME N14 20130604123456

ENDMETA Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 400300

MESSAGE Message for error or event AN4000 PAYMENTATTEMPT (MERCHANTID=1, ORDERID=9998890004, EFFORTID=1)
NOT_FOUND

ENDERROR Marker (no key) – –

CANCEL_SET_PAYMENT example

Ingenico document - Reproduction or disclosure prohibited without written authorization

43
<XML>

<ACTION>CANCEL_SET_PAYMENT</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

CANCEL_SET_PAYMENT possible response

<XML>

<ACTION>CANCEL_SET_PAYMENT</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

<META>

</META>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

44
CANCEL_SET_REFUND
This API call is used for refunds with a ready status of 800; it returns the refund to a pending state with a status of 600. The cancel set refund
structure is

REQUEST ACTION META PARAMS

PAYMENT

Input keys

Key Definition Type Req Example

ACTION CANCEL_SET_REFUND AN R CANCEL_SET_REFUND

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

Key Definition Type Req Example

PAYMENT Marker (no key) – – –

ORDERID Order ID of payment to cancel N10 R 9998890004

EFFORTID Payment number to cancel N5 O 1

ATTEMPTID Attempt number N5 O 1

ENDPAYMENT Marker (no key) – – –

ENDPARAMS Marker (no key) – – –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

Format:
YYYYMMDDHHMMSS
RESPONSEDATETIME N14 20130604123456

ENDMETA Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 400300

MESSAGE Message for error or event AN4000 PAYMENTATTEMPT (MERCHANTID=1, ORDERID=9998890004, EFFORTID=1)
NOT_FOUND

ENDERROR Marker (no key) – –

Example

<XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

45
<REQUEST>

<ACTION>CANCEL_SET_REFUND</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>CANCEL_SET_REFUND</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

<META>

</META>

</RESPONSE>

</REQUEST>

Ingenico document - Reproduction or disclosure prohibited without written authorization

46
</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

47
CONVERT_AMOUNT
This API call converts an amount from one currency to another. The rates used for the conversion are based on the daily rates supplied by Reuters.

The convert amount structure is REQUEST

ACTION META PARAMS

GENERAL

Input keys

Key Definition Type Req Example

ACTION CONVERT_AMOUNT AN R CONVERT_AMOUNT

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

GENERAL Marker (no key) – R –

AMOUNT Amount to be converted in cents N12 R 29990 (=299.90)

Key Definition Type Req Example

SOURCECURRENCYCODE ISO 4217 currency code of amount to be converted AN3 R EUR

TARGETCURRENCYCODE ISO 4217 currency code of target amount AN3 R USD

ENDGENERAL Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT OK or NOK – –

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

CONVERTEDAMOUNT Converted amount in cents N12 66089 (=660.89)

ENDROW Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 20000000

MESSAGE Message for error or event AN4000 PARAMETER BANKCODE NOT FOUND IN REQUEST

ENDERROR Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

48
Example

<XML>

<ACTION>CONVERT_AMOUNT</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>CONVERT_AMOUNT</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

49
</META>

<ROW>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

50
CONVERT_PAYMENTTOPROFILE
This API call supports tokenization without compromising security. Tokenization is the process of replacing sensitive data with a reference. By
referring to tokenized data, you can reuse previously submitted sensitive data without having to store it in your system. Ingenico ePayments issues
the token and bears the responsibility for keeping the sensitive data safe.

To create a token based on an existing payment

1. Create a new order and include order and payment attempt information in the INSERT_ORDERWITHPAYMENT API call.
2. Use the CONVERT_PAYMENTTOPROFILE API call to convert the information for an order and payment attempt

to a profile.

The convert payment to profile structure is REQUEST

ACTION META PARAMS

PAYMENT

Input keys

Key Definition Type Req Example

ACTION CONVERT_PAYMENTTOPROFILE AN R

META Marker (no key) – –

MERCHANTID ID of merchant (provided by Ingenico ePayments) N10 R 1

VERSION Version of XML interface AN10 R 1.0

ENDMETA Marker (no key) – –

PARAMS Marker (no key) – –

PAYMENT Marker (no key) – –

ORDERID Order ID generated by Ingenico ePayments N10 R 123

EFFORTID Payment effort number—If not provided, the last successful effort is used N5 O 1

ATTEMPTID Payment attempt number—If not provided, the final attempt is used (assume there is only one) N5 O 1

PAYMENTPRODUCTID Payment product ID—If no effort or attempt is provided, the payment product ID can be used to locate the desired N5 O 1
attempt

PROFILETOKEN Token provided by merchant AN40 O

CUSTOMERID Consumer ID used in CREATE_PROFILE—Overwrites the consumer ID from existing data (if present) AN15 O

ENDPAYMENT Marker (no key) – –

ENDPARAMS Marker (no key) – –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

PROFILETOKEN Token for the next payment; only if OK AN40 af16af70-2bf5-44e9-a087-68c87f67e3a1

ORDERID Order ID generated by Ingenico ePayments N10 123

ENDROW Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

51
Example

<XML>

<ACTION>CONVERT_PAYMENTTOPROFILE</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>CONVERT_PAYMENTTOPROFILE</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

<META>

</META>

<ROW>

Ingenico document - Reproduction or disclosure prohibited without written authorization

52
<PROFILETOKEN>af16af70-2bf5-44e9-a087-68c87f67e3a1</PROFILETOKEN>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

53
CREATE_PROFILE
This API call informs Ingenico ePayments about the intent to generate a

l Mandate and request its storage for SEPA

l Profile and request its storage for tokenization The create profile structure is

REQUEST ACTION META PARAMS

PROFILE MANDATE

Input keys

Key Definition Type Req Example

ACTION CREATE_PROFILE AN R CREATE_PROFILE

META Marker (no key) – –

MERCHANTID ID of merchant N10 R 1

VERSION Version of interface AN10 R 1.0

ENDMETA Marker (no key) – –

PARAMS Marker (no key) – –

PROFILE Marker (no key)

CUSTOMERID ID of customer AN15 O 1

PAYMENTPRODUCTID Payment product identifier N5 R 770

… billing address information …

… credit card information …

… eWallet information …

Direct debit information

IBAN International Bank Account Number AN50 R NL39RABO03000652

BIC Bank Identifier Code AN11 O ABNANL2A

ENDPROFILE Marker (no key) – –

MANDATE Marker (no key) – –

MANDATEID Unique mandate identifier AN35 O 1234567253

CUSTOMERCONTRACTIDENTIFI Identifies the contract between customer and merchant AN35 O

Identifies the type of transaction that this specific mandate accepts for the SEPA direct
debit

l S=One-off

l F=First recurring
TRANSACTIONTYPE AN2 R S
l R=Second and subsequent recurring

l L=Last recurring

Mandate name information

SURNAME Debtor last name AN70 R Buuren

FIRSTNAME Debtor first name AN15 O Jack

PREFIXSURNAME Prefix of the debtor last name AN15 O Van

Mandate address information

CITY City of the consumer address AN40 O Amsterdam

STREET Street of the consumer address AN50 O Polarisavenue

Ingenico document - Reproduction or disclosure prohibited without written authorization

54
HOUSENUMBER House number of the consumer address AN15 O 1

ADDITIONALADDRESSINFO Additional information about the consumer address AN50 O A

ZIP ZIP code of the consumer address AN10 O 1000 AA

Key Definition Type Req Example

STATE State of the consumer address AN35 O Noord-Holland

STATECODE State code AN9 O NH

COUNTRYCODE ISO 3166 country code of the consumer address AN2 R NL

Mandate signature information

MANDATEPLACE City in which the consumer signed the mandate AN40 O Hoofddorp

Date of mandate signature

MANDATEDATE Format: YYYYMMDD N8 O 20131018

MANDATESIGNED l 0=Mandate is not signed N1 O 1

l 1=Mandate is signed

Mandate pre-notification information

Consumer email address

EMAIL Required when PRENOTIFICATION=1 AN70 C [email protected]

Preference for type of email

l 0=Plain text (ASCII)

EMAILTYPEINDICATOR l 1=HTML N1 C 1

Required when PRENOTIFICATION=1

l 0=Do not send a pre-notification email to the consumer

l 1=Send a pre-notification email to the

PRENOTIFICATION consumer on the first collection AN1 O 1

The email is sent from your email address

ENDMANDATE Marker (no key) – –

ENDPARAMS Marker (no key) – –

Return keys

Key Definition Type Example

REQUEST Marker (no key) – –

RESPONSE Marker (no key) – –

Result of the action

RESULT l OK AN3 OK

l NOK

PROFILETOKEN Token for the next payment; only if OK AN40 af16af70-2bf5-44e9-a087-68c87f67e3a1

ERROR Marker (no key); only if NOK – Refer to the WebCollect error codes guide

CODE Error or event code N10 400220

TYPE Type of error AN1 Y

MESSAGE Message for error or event AN4000 DOPAYMENT_ORDER_NOT_FOUND

ENDERROR Marker (no key) – ENDERROR

ENDRESPONSE Marker (no key) – ENDRESPONSE

ENDREQUEST Marker (no key) – ENDREQUEST

Ingenico document - Reproduction or disclosure prohibited without written authorization

55
Ingenico document - Reproduction or disclosure prohibited without written authorization
56
DO_AUTHENTICATE
This API call only refers to Merchant Link integration. It is called by the merchant in the case that a MethodURL flow has been requested from the
issuer, in order to notify IeP that the operation is complete. The current implementation refers to credit card processing flow.

The DO_AUTHENTICATE API structure is the below:

REQUEST

ACTION

META

PARAMS

PAYMENT

AUTHENTICATE

Input keys

Key Definition Type Req Example

ACTION DO_AUTHENTICATE AN R DO_AUTHENTICATE

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

REQUESTSOURCE Source application AN R WDL, APP, ORB, RPP

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

PAYMENT Marker (no key) – R –

ORDERID Unique ID generated by IeP N10 R 9998890004

EFFORTID Payment effort N5 R –

ATTEMPTID Indicates how many attempts have been made for this payment N5 R

ENDPAYMENT Marker (no key) – R –

AUTHENTICATE Marker (no key) – R –

THREEDSMETHODCOMPLETIONINDICATOR 3DS Method Completion Indicator N1 O

THREEDSSERVERTRANSACTIONID 3ds server transaction id (send by DO_PAYMENT/IOWP response) AN36 O

ENDAUTHENTICATE Marker (no key) - R -

ENDPARAMS Marker (no key) - R -

Return keys
Key Definition Type Example

RESULT OK or NOK AN10 –

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

RESPONSEDATETIME Date & Time of the response in format: YYYYMMDDHHMMSS N14 20190213120550

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

CUSTOMERTHREEDMET CardHolder 3D authentication method N2 1 = Frictionless authentication

HOD occurred by ACS

2 = Cardholder challenge
occurred by ACS

3 = AVS verified

4 = Other issuer methods

CUSTOMERTHREEDDATE CardHolder 3D authentication timestamp N12

Ingenico document - Reproduction or disclosure prohibited without written authorization

57
CUSTOMERTHREEDREF CardHolder 3D authentication reference AN36

THREEDSSERVERTRAN 3ds server transaction id (send by DO_PAYMENT/IOWP response) AN36

SACTIONID

ACSTRANSACTIONID Universally Unique transaction identifier assigned by the ACS to identify a single AN36
transaction.

CREQ Base64 encoded Creq json data AN5

000

ACSCHALLENGEMANDA Indication of whether a challenge is required for the transaction to be authorized due to local A1 Values accepted:
TED /regional mandates or other variable. • Y = Challenge is mandated
• N = Challenge is not mandated

REDIRECTINFO Marker (no key) - –

FORMMETHOD http method type - POST A10 –

PROVIDERURL Redirect URL AN2 –

048

FORMPARAMETERS form parameters submitted to http form post AN5 –

000

ENDREDIRECTINFO Marker (no key) - –

ENDROW Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

58
DO_BANKVALIDATION
This API call validates entered bank details against country-specific rules.

The do bank validation structure is REQUEST

ACTION META PARAMS

GENERAL

Country-dependent bank details

The bank details to be validated are different for each of the supported countries. Here are the country-dependent bank details.

Country Bank details

Country code Sort code Account number Bank or branch code Bank code Branch code Check digit Fiscal number

Andorra X X X X

Australia X X X

Austria X X X

Belgium X X X X

Bosnia and Herzegovina X X X X

Bulgaria X X X

Canada X X X

Croatia X X X

Cyprus X X X X

Czech Republic X X X

Denmark X X X

Estonia X X X

Finland X X X

France X X X X X

Germany X X X

Greece X X X X

Hong Kong X X X X

Hungary X X X

Iceland X X X X

Ireland X X X

Italy X X X X X

Latvia X X X

Liechtenstein X X X

Country Bank details

Country code Sort code Account number Bank or branch code Bank code Branch code Check digit Fiscal number

Lithuania X X X

Luxembourg X X X

Malta X X X

The Netherlands X X X

New Zealand X X X

Norway X X X

Poland X X X X

Portugal X X X X X

Romania X X X

Ingenico document - Reproduction or disclosure prohibited without written authorization

59
Singapore X X X X

Slovak Republic X X X

Slovenia X X X

South Africa X X X

Spain X X X X X

Sweden X X X

Switzerland X X X

Thailand X X X X

Tunisia X X X X X

United Kingdom X X X

USA X X X

Two-step bank validation solution

Step one
Check your syntax and your system

l Is the data in the request compliant with the required data format (syntax)?

l Can the system successfully perform the validation (system)?

The result is either

l OK—The system returns an OK when this step is successful and the validation check can proceed

l NOK accompanied by an error code—The system returns a NOK when this step is unsuccessful and the validation check cannot proceed

If the result of step one is OK, the validation check can be performed. Go to step two.

Step two
The validation is performed and the return rows display the results of the different validation checks. Validation check results can be

l PASSED

l WARNING

l ERROR

l NOTCHECKED—Appears if an earlier check prevents the next check from being performed

Input keys

Key Definition Type Req Example

ACTION DO_BANKVALIDATION AN R DO_

BANKVALIDATION

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

IPADDRESS IP address of merchant server AN O 123.123.123.123

VERSION Version of interface AN O 1.0

ENDMETA Marker (no key) – R –

Ingenico document - Reproduction or disclosure prohibited without written authorization

60
PARAMS Marker (no key) – R –

GENERAL Marker (no key) – R –

Unique reference of merchant for payment

MERCHANTREFERENCE allowed input is ASCII 32–126 characters—Do not include trailing spaces in the
MERCHANTREFERENCE
MERCHANTREFER AN R –
ENCE 50

BANKNAME Sets the bank name to be validated AN O CITIBANK

In US it should be possible to verify the name of the account holder

ACCOUNTNAME It may be used in future AN O JONES

COUNTRYCODEBA ISO 3166 country code of the country where the bank account is held AN2 R DE
NK

BBAN information—You must provide BBAN information or IBAN information. Do not provide both. Ingenico ePayments recommends that you provide IBAN
information.

ACCOUNTNUMBER Sets the account number to be validated AN R 12345678A2

Sets the bank code to be validated

BANKCODE BANKCODE is required for AT, DE, ES, FR, and GB AN C 200000
15

Sets the check digit to be validated

BANKCHECKDIGIT BANKCHECKDIGIT is required for ES and FR AN2 C 1

Sets the branch code to be validated C

BRANCHCODE BRANCHCODE is required for ES and FR AN 12345

IBAN information—You must provide BBAN information or IBAN information. Do not provide both. Ingenico ePayments recommends that you provide IBAN
information.

IBAN International Bank Account Number AN C NL39RABO030006

50 5264

Bank Identifier Code

BIC If the BIC check fails, no other checks are done AN C ABNANL2A
11

Key Definition Type Req Example

ENDGENERAL Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition T Example

y
pe

OK or NOK

The RESULT field returns an OK value as long as Ingenico ePayments can validate the account information. To
confirm that the validation is successful, you must examine the check code results. In addition, please note that if
the BIC check fails, no other checks are done

RESULT A NOK
N
10

VALIDATI ID of validation N 3234243

ONID 10

META Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

61
REQUEST Internal ID of request N 12345111
ID 10

Date and time of response

RESPONS Format: YYYYMMDDHHMMSS N 20130604123456

EDATETI 14
ME

ENDMETA Marker (no key) – –

See the WebCollect error

codes guide
ERROR Marker (no key) –

CODE Error or event code N 20000000

PARAMETER BANKCODE
NOT FOUND IN REQUEST
MESSAGE Message for error or event A
N
4
0
00

ENDERR Marker (no key) – –

CHECKSP Marker (no key) – –

ERFORM
ED

Multiple instances possible

CHECK Marker (no key) –

For a complete list per

country, see the WebCollect
error codes guide

CHECKC Code of the validation check N4

ODE

Result of the check performed

l PASSED

CHECKRE l ERROR A PASSED

SULT N
l WARNING 10

l NOTCHECKED

ENDCHE Marker (no key) – –

CKSPERF
ORMED

BANKDATA Marker (no key) – –

REFBANK Reformatted bank code according to local clearing rules A 150000

CODE N
15

Key Definition Type Example

REFBRANCHCODE Reformatted branch code according to local clearing rules AN15 1234

REFACCOUNTNUMBER Reformatted account number according to local clearing rules AN30 12345679

NEWBANKNAME Bank name returned matching the bank code of the request AN40 BARCLAYS BANK PLC

ENDBANKDATA Marker (no key) – –

Example

<XML>

<ACTION>DO_BANKVALIDATION</ACTION>

Ingenico document - Reproduction or disclosure prohibited without written authorization

62
<META>

</META>

<BANKNAME>Barclays</BANKNAME>

<BIC>ABNANL2A</BIC>

</GENERAL>

</PARAMS>

</REQUEST>

</XML>

Possible OK response
<XML>

<ACTION>DO_BANKVALIDATION</ACTION>

<META>

</META>

<BANKNAME>Barclays</BANKNAME>

</GENERAL>

</PARAMS>

Ingenico document - Reproduction or disclosure prohibited without written authorization

63
<VALIDATIONID>82643124578</VALIDATIONID

<META>

</META>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

</CHECK>

<CHECK>

<CHECKRESULT>NOTCHECKED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>NOTCHECKED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>ERROR</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>WARNING</CHECKRESULT>

</CHECK>

</CHECKSPERFORMED>

<NEWBANKNAME>ABN AMRO BANK</BWBANKNAME>

</BANKDATA>

Ingenico document - Reproduction or disclosure prohibited without written authorization

64
</RESPONSE>

</REQUEST>

</XML>

Possible NOK response

<XML>

<ACTION>DO_BANK_VALIDATION</ACTION>

<META>

</META>

<BANKNAME>Barclays</BANKNAME>

</GENERAL>

</PARAMS>

<META>

</META>

<ERROR>

<MESSAGE> Syntax Error : “INVALID COUNTRY CODE BANK”</MESSAGE>

</ERROR>

<ERROR>

<MESSAGE> System Error : “UNABLE TO OPEN BRANCH DATABASE”</MESSAGE>

</ERROR>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

65
DO_BINLOOKUP
This API call determines the country code of a given credit card based on at least the first 13 digits of the credit card number. An indicative payment
product ID is returned as well as the country code.

The do BIN lookup structure is REQUEST

ACTION

META PARAMS

GENERAL

Input keys

Key Definition Type Req Example

ACTION DO_BINLOOKUP AN R DO_

BINLOOKUP

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – – –

GENERAL Marker (no key) – – –

BIN The first digits of the credit card number from left to right with a minimum of 6 digits, or the full credit card N19 R –
number

ENDGENERAL Marker (no key) – – –

ENDPARAMS Marker (no key) – – –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

COUNTRYCODE ISO 3166 country code AN2 FR

PAYMENTPRODUCTID Payment product identifier N5 130

ENDROW Marker (no key) – –

Example

<XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

66
<REQUEST>

<ACTION>DO_BINLOOKUP</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>DO_BINLOOKUP</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

<META>

</META>

<ROW>

</ROW>

</RESPONSE>

Ingenico document - Reproduction or disclosure prohibited without written authorization

67
</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

68
DO_CHECKENROLLMENT
This API call attempts an enrollment check of a credit card in a 3D Secure scheme. 3D Secure schemes are

l Verified by VISA

l MasterCard SecureCode

If the credit card is enrolled, the necessary details for redirection of the consumer to the authentication page of the credit card issuer are provided in
the return keys.

The do check enrollment structure is REQUEST

ACTION META

PARAMS PAYMENT

Input keys

Key Definition Type Req Example

ACTION DO_CHECKENROLLMENT AN R DO_ CHECKENROLLMENT

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – – –

PAYMENT Marker (no key) – – –

ORDERID Unique order ID generated by Ingenico ePayments N10 R 9998890004

MERCHANTORDERID Order ID generated by the merchant N10 O 1234567899

EFFORTID Payment effort number (default 1) N5 O 00001

SURNAME Last name of CardholderCardholder AN35 R Buuren

Expiry date

EXPIRYDATE Format: MMYY N4 R 1206

CREDITCARDNUMBER Credit card number N19 R 4567350000427977

CURRENCYCODE ISO 4217 currency code AN3 R USD

AMOUNT Amount to be paid N12 R 29990

AMOUNTSIGN Amount sign AN1 O +

Payment product identifier—Depends on payment method

l 1=Visa

PAYMENTPRODUCTID l 3=MasterCard N5 O 3

l And so on

ISO 639 language code of consumer

LANGUAGECODE If not provided, take the default from the merchant AN2 O en

ISO 3166 country code of consumer

COUNTRYCODE If not provided, take the default from the merchant AN2 O US

ISSUENUMBER Issue number, if applicable N2 O 01

Start date, if applicable

STARTDATE Format: MMYY N4 O

CVV CVV key N4 O 123

Ingenico document - Reproduction or disclosure prohibited without written authorization

69
CVVINDICATOR l 0=Bypass CVV check N1 O 1

l 1=CVV present (default)

ENDPAYMENT Marker (no key) – – –

ENDPARAMS Marker (no key) – – –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETI Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

ORDERID Unique order ID generated by Ingenico N10 9998890004

ePayments

STATUSID Status N5 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

PAYMENTREFEREN Ingenico ePayments reference for payment AN20 Returned after authorization
CE

External reference for credit card payment

This value should be used as

REFERENCEORIGPAYMENT in
ADDITIONALREFER AN20 –
ENCE eventual refunds (See DO_REFUND)

External reference for credit card payment

This value should be used as

REFERENCEORIGPAYMENT in
EXTERNALREFERE AN30 000000000100002121210000100001
NCE eventual refunds (See DO_REFUND)

ACSURL URL for redirection of consumer AN Returned after CheckEnrollment with enrolled consumer

Pareq for redirection Returned after CheckEnrollment with enrolled consumer

PAREQ This is used as a hidden key AN

Transaction ID for redirection This is used as a Returned after CheckEnrollment with enrolled consumer and after a valid
hidden key AuthenticationValidation
XID AN50

Merchant data key for redirection Returned after CheckEnrollment with enrolled consumer

MD This is used as a hidden key AN50

PROOFXML Proof XML message AN40 Returned after CheckEnrollment with enrolled consumer
00

ENDROW Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

70
DO_FINISHPAYMENT
This API call attempts an online credit card authorization and, in cases where no valid authentication result was obtained, a fraud check.

The do finish payment structure is

REQUEST ACTION META PARAMS

PAYMENT

Input keys

Key Definition Type Req Example

ACTION DO_FINISHPAYMENT AN R DO_FINISHPAYMENT

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – – –

PAYMENT Marker (no key) – – –

ORDERID Order identification N10 R 9998890004

EFFORTID Payment effort number from first DO_PAYMENT N5 O 00001 (Default=1)

ATTEMPTID Payment attempt number from first DO_PAYMENT N5 R 00001

ENDPAYMENT Marker (no key) – – –

ENDPARAMS Marker (no key) – – –

Return keys

Key Definition Ty Example

RESULT OK or NOK AN OK
10

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETI Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

CURRENCYCODE ISO 4217 currency code AN3 EUR

AMOUNT Amount N12 –

STATUSID Status N5 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

PAYMENTREFERE Ingenico ePayments reference for payment AN Returned after authorization

NCE 20

External reference for credit card payment— Should be used as REFERENCEORIGPAYMENT in

eventual refunds (See DO_REFUND)
ADDITIONALREFE AN –
RENCE 20

Ingenico document - Reproduction or disclosure prohibited without written authorization

71
EXTERNALREFER External reference for credit card payment— AN 0000000001000021212100
ENCE 30 00100001

Key Definition Type Example

Should be used as REFERENCEORIGPAYMENT in eventual refunds (See

DO_REFUND)

Result of the AVS service

AVSRESULT The results that return depend on the checks performed AN1 Z

Result of the CVV2/CVC2 service

CVVRESULT The results that return depend on the checks performed AN1 M

Result of the fraud service

FRAUDRESULT The results that return depend on the checks performed AN1 D

Result of the fraud service

FRAUDCODE The results that return depend on the checks performed AN4 0000

321234

AUTHORISATIONCODE Authorization code AN10 Returned optionally after

authorization

ENDROW Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

72
DO_FINISHPAYMENT only for PAYPAL
Specific for PayPal (Product ID 840) this call is used in the final step of the Express Checkout Shortcut (ECS) flow to finalize payment with the
possibility of changing and/or extending the information provided in the first step using IOWP call

The do finish payment structure is REQUEST

ACTION META PARAMS

ORDER

ORDERLINES (Optional) ORDERLINES (Optional, 0-N)

PAYMENT

Input Keys

Key Definition Type Req Example

ACTION DO_FINISHPAYMENT AN R DO_ FINISHPAYMENT

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

Key Definition Type Req Example

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – – –

ORDER Marker (no key) – R –

AMOUNT Amount of the order in cent N12 O 29990 (=299.90)

SHIPPING AMOUNT Amount of the shipping costs in cents N12 O 2990 (=29.90)

TAXAMOUNT Tax Amount of the order in cents N12 O 1500 (=15.00)

HANDLING AMOUNT Handling Amount of the order in cents N12 O 1500 (=15.00)

SHIPPINGTITLE Title of the recipient AN35 O Mr.

SHIPPINGFIRSTNAME First name of the recipient AN15 O Jack

SHIPPINGPREFIXNAME Prefix surname of the recipient AN15 O Mc

SHIPPINGSURNAME Surname of the recipient AN35 O Owens

SHIPPINGSTREET Street name of shipping address AN50 O 5th Avenue

SHIPPINGHOUSENUMBER House number AN15 O 5020

SHIPPINGADDITIONALADDRESSINFO Additional address information AN50 O 3A

SHIPPINGZIP Zip code of shipping address AN10 O 1000 AA

SHIPPINGCITY City of shipping address AN40 O NewYork

SHIPPINGSTATE State of shipping address AN35 O New York

SHIPPINGCOUNTRYCODE ISO 3166 country code of shipping address AN2 O US

ENDORDER Marker (no key) - O -

ORDERLINES Marker (no key) - O -

....orderlines.... O

ENDORDERLINES Marker (no key) - O -

PAYMENT Marker (no key) – – –

ORDERID Order identification N10 R 9998890004

EFFORTID Payment effort number from first DO_PAYMENT N5 O 00001 (Default=1)

Ingenico document - Reproduction or disclosure prohibited without written authorization

73
ATTEMPTID Payment attempt number from first DO_PAYMENT N5 R 00001

ENDPAYMENT Marker (no key) – – –

ENDPARAMS Marker (no key) – – –

Additional for each order line

Key Definition Type Req Example

ORDERLINE Marker (no key) N5 R –

Key Definition Type Req Example

LINENUMBER Sequence of order line number N10 R 1

ITEMID Product Code/ID of the item AN12 O AI4527001

Description (116 positions) Number of items (4positions)

INVOICELINEDATA Unit Price (12 positions) AN132 O Small Umbrella 1 9995

LINEAMOUNT Amount of order line in cents N12 R 9995

LINEATAXMOUNT Tax Amount of order line in cents N12 O 525

MERCHANTPAGENUMBER Page number for invoice N3 O 1

MERCHANTLINENUMBER Line number for invoice N5 O 1

ISO 4217 currency code—If blank, the currency code of the order is the default value

CURRENCYCODE AN3 O USD

ENDORDERLINE Marker (no key) N5 R –

1. The Optional fields in this API call are required only if their value changed from INSERT_ORDERWITHPAYMENT call
a. PAYMENT.AMOUNT is the total amount including shipping, insurance, handling and tax amounts
b. ORDER.TAXAMOUNT is the total tax costs. It is the sum of all line items tax amounts
c. ORDERLINE.LINEAMOUNT is equal to INVOICELINEDATA.NumberOfItems x INVOICELINEDATA.UnitPrice
d. Minimum mandatory tags when sending a Shipping Address to PayPal:

1. SHIPPINGFIRSTNAME

1. SHIPPINGSURNAME

1. SHIPPINGSTREET

1. SHIPPINGHOUSENUMBER

1. SHIPPINGZIP

1. SHIPPINGCITY

1. SHIPPINGCOUNTRY

Ingenico document - Reproduction or disclosure prohibited without written authorization

74
1. SHIPPINGSTATE (It is required if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan,
Mexico, Thailand or USA. PayPal accepts State codes for some countries)

1. For PayPal ECS, Shipping Address is needed in DO_FINISHPAYMENT and not in INSERT_ ORDERWITHPAYMENT
2. SHIPPINGAMOUNT, INSURANCEAMOUNT, TAXAMOUNT and HANDLINGAMOUNT in ORDER section are now also available in
INSERT_ORDERWITHPAYMENT

Return Keys
The same return keys of INSERT_ORDERWITHPAYMENT API call.

Ingenico document - Reproduction or disclosure prohibited without written authorization

75
DO_PAYMENT
This API call inputs a payment attempt on an existing order.

l Normal payments—If a payment fails, a new attempt is made using the API: DO_PAYMENT

l Variable-amount recurring-order payments—The second and subsequent payments on a recurring order can use the information stored for the last
successful payment

In this case, no payment product ID or specific payment details have to be provided and the API: DO_PAYMENT accepts the last payment attempt
automatically

The do payment structure is

REQUEST

ACTION

META

PARAMS

AIRLINEDATA

FLIGHTLEGS

FLIGHTLEG

PAYMENT

AUTHENTICATE

Input keys

Key Definition Type Req Example

ACTION DO_PAYMENT AN R DO_PAYMENT

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

AIRLINEDATA Marker (no key) – O If airline data is

present

AIRLINECODE Airline numeric code N3 R 123

AIRLINENAME Name of airline AN20 R KLM

AIRLINEINVOICENU Airline tracing number N6 O 465321

MBER

Travel agent code

For transactions using Elavon, AGENTNUMBERICCODE is limited to N8 N6

N8
AGENTNUMBERICC This spelling (AGENTNUMBERICCODE) must be used O 123456 (or
ODE 12345678)

The ticket or document number contains

Airline code—3-digit airline code number

Form code—A maximum of 3 digits indicating the type of document, the source of issue and the
number of coupons it contains
Serial number—A maximum of 8 digits
TICKETNUMBER AN13 R 0741243235556

Key Definition Ty Req Example

allocated on a sequential basis, provided that the total number of digits allocated to the form code and
serial number shall not exceed ten

You can replace TICKETNUMBER with PNR if the ticket number is unavailable

Ingenico document - Reproduction or disclosure prohibited without written authorization

76
PNR Passenger name record AN6 O

ETICKETINDICATOR AN1 O E
E=eTicket

ET=eTicket
CTO=City ticket office
ATO=Airport ticket office
TICKETDELIVERYME TBM=Ticket by mail AN3 O ET
THOD TOD=Ticket on departure

POINTOFSALE IATA point of sale name AN O –

Place of issue

PLACEOFISSUE For sales in the US, the last two characters (position 14–15) must be the US state code AN O –
15

PASSENGERNAME Name of passenger AN R Johan Cruijff

FLIGHTDATE Date of the Flight CCYYMMDD N8 O 20141231

ISTHIRDPARTY Is the payer the ticket holder (T/F) AN5 O T

ISREGISTEREDCUST Identifies a known consumer (T/F) AN5 O T

OMER

POSCITYCODE This is the city code of the point of sale AN O AMS

Consumer reference used for search Ingenico ePayments interface

For UnionPay International, CUSTOMERID cannot contain spaces

CUSTOMERID AN O 14
16

This is the date of issue recorded in the airline system

In a case of multiple issuances of the same ticket to a cardholder, the merchant should use the last ticket
date

Format: YYYYMMDD ISSUEDATE is required for Elavon

ISSUEDATE and RESTRICTEDTICKET

are required for PayPal

ISSUEDATE N8 O 20090402

Airline data restricted ticket (non- refundable)

0=No restrictions, the ticket is (partially) refundable

1=Restricted, the ticket is non-refundable

ISSUEDATE and RESTRICTEDTICKET

are required for PayPal

RESTRICTEDTICKET N1 O 0

FLIGHTLEGS Marker (no key) O If flight legs are

present

Key Definition Ty R Example

pe eq

…flight – – –
legs…

ENDFLIGHT Marker (no key) – O –

LEGS

ENDAIRLINE Marker (no key) – O –

DATA

PAYMENT Marker (no key) – R –

PROFILETO If given, this token is used to find other payment data A O af16af70-2bf5-44e9-
KEN N a087- 68c87f67e3a1
40

Ingenico document - Reproduction or disclosure prohibited without written authorization

77
Unique reference of merchant for payment

MERCHANT MERCHANTREFERENCE allowed input is ASCII 32–126 characters—Do not include trailing spaces in the A R
REFERENCE MERCHANTREFERENCE N
30

EFFORTID Payment effort number N5 O 00001 (Default=1)

Payment product identifier—Depends on payment method

1=Visa N5 R 3
3=MasterCard
PAYMENTP And so on
RODUCTID
PAYMENTPRODUCTID is required if you are using API: INSERT_ORDER followed by API: DO_PAYMENT—
If you want to submit a payment for a recurring order (OrderType=4), PAYMENTPRODUCTID

is optional (not required)

AMOUNT Amount to be paid N R 29990

SHIPPINGA Amount of the shipping costs in cents N O 29990 (=299.90)

MOUNT 12

TAXAMOUNT Tax amount of the order in cents N O 29990 (=299.90)

HANDLINGA Handling amount of the order in cents N O 29990 (=299.90)

MOUNT 12

AMOUNTSIGN Amount sign A O +

CURRENCY ISO 4217 currency code A R EUR

CODE N3

0=Do not use HostedMerchantLink

HOSTEDIND 1=Use HostedMerchantLink (default if configured) N1 O 1
ICATOR
HOSTEDINDICATOR is optional for transactions via HostedMerchantLink—For more information, contact your
Ingenico ePayments account manager

URL to be used for returning the consumer to the site of the merchant after the transaction in the case of a HTTPS://www.
redirected payment or HostedMerchantLink merchantur l.com
RETURNURL A O /landingpage.jsp?
N
512 a=b&c=d

Key Definition Type Req Example

Payment method specific parameters, see the table for each payment method

ENDPAYMENT Marker (no key) – R –

FRAUDFIELDS Marker (no key) – O –

EBT_USER_DATA1 AN256 O

EBT_USER_DATA2 AN256 O

EBT_USER_DATA3 AN256 O

EBT_USER_DATA4 AN256 O

EBT_USER_DATA5 AN256 O

EBT_USER_DATA6 AN256 O

EBT_USER_DATA7 AN256 O

EBT_USER_DATA8 AN256 O

EBT_USER_DATA9 AN256 O

EBT_USER_DATA10 AN256 O

Ingenico document - Reproduction or disclosure prohibited without written authorization

78
EBT_USER_DATA11 AN256 O

EBT_USER_DATA12 AN256 O

EBT_USER_DATA13 AN256 O

EBT_USER_DATA14 AN256 O

EBT_USER_DATA15 AN256 O

EBT_USER_DATA16 AN256 O

Specifies if the consumer enters a password to gain access to an account registered with the merchant

EBT_PASSWORD These values only AN1 O Y

Y=Yes
N=No

Specifies if the consumer has a history of online shopping with the merchant

EBT_PREVCUST These values only AN1 O Y

Y=Yes
N=No

Gift card type These values only

1=Celebrate Fall AN1

2=Grandparent's Day l 4=Independence Day l A=Anniversary
EBGIFTCARDTYPE B=Birthday O W
C=Congratulations l D=April Fool's Day l E=Easter
F=Father's Day
G=Graduation

Key Definition Type Req Example

H=Holiday
I=Season's Greetings
J=Passover
K=Kwanzaa
L=Halloween
M=Mother's Day
N=New Year's Day
O=Bosses' Day
P=St. Patrick's Day
Q=Sweetest Day
R=Christmas
S=Baby Shower
T=Thanksgiving
U=Other
V=Valentine's Day
W=Wedding
X=Secretary's Day
Y=Chinese New Year
Z=Hanukkah

EBGIFTMESSAGE AN160 O

EBSHIPCOMMENTS AN160 O

EBWEBSITE The website from which the purchase is made AN60 O https://www.yourwebsite.com

ENDFRAUDFIELDS Marker (no key) – O –

ENDPARAMS Marker (no key) – R –

Additional for each flight leg

Key Definition Type Req Example

FLIGHTLEG Marker (no key) – O –

LEGNUMBER Sequence of flight leg number N5 R 1

LEGDATE Date of the leg CCYYMMDD D8 R 20141231

Ingenico document - Reproduction or disclosure prohibited without written authorization

79
ORIGINAIRPORT Origin airport/city code AN3 R AMS

ARRIVALAIRPORT Arrival airport/city code AN3 R LAX

l O or blank=Stopover permitted

l X=Stopover not permitted

STOPOVERCODE STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are AN1 O X

required for PayPal

AIRLINECLASS Reservation Booking Designator AN2 R 1

CARRIERCODE IATA carrier code AN2 R KL

FAREBASIS Fare Basis/Ticket Designator AN15 O INTERNET

The flight number assigned by the airline carrier with no leading spaces

FLIGHTNUMBER STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are AN5 O 791

required for PayPal

The departure time in local time at the departure airport Format: HH:MM

DEPARTURETIME STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are required for PayPal AN6 O 17:59

ENDFLIGHTLEG Marker (no key) - O -

Additional for credit card online payments

Key Definition Type R Exam

eq ple

Expiry date Format: MMYY

EXPIRYDATE and CREDITCARDNUMBER are

optional for transactions via HostedMerchantLink in case you choose to have them submitted by the consumer on the Ingenico
ePayments hosted pages, for example, if a merchant is not PCI compliant

EXPIRYDATE N4 R 1206

Credit Card number

EXPIRYDATE and CREDITCARDNUMBER are

optional for transactions via HostedMerchantLink in case you choose to have them submitted by the consumer on the Ingenico
ePayments hosted pages, for example, if a merchant is not PCI compliant
CREDITCAR N19 R 4567
DNUMBER 3500
0042
7977

ISSUENUMB Issue number N2 O 01

CVV key 123

The card verification value (CVV) is 3 or 4 digits on the back, or front [Amex], of a credit card. It is required for the CVV check Max
4
CVV N4 O pos
Amex,

Max
3
pos
MC,
Visa

CVVINDICAT 0=Bypass CVV check N1 O 1

OR
1=CVV present (default)

AVSINDICAT 0=Bypass AVS check N1 O 1

OR
1=Present

1=Final authorisation
AUTHTYPE 2=Pre-authorisation N1 O 1
3=Purchase

All 3 types apply both to Visa and Mastercard depending on the capabilities of the acquirer.

Purchase also appies to Union Pay and MIR (Russia)

Ingenico document - Reproduction or disclosure prohibited without written authorization

80
UCOFINDICA Possible values AN O FIRST
TOR
FIRST
SUBSEQUENT

Indicates to the scheme that is either the transaction with which the consumer is agreeing with the merchant to store the card
(FIRST) or is a future transaction where the card is already stored (SUBSEQUENT)

UCOF (Unscheduled Card On File) is only possible with Order Type 1

UCOFREQU Possible Values AN3 O CIT

ESTOR
CIT (Customer Initiated Transaction)
MIT (Merchant Initiated Transaction

By Default all First UCOFs are CIT, because the consumer is agreeing to store the card. Subsequent can be CIT (like single clik
to buy) or MIT (like top ups). If the merchant is sending this parameter in the first UCOF, it will be validated to contain only CIT

UCOF (Unscheduled Card On File) is only possible with Order Type 1

INITIALSCHE The transaction ID given by Visa or Mastercard after the First Recurring/First UCOF/Pre Authorization to send in the AN15 O MC12
METRANSAC authorization request of: 3874
TIONID 3876
A subsequent Recurring transaction 289

A subsequent UCOF MIT

A no show or delay charge

All these are MIT transactions that needs the linking to the initial Transaction where the consumer was present. If this value was
not provided in the first transaction, the merchant can send the transaciton ID of any subsequent. Please check the response of
this API call and GET_ORDERSTATUS

MITREASON Specific for hospitality, Visa requests the flagging of industry specific Merchant Initiated Transactions. The options are: FIX O NO_
VAL SHOW
NO_SHOW UES

DELAY_CHARGE

INCREMENTAL_AUTHORIZATION (for future use)

RESUBMISSION (for future use)

REAUTHORIZATION (for future use)

For this transaction the INITALTRANSACTIONID is needed in order to do the linking with the original Pre Authorization (where
the consumer was present)

Key Definition T R Example

y eq
pe

AUTHENTICATION
VALIDATION
l 0=Failed authentication (no liability shift)

l 1=Incomplete authentication (MasterCard) l 2=Successful authentication (MasterCard)

l 5=Successful authentication (Visa, Diners

Club)

l 6=Authentication attempted (Visa)

l 7=Failed authentication (no liability shift)

l (empty)=Not checked or not enrolled, but attempt made (MasterCard)

If Elavon is the acquirer, these ECI values apply

l 6=Authentication attempted (Visa, MasterCard, Maestro)

l 2=Successful authentication (MasterCard,

Maestro)

l 5=Successful authentication (Visa, Diners Club)

l 7=Internet (not a 3D Secure transaction)

Ingenico document - Reproduction or disclosure prohibited without written authorization

81
Indicates if the authorization should be executed— Can be used to overrule merchant-level
configuration
N1 O 1
0=Authorization only
AUTHENTICATION 1=Continue if possible
INDICATOR 2=Authentication only

AUTHENTICATIONINDICATOR is required for the 3D Secure check—For more information,

contact your Ingenico ePayments account manager

ECI Electronic Commerce Indicator provides authentication validation results returned after the N1 R 1
authentication

DIRECTORYSERV Universally unique transaction identifier assigned by the Directory Server (schemes) to A New 3DS V2
ERTRANSACTIONID identify a single transaction N
36

THREEDSPROTOC the most recent active protocol version that was used to perform the authentication AN R New 3DS V2 value is "2.1.0" to start
OLVERSION with

The CAVV (cardholder authentication verification value) or AAV (accountholder This is the Base64 encoded string
authentication value) provides an authentication validation value or equivalent for other provided in the authentication
schemes response

CAVV This is mandatory for ECI 1,2 and 5,6 A O

N
40

This is the Base64 encoded string

provided in the authentication
response

For MasterCard and Maestro, the

XID can be used,

It is not used in 3DS V2

XID The transaction ID that is used in the authentication A O
N
50

THREEDSSERVER The transaction ID generated by the 3D Server (replaces the XID used in 3DS V1) A R New 3DS V2
TRANSACTIONID N
50

The algorithm, from your 3D Secure provider, used to generate the authentication CAVV

Required when

l The 3D Secure authentication for the transaction is managed by a non-Ingenico

ePayments 3D Secure authentication provider

l You process the transaction through Atos

CAVVALGORITHM A O 1 (required only for 3DS V1)
N1

The 3D Secure authentication result from your 3D Secure provider

Required when

l The 3D Secure authentication for the transaction is managed by a non-Ingenico

ePayments 3D Secure authentication provider

l You process the transaction through Atos

VALIDATIONRESU A O Y (required only for 3DS V1)
LT N1

Sales Transaction Type, Commerce Type, or ECI of the transaction

l 1=Internet (Default)

l 2=Call center

STTINDICATOR l 3=Recurring N1 O 1

l 4=MOTO

l 5=Cardholder present

First name of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more
information about fraud screening, see Fraud screening service
FIRSTNAME A O Jack
N
15

In between first name and surname

PREFIXSURNAME The name and address of the cardholder can be A O van

N
15

Ingenico document - Reproduction or disclosure prohibited without written authorization

82
Key Definition Ty R Example
pe eq

relevant for fraud screening—For more information about fraud screening, see Fraud screening service

Last name of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service
SURNAME AN O Buuren
35

Street address of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service

STREET, HOUSENUMBER, and ZIP are required for the Address Verification Service (AVS) check

STREET AN O Polarisav
50 enue

House number of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service

STREET, HOUSENUMBER, and ZIP are required for the Address Verification Service (AVS) check

HOUSENUMBER AN O 1
15

Additional address information

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service
ADDITIONALADDRE AN O A
SSINFO 50

Zip code address of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service

STREET, HOUSENUMBER, and ZIP are required for the Address Verification Service (AVS) check

ZIP AN O 1000 AA
10

City of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service
CITY AN O New York
40

State of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service
STATE AN O New York
35

Key Definition Ty R Example

pe eq

Ingenico document - Reproduction or disclosure prohibited without written authorization

83
Dynamic currency conversion indicator

l 1=Dynamic currency conversion offered and accepted

l 0=Dynamic currency conversion does not apply

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic currency
conversion does not apply

DCCINDICATOR N1 R 1

Amount the consumer has to pay after applying dynamic currency conversion

l Mandatory=Dynamic currency conversion applies

l Ignored= Dynamic currency conversion does

not apply

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic currency
conversion does not apply

ISSUERAMOUNT N12 R –

ISO 4217 currency code of the consumer

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic currency
conversion does not apply

ISSUERCURRENCY AN3 R EUR

CODE

For receipt printing purposes only

To meet regulatory requirements, where applicable Four decimal places

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if

MARGINRATEPERC N6 R 025000
ENTAGE =2.5

Key Definition Ty R Example

pe eq

dynamic currency conversion does not apply

For receipt printing purposes only—To meet regulatory requirements, where applicable

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic

currency conversion does not apply

Reuters
Wholesale
EXCHANGERATESO AN R Interbank
URCENAME 32

Exchange rate used for transaction Last four digits are decimal places

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic

currency conversion does not apply

EXCHANGERATE N12 R 12341200=1234.

Ingenico document - Reproduction or disclosure prohibited without written authorization

84
Time stamp until the exchange rate is valid

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic

currency conversion does not apply

EXCHANGERATEVAL N14 R 20070830180000

IDTO

We recommend that you exclude the HOUSENUMBER key if a house number is already included with the street information. WebCollect checks for a
house number and a street, and the AVSDATA1 populates with the house number and street. If the house number is present in both places, the
AVSDATA1 populates with two house numbers followed by the street. This could cause a failure of the AVS check.

The AVSDATA1 populates with a maximum of 20 character positions. If the house number and street data cover more than 20 character positions
(including spaces), the WebCollect system captures the first 20 character positions only. The AVSDATA2 populates with the zip details.

Example with house number in HOUSENUMBER key

HOUSENUMBER: 12

STREET: Bundles Clay Lane South Nutfield AVSDATA1:12 Bundles Clay Lane

Example with house number in STREET key HOUSENUMBER: Empty

STREET: 12 Bundles Clay Lane South Nutfield AVSDATA1:12 Bundles Clay Lane

Example with house number in both HOUSENUMBER and STREET keys

HOUSENUMBER: 12

STREET: 12 Bundles Clay Lane South Nutfield AVSDATA1:12 12 Bundles Clay L

Additional for invoice payments

Key Definition Type Req Example

COMPANYDATA Company data AN50 O Ltd.

COMPANYNAME Name of company AN40 O Cruijff Sports

COUNTRYCODE ISO 3166 country code AN2 R ES

CUSTOMERID ID of consumer AN15 O 1

ADDITIONALREFERENCE Additional reference to be printed on invoice AN20 O 3243243243

INVOICEDATE Date on which invoice is to be made N8 O 20030831

Invoice number

INVOICENUMBER INVOICENUMBER is required to facilitate matching for bank payments and bank transfer payments AN20 O 21212121

INVOICECLASS Future use AN10 O

l N=Invoice (default)

l NR=Reminder on invoice

INVOICETYPE l R=Renewal AN2 O R

l RR=Reminder on renewal

l M=Mailing

Title consumer

TITLE A valid name and address are required to ensure correct delivery of the invoice AN35 O Mr.

SEX Sex consumer (M or F or U) AN1 O M or F or U

Ingenico document - Reproduction or disclosure prohibited without written authorization

85
First name

FIRSTNAME A valid name and address are required to ensure correct delivery of the invoice AN15 O Jack

In between first name and surname

PREFIXSURNAME A valid name and address are required to ensure correct delivery of the invoice AN15 O van

Last name of consumer

SURNAME A valid name and address are required to ensure correct delivery of the invoice AN35 R Buuren

Street address of consumer

STREET A valid name and address are required to ensure correct AN50 R Polarisavenue

Key Definition Type Req Example

delivery of the invoice

House number address of consumer

HOUSENUMBER A valid name and address are required to ensure correct delivery of the invoice AN15 O 1

Additional address information

ADDITIONALADDRESSINFO A valid name and address are required to ensure correct delivery of the invoice AN50 O A

Zip code address of consumer

ZIP A valid name and address are required to ensure correct delivery of the invoice AN10 O 1000 AA

City of consumer

CITY A valid name and address are required to ensure correct delivery of the invoice AN40 R New York

State address of consumer

STATE A valid name and address are required to ensure correct delivery of the invoice AN35 O New York

LANGUAGECODE ISO 639 language code of consumer AN3 O en

Additional for bank transfer and online bank transfer payments including bank transfer Brazil (51)

l COMPANYNAME, CUSTOMERBANKCITY, FISCALNUMBER (CNPJ), FIRSTNAME, and PREFIXSURNAME

are required for business consumer transactions using Deposito Identificado

l FISCALNUMBER (CPF) is required for non-business consumer transactions using Deposito Identificado

l FIRSTNAME, STREET, STATECODE, and EMAIL are required for all transactions using Deposito Identificado

l HOUSENUMBER is required if the house number is not included in the STREET field for all transactions using Deposito Identificado

Key Definition Type Req Example

COMPANYDATA Company data AN50 O Ltd.

Name of company

COMPANYNAME is required, if available, to facilitate matching for bank payments and bank transfer
payments.
COMPANYNAME AN40 O Cruijff
Sports

COUNTRYCODE ISO 3166 country code AN2 R ES

CUSTOMERID ID of consumer AN15 O 1

Ingenico document - Reproduction or disclosure prohibited without written authorization

86
Invoice number

INVOICENUMBER is required to facilitate matching for bank payments and bank transfer payments.

INVOICENUMBER, FIRSTNAME, and

SURNAME are required for bank transfers to South Africa.

INVOICENUMBER AN20 O 21212121

CUSTOMERBANKNAME Name of consumer bank AN50 O

Key Definition Type Req Example

CUSTOMERACCOUNTHOLDERNAME Name of consumer account holder AN50 O

CUSTOMERBANKACCOUNT Last 4 digits of the consumer bank account AN50 O

CUSTOMERBANKCITY City of consumer bank AN50 O

FISCALNUMBER Fiscal registration number of the consumer (CPF) AN11 O 28001238938

FISCALNUMBER Tax registration number of the company for a business consumer (CNPJ) AN14 O 12345678901234

TITLE Title of consumer AN35 O Mr.

First name

INVOICENUMBER, FIRSTNAME, and

FIRSTNAME SURNAME are required for bank transfers to South Africa. AN15 O Jack

PREFIXSURNAME Between first name and surname AN15 O van

Last name of consumer

INVOICENUMBER, FIRSTNAME, and

SURNAME SURNAME are required for bank transfers to South Africa. AN35 R Buuren

STREET Street address of consumer AN50 O Polarisavenue

HOUSENUMBER House number address of consumer AN15 O 1

ADDITIONALADDRESSINFO Additional address information AN50 O A

ZIP Zip code address of consumer AN10 O 1000 AA

CITY City of consumer AN40 R New York

STATE State address of consumer AN35 O New York

STATECODE State code of the consumer AN9 O NY

COUNTRYCODE Country code of the consumer AN2 R

EMAIL Email address of the consumer AN70 O

LANGUAGECODE ISO 639 language code of consumer AN3 R En

Additional for real-time bank transfer payments

l IBAN, BIC are optional for transactions using Sofortüberweisung in Germany

l This feature of payment product Sofortüberweisung (836) is only supported in Germany (DE)

Key Definition Type Req Example

COMPANYDATA Company data AN50 O Ltd.

COMPANYNAME Name of company AN40 O Cruijff Sports

COUNTRYCODE ISO 3166 country code AN2 R ES

ID of consumer

CUSTOMERID For UnionPay International, CUSTOMERID cannot contain spaces AN15 O 1

Ingenico document - Reproduction or disclosure prohibited without written authorization

87
INVOICENUMBER Invoice number AN20 O 21212121

TITLE Title of consumer AN35 O Mr.

Key Definition Type Req Example

FIRSTNAME First name AN O Jack

PREFIXSURNAME In between first name and surname AN O van

SURNAME Last name of consumer AN O Buuren

STREET Street address of consumer AN O Polarisavenue

HOUSENUMBER House number address of consumer AN O 1

ADDITIONALADDRESS Additional address information AN O A

INFO 50

ZIP Zip code address of consumer AN O 1000 AA

CITY City of consumer AN O New York

STATE State address of consumer AN O New York

LANGUAGECODE ISO 639 language code of consumer AN3 R En

IBAN International bank account number of the consumer AN O DE4694059421000001

50 2345

BIC Bank identification code for the consumer AN O TESTDETT421

ID of the issuing bank of the consumer

ISSUERID is required for iDEAL (809) in the Netherlands (NL) when you are not using
HostedMerchantLink
ISSUERID AN O ABNANL2A
11

Expiration period in minutes (maximum 60 minutes both for iDEAL and eCard)

The consumer has to perform the payment before the end of this period

Default=60

EXPIRATIONPERIOD is optional for iDEAL (809) and eCard (402) and for all transactions that use
HostedMerchantLink
EXPIRATIONPERIOD N4 O 15

Additional for direct debit payments

Key Definition Type Req Example

COMPANYDATA Company data AN50 O Ltd.

COMPANYNAME Name of company AN40 O Cruijff Sports

COUNTRYCODE ISO 3166 Country code AN2 R ES

CUSTOMERID ID of consumer AN15 O 1

TITLE Title of consumer AN35 O Mr.

FIRSTNAME First name AN15 O Jack

PREFIXSURNAME In between first name and surname AN15 O Van

SURNAME Last name of consumer AN35 R Buuren

STREET Street address of consumer AN50 R Polarisavenue

HOUSENUMBER House number address of consumer AN15 O 1

Ingenico document - Reproduction or disclosure prohibited without written authorization

88
ADDITIONALADDRESSINFO Additional address information AN50 O A

ZIP Zip code address of consumer AN10 R 1000 AA

CITY City of consumer AN40 R New York

STATE State address consumer AN35 O New York

BANKCODE Depends on payment product –

Key Definition Type Req Example

For more information, see Country-specific direct debit keys

Depends on payment product

BANKNAME For more information, see Country-specific direct debit keys –

Depends on payment product

BRANCHCODE For more information, see Country-specific direct debit keys –

Depends on payment product

BANKCHECKDIGIT For more information, see Country-specific direct debit keys –

Depends on payment product

ACCOUNTNUMBER For more information, see Country-specific direct debit keys –

Depends on payment product

ACCOUNTNAME For more information, see Country-specific direct debit keys –

Depends on payment product Format:

YYYYMMDD
DATECOLLECT For more information, see Country-specific direct debit keys

Depends on payment product

DIRECTDEBITTEXT For more information, see Country-specific direct debit keys –

Depends on payment product

AUTHORISATIONID For more information, see Country-specific direct debit keys –

Depends on payment product

CUSTOMERBANKSTREET For more information, see Country-specific direct debit keys –

Depends on payment product

CUSTOMERBANKNUMB For more information, see Country-specific direct debit keys –

Depends on payment product

CUSTOMERBANKZIP For more information, see Country-specific direct debit keys –

Depends on payment product

CUSTOMERBANKCITY For more information, see Country-specific direct debit keys –

Depends on payment product

BANKFILIALE For more information, see Country-specific direct debit keys –

Depends on payment product

BANKAGENZIA For more information, see Country-specific direct debit keys –

Depends on payment product

DOMICILIO For more information, see Country-specific direct debit keys –

Depends on payment product

PROVINCIA For more information, see Country-specific direct debit keys –

Ingenico document - Reproduction or disclosure prohibited without written authorization

89
Depends on payment product

TRANSACTIONTYPE is required for SEPA direct debit transactions (payment product 770)—
Values can be

l S=One-off
TRANSACTIONTYPE AN2 O –
l F=First recurring

l R=Second and subsequent recurring

Key Definition Type Req Example

l L=Last recurring

For more information, see Country-specific direct debit keys

Depends on payment product

IBAN For more information, see Country-specific direct debit keys –

Depends on payment product

ADDRESSLINE For more information, see Country-specific direct debit keys –

Additional for cash payments

New validation rules for Registered Boleto Bancario:

l For all the below fields only uppercase letters (A-Z) and digits (0-9) are allowed . No Portuguese diacritics are allowed.

l Only one space between words is allowed.

l Only "-" (dash) and " ' " (apostrophe) allowed as special characters.

l When "-" or " ' " are used, no spaces are allowed between words. For example: D'EL-REI is correct, D'EL - REI is incorrect.

l For business consumer COMPANYNAME and FISCALNUMBER (CNPJ) are required.

l For non-business consumer FIRSTNAME, SURNAME and FISCALNUMBER (CPF) is required.

l STREET, HOUSENUMBER and ADDITIONALADDRESSINFO combined must be less than AN52.

Key Definition Type R Example

COMPANYNA Name of company AN40 R Carlos LTDA

FISCALNUMBER Fiscal registration number of AN11 R 21298750091

the consumer (CPF)

FISCALNUMBER Tax registration number of AN14 R 73400584000166

the company for a business
consumer (CNPJ)

FIRSTNAME First name AN15 R Carlos

PREFIXSURNA In between first name and This is not used for registered Boleto O
ME surname

SURNAME Last name of consumer AN35 R Albuquerque

STREET Street address consumer AN50 R R Jose Soares de Macedo

Note: STREET, HOUSENUMBER and

ADDITIONALADDRESSINFO combined must be less than AN52

HOUSENUMB House number address AN15 R 29

ER consumer
Note: STREET, HOUSENUMBER and
ADDITIONALADDRESSINFO combined must be less than AN52

ADDITIONALA Additional address AN50 O 2nd floor

DDRESSINFO information
Note: STREET, HOUSENUMBER and
ADDITIONALADDRESSINFO combined must be less than AN52

Ingenico document - Reproduction or disclosure prohibited without written authorization

90
ZIP Zip code address consumer AN8 R 08151010

Note: Can only contain digits (0-9) and should be valid against the
STATECODE. See the ZIP-STATECODE table below.

CITY City of consumer AN20 R Sao Paulo

STATE State address consumer This is not used for registered Boleto O

STATECODE State code of the consumer AN2 R SP

Please see the ZIP-STATECODE tabl

e below for the valid state codes.

EMAIL Email address of the This is not used for registered Boleto O
consumer

Additional information when credit card processing is done with 3D v2 via Ingenico

Key Definition T R Example

y eq
pe

The first batch of data resolves around authentication of the

consumer towards the merchant.

AUTHENTICATE Marker (no key) – O –

THREEDSAUTHENTICATIONC Indicates whether a challenge is requested for this N1 O 1 = No preference

HALLENGEINDICATOR transaction. 2 = No challenge requested
For example: 3 = Challenge requested: 3DS Requestor Preference
For 01-PA, a 3DS Requestor may have concerns about the 4 = Challenge requested: Mandate
transaction, and request a challenge.
For 02-NPA, a challenge may be necessary when adding a
new card to a wallet.
For local/regional mandates or other variables.

THREERIINDICATOR Indicates the type of 3RI request. ?

This data element provides additional information to the
ACS to determine the best approach for handing a 3RI
request.

ACCOUNTTYPE Indicates the type of account. For example, for a multi- N1 O 1 = Not Applicable
account card product. (Required in some accounts) 2 = Credit
3 = Debit

CUSTOMERBILLINGSHIPPING Indicates whether the Cardholder Shipping Address and N1 O 1 = Shipping Address matches Billing Address
ADDRESSMATCH Cardholder Billing Address are the same. 0 = Shipping Address does not match Billing Address

CUSTOMERAUTHENTICATION Cardholder authentication method on Merchant site N2 O 1 = Guest Login

TOMERCHANTMETHOD 2 = Login to the cardholder account at the 3DS
Requestor system using 3DS Requestor’s own
credentials
3 = Login to the cardholder account at the 3DS
Requestor system using federated ID
4 = Login to the cardholder account at the 3DS
Requestor system using issuer credentials
5 = Login to the cardholder account at the 3DS
Requestor system using third-party authentication
6 = Login to the cardholder account at the 3DS
Requestor system using FIDO Authenticator

CUSTOMERAUTHENTICATION Date of Cardholder authentication on Merchant Site N O Date format =YYYYMMDDHHMM Example:
TOMERCHANTUTCTIMESTAMP 12 201912311260

PRIORTHREEDSMETHOD CardHolder prior 3D authentication method N2 O Mechanism used by the Cardholder to previously
authenticate to the 3DS Requestor.
1 = Frictionless authentication occurred by ACS2 =
Cardholder challenge occurred by ACS
3 = AVS verified
4 = Other issuer methods

PRIORTHREEDSUTCTIMESTA CardHolder prior 3D authentication timestamp N O Date and time in UTC of the prior cardholder
MP 12 authentication "YYYYMMDDHHMM"

PRIORTHREEDSACSTRANSA CardHolder prior 3D authentication reference A O This data element provides additional information to the
CTIONID N ACS to determine the best approach for handing a
36 request.

Key Definition Ty R Example

pe eq

the second bath of data includes information on the browser of the consumer

DEVICEBROWSERAC HTTP accept headers from the Cardholder’s browser. A R Required when BROWSER method
CEPTHEADER N2
048

Ingenico document - Reproduction or disclosure prohibited without written authorization

91
DEVICEBROWSERIPA IP address of the browser as returned by the HTTP headers. A R Note: Required when BROWSER method is
DDRESS N45 used and for the regions where this is
acceptable.
Example IPv4 address: 1.12.123.255
IPv6 address:2011:0db8:85a3:0101:0101:
8a2e:0370:7334

BROWSERJAVAENAB Boolean that represents the ability of the cardholder browser to execute Java. N1 R Required for BROWSER method
LED Value is returned from the navigator.javaEnabled property. (0=False/1=True)

BROWSERLOCALE ISO 639 language code. Returned from navigator.language property. A R pa-in en-au en
N8

BROWSERCOLORDE Value representing the bit depth of the colour palette for displaying images, in N2 R Required for BROWSER method
PTH bits per pixel. Obtained from Cardholder browser using the screen.colorDepth 1,4,8,15,16,24,32,48
property.

BROWSERSCREENHE Total height of the Cardholder’s screen in pixels. A R Required for BROWSER method
IGHT Value is returned from the screen.height property. N6

BROWSERSCREENWI Total width of the cardholder’s screen in pixels. A R Required for BROWSER method
DTH Value is returned from the screen.width property. N6

DEVICEBROWSERTIM Time difference between UTC time and the Cardholder browser local time, in A R Required for BROWSER method
EZONEOFFSETMINUT minutes. N6
ES

DEVICEBROWSERUS Exact content of the HTTP user-agent header. A R Required for BROWSER method
ERAGENT N2
048

Key Definition T R Example

y eq
pe

the following set of data includes information regarding the account that the consumer has
on the merchant website

CUSTOMERACCOUNTAGEINDICA Length of time that the cardholder has had the account with the Merchant. N2 O 1 = No account
TOR (guest check-out)
2 = Created during
this transaction
3 = Less than 30
days
4 = 30-60 days
5 = More than 60
days

CUSTOMERACCOUNTCHANGEDA Date that the cardholder’s account with the 3DS Requestor was last changed, including N8 O Date format =
TE Billing or Shipping address, new payment account, or new user(s) added. YYYYMMDD
Example: 20191231

CUSTOMERACCOUNTCHANGEIND Length of time since the cardholder’s account information with the 3DS Requestor was last N2 O 1 = Changed during
ICATOR changed, including Billing or Shipping address, new payment account, or new user(s) this transaction
added. 2 = Less than 30
days
3 = 30-60 days
4 = More than 60
days

CUSTOMERACCOUNTCREATEDA Date that the cardholder opened the account with the 3DS Requestor. N8 O Date format =
TE YYYYMMDD
Example: 20191231

CUSTOMERACCOUNTPASSWORD Date that cardholder’s account with the 3DS Requestor had a password change or account N8 O Date format =
CHANGEDATE reset. YYYYMMDD
Example: 20191231

CUSTOMERACCOUNTPASSWORD Indicates the length of time since the cardholder’s account with the 3DS Requestor had a N2 O 1 = No change
CHANGEINDICATOR password change or account reset. 2 = Changed during
this transaction
3 = Less than 30
days
4 = 30-60 days
5 = More than 60
days

CUSTOMERACCOUNTNUMBEROF Number of purchases with this cardholder account during the previous six months. N4 O Example : 42
PURCHASESLASTSIXMONTHS

CUSTOMERACCOUNTNUMBEROF Number of Add Card attempts in the last 24 hours. N3 O Example : 547
ADDCARDATTEMPTSLAST24HOU
RS

CUSTOMERACCOUNTNUMBEROF Number of transactions (successful and abandoned) for this cardholder account with the N3 O Example : 547
TRANSACTIONSLAST24HOURS 3DS Requestor across all payment accounts in the previous 24 hours.

CUSTOMERACCOUNTNUMBEROF Number of transactions (successful and abandoned) for this cardholder account with the N3 O Example : 547
TRANSACTIONSLASTYEAR 3DS Requestor across all payment accounts in the previous year.

CUSTOMERACCOUNTPAYMENTA Date that the payment account was enrolled in the cardholder’s account with the 3DS N8 O Date format =
CCOUNTONFILECREATEDATE Requestor. YYYYMMDD
Example: 20191231

Ingenico document - Reproduction or disclosure prohibited without written authorization

92
CUSTOMERACCOUNTPAYMENTA Indicates the length of time that the payment account was enrolled in the cardholder’s N2 O 1 = No account
CCOUNTONFILEAGEINDICATOR account with the 3DS Requestor. (guest check-out)
2 = During this
transaction
3 = Less than 30
days
4 = 30-60 days
5 = More than 60
days

CUSTOMERACCOUNTSHIPPINGA Date when the shipping address used for this transaction was first used with the 3DS N8 O Date format =
DDRESSFIRSTUSAGEDATE Requestor. YYYYMMDD
Example: 20191231

CUSTOMERACCOUNTSHIPPINGA Indicates when the shipping address used for this transaction was first used with the 3DS N2 O 1 = This transaction
DDRESSFIRSTUSAGEINDICATOR Requestor. 2 = Less than 30
days
3 = 30-60 days
4 = More than 60
days

CUSTOMERACCOUNTSHIPPINGA Indicates if the Cardholder Name on the account is identical to the shipping Name used for N2 O 0 = Account Name
DDRESSNAMEINDICATOR this transaction. identical to shipping
Name
1 = Account Name
different than
shipping Name

CUSTOMERACCOUNTSUSPICIOU Indicates whether the 3DS Requestor has experienced suspicious activity (including N2 O 0 = No suspicious
SACCOUNTACTIVITY previous fraud) on the cardholder account. activity has been
observed
1 = Suspicious
activity has been
observed

Key Definition Type R Example

DELIVERYTI Indicates the merchandise delivery timeframe N1 O 1 = Electronic Delivery

MEFRAMEI 2 = Same day shipping
NDICATOR 3 = Overnight shipping
4 = Two-day or more shipping

PURCHASE For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major N15 its O for example, USD 123.45 is
DGIFTCARD units number 123
AMOUNT probably, just
like payment
amount

PURCHASE For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes N2 O
DGIFTCARD purchased.
COUNT

PURCHASE For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217 AN3 O USD
DGIFTCARD
CURRENCY
CODE

PREORDER For a pre-ordered purchase, the expected date that the merchandise will be available. N8 O Date format = YYYYMMDD
EDITEMSAV Example: 20191231
AILABILITY
DATE

PREORDER Indicates whether Cardholder is placing an order for merchandise with a future availability or N1 O 1 = Merchandise available
INDICATOR release date. 2 = Future availability

REORDERI Indicates whether the cardholder is reordering previously purchased merchandise N1 O 1 = First time ordered
TEMSINDIC 2 = Reordered
ATOR

SHIPPINGA Indicates shipping method chosen for the transaction. N1 O 1 = Ship to cardholder’s
DDRESSIN Merchants must choose the Shipping Indicator code that most accurately describes the billing address
DICATOR cardholder’s specific transaction, not their general business. 2 = Ship to another verified
If one or more items are included in the sale, use the Shipping Indicator code for the physical address on file with merchant
goods, or if all digital goods, use the Shipping Indicator code that describes the most 3 = Ship to address that is
expensive item. different than the cardholder’
s billing address
4 = “Ship to Store” / Pick-up
at local store (Store address
shall be populated in
shipping address fields)
5 = Digital goods (includes
online services, electronic
gift cards and redemption
codes)
6 = Travel and Event tickets,
not shipped
7 = Other (for example,
Gaming, digital services not
shipped, emedia
subscriptions, etc.)

Ingenico document - Reproduction or disclosure prohibited without written authorization

93
TRANSACTI Identifies the type of transaction that is being authenticated N2 O 01 = Goods / Service
ONTYPE purchase
03 = Check Acceptance
10 = Account Funding
11 = Quasi-Cash Transaction
28 = Prepaid Activation &
Load

CHALLENG Dimensions of the challenge window that has been displayed to the CH. ACS will reply with N1 R 1 = 250x 400
EWINDOWS content that is formatted to appropriately render in this window to provide the best user 2 = 390 x 400
IZE experience. Pre-configured sizes are width x height in pixels of the window displayed in the 3 = 500 x 600
CH browser window 4 = 600 x 400
5 = Full Screen

METHODNO it is the end point of client application which will receive method notification from issuing bank AN2048 R
TIFICATION
URL

CHALLENG it is the end point of client application which will receive challenge notification from issuing AN2048 R
ENOTIFICA bank
TIONURL

ENDAUTHE Marker (no key) – O –

NTICATE

Valid ZIP STATECODE combination for Registered Boleto Bancario

Low Range High Range STATECODE Description

1000000 9999999 SP Sao Paulo Metropolitan Region including the suburbs or the area outside the Sao Paulo metropolitan region

11000000 19999999 SP State of Sao Paulo

20000000 28999999 RJ State of Rio de Janeiro

29000000 29999999 ES State of Espirito Santo

30000000 39999999 MG State of Minas Gerais

40000000 48999999 BA State of Bahia

49000000 49999999 SE State of Sergipe

50000000 56999999 PE State of Pernambuco

57000000 57999999 AL State of Alagoas

58000000 58999999 PB State of Paraiba

59000000 59999999 RN State of Rio Grande do Norte

60000000 63999999 CE State of Ceara

64000000 64999999 PI State of Piaui

65000000 65999999 MA State of Maranhao

66000000 68899999 PA State of Para

68900000 68999999 AP State of Amapa

69000000 69299999 AM State of Amazonas (part 1)

69300000 69399999 RR State of Roraima

69400000 69899999 AM State of Amazonas (part 2)

69900000 69999999 AC State of Acre

70000000 72799999 DF Federal District (part 1)

72800000 72999999 GO State of Goias (part 1)

73000000 73699999 DF Federal District (part 2)

73700000 76799999 GO State of Goias (part 2)

76800000 76999999 RO State of Rondonia (part 1)

77000000 77999999 TO State of Tocantins

78000000 78899999 MT State of Mato Grosso

78900000 78999999 RO State of Rondonia (part 2)

79000000 79999999 MS State of Mato Grosso do Sul

80000000 87999999 PR State of Parana

Ingenico document - Reproduction or disclosure prohibited without written authorization

94
88000000 89999999 SC State of Santa Catarina

90000000 99999999 RS State of Rio Grande do Sul

Return keys

Key Definition Type Example

RESULT OK or NOK AN10

META Marker (no key) – META

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – ENDMETA

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 400220

MESSAGE Message for error or event AN4000 DOPAYMENT_ORDER_NOT_FOUND

ENDERROR Marker (no key) – ENDERROR

Additional for online credit card payments

Key Definition Type Example

ROW Marker (no key) – –

CURRENCYCODE ISO 4217 currency code AN3 EUR

AMOUNT Amount N12 –

PAYMENTREFERENCE Reference given by Ingenico ePayments to payment AN –

ADDITIONALREFERENCE Additional reference AN –

External Reference of credit card payment—Should be used as REFERENCEORIGPAYME

NT in eventual refunds (See DO_REFUND)

If you provide a reference and

l ORDERTYPE=1 the return is 30 characters

l ORDERTYPE=4 the return

is 30 characters

If you do not provide a reference and

l ORDERTYPE=1 the return is 30 characters

l ORDERTYPE=4 the return

EXTERNALREFERENCE is 25 characters AN 00000000010000212121000

30 0100001

SCHEMETRANSACTIONID Unique transaction identifier returned by Visa and Mastercard for Pre Authorization, Recurring AN AS37504079V1664
and UCOF transactions 15

INITIALSCHEMETRANSAC The transaction ID given by Visa and Mastercard after the First Recurring/First UCOF/Pre AN MC1238743876289
TIONID Authorization 15

STATUSID Status N5 –

STATUSDATE Date and time of payment N14 20130604123456

Ingenico document - Reproduction or disclosure prohibited without written authorization

95
Key Definition Type Example

Format: YYYYMMDDHH24MISS

Result of the AVS service

AVSRESULT The results that return depend on the checks performed AN1 Z

Result of the CVV2/CVC2 service

The results that return depend on the checks performed

CVVRESULT AN1 M

Result of the fraud service

FRAUDRESULT The results that return depend on the checks performed AN1 D

Result of the fraud service

FRAUDCODE The results that return depend on the checks performed AN4 0000

FRAUDNEURAL Result of the fraud service AN4 150

FRAUDRCF Result of the fraud service AN4 GEO,TUMBLES,PHONEVEL,HIGHU SE

Authorization code

AUTHORISATIONCODE

AUTHORISATIONCODE appears only when configured by Ingenico ePayments AN10 321234

ACSURL URL for redirection of consumer AN2 Returned after CheckEnrollment with enrolled consumer
55

PAREQ Pareq for redirection—Should be used as hidden field AN4 Returned after CheckEnrollment with enrolled consumer
00 0

Transaction ID for redirection—Should be used as hidden field (for Returned after CheckEnrollment with enrolled consumer
VISA only) and after a valid AuthenticationValidation
XID AN50

DIRECTORYSERVERT Universally unique transaction identifier assigned by the Directory AN36

RANSACTIONID Server (schemes) to identify a single transaction

THREEDSPROTOCOL the most recent active protocol version that is supported by the ?
VERSION Directory server

Merchant data key for redirection—Should be used as hidden field Returned after CheckEnrollment with enrolled consumer

MD AN50

PROOFXML Proof XML message AN4 Returned after CheckEnrollment with enrolled consumer
00 0

Dynamic currency conversion indicator

l 1=Dynamic currency conversion applied at Fexco

l 2=Dynamic currency

conversion applied at own risk

l 0=Dynamic currency

DCCINDICATOR conversion does not apply or key not present N1 1

Key Definition Type Example

Amount that was authorized after applying dynamic currency conversion, if dynamic currency conversion applies

ISSUERAMOUNT N12 –

ISO 4217 currency code used in authorization, if dynamic currency conversion applies

ISSUERCURRENCYCODE AN3 EUR

Ingenico document - Reproduction or disclosure prohibited without written authorization

96
Provides an additional means of reconciliation for Gateway merchants

Must be configured to be returned

SERVICEPROVIDERID AN64 –

Provides an additional means of reconciliation for Gateway merchants

Must be configured to be returned

PROVIDERREFERENCE AN64 –

ENDROW Marker (no key) – –

Additional for batch credit card payments

Key Definition Ty Example

ROW Marker (no key) – –

PAYMENTREFER Reference of the payment (always 0 with batch credit card payments) AN 0
ENCE 20

ADDITIONALREFE Additional reference AN –

RENCE 20

External Reference of credit card payment, this value should be used as REFERENCEORIGPAYMENT in
eventual refunds (see DO_REFUND)
EXTERNALREFER AN 000000000100002121210
ENCE 30 000100001

STATUSID Status N5 –

CURRENCYCODE ISO 4217 currency code AN3 EUR

AMOUNT Amount N12 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

ENDROW Marker (no key) – –

Additional for invoice payments

Key Definition Type Example

ROW Marker (no key) – –

PAYMENTREFERENCE Reference given by Ingenico ePayments to payment AN20 –

ADDITIONALREFERENCE Additional reference AN20 –

EXTERNALREFERENCE External Reference AN30 000000000100002121210000100001

Key Definition Type Example

STATUSID Status N5 –

CURRENCYCODE ISO 4217 currency code AN3 EUR

AMOUNT Amount N12 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

ENDROW Marker (no key) – –

Additional for bank transfer payments including bank transfer Brazil (51)

Ingenico document - Reproduction or disclosure prohibited without written authorization

97
Key Definition Type Example

ROW Marker (no key) – –

Reference given by Ingenico ePayments to payment or taken from the input tag
OVERWRITEPAYMENTREFERENCE

PAYMENTREFERENCE is generated by the payment server. It must be provided to the consumer as a

reference to be used for the payment

PAYMENTREFERE AN20 –
NCE

ACCOUNTHOLDER Name of Account holder to pay to AN50 –

BANKNAME Name of bank to pay to AN55 –

CITY City of the bank to pay to AN50 –

SWIFTCODE Swift code of bank (if applicable) AN2 –

SPECIALID Country specific bank key(s) AN2 –

BANKACCOUNTN Bank account number AN50 –

UMBER

IBAN International Bank Account Number AN50 –

COUNTRYDESCRI Country of bank AN50 –

PTION

ADDITIONALREFE Additional reference AN20 –

RENCE

EXTERNALREFER External Reference AN30 0000000001000021212100

ENCE 00100001

STATUSID Status N5 –

CURRENCYCODE ISO 4217 currency code AN3 USD

AMOUNT Amount to be paid by consumer N12 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

Provides an additional means of reconciliation for Gateway merchants

SERVICEPROVIDE Must be configured to be returned AN2 –

RID 55

Provides an additional means of reconciliation for Gateway merchants

PROVIDERREFER Must be configured to be returned AN2 –

ENCE 55

ENDROW Marker (no key) – –

Additional for BPAY—Australia (500)

Key Definition Type Example

ROW Marker (no key) – –

Key Definition Type Example

STATUSID Status N5

Reference to be used by consumer for payment

CUSTOMERPAYMENTREFERENC

E and BILLERID must be provided to the consumer for BPAY even though the Ingenico
ePayments bank details are returned
CUSTOMERPAYMENTREF N15 001234567890120
EREN CE

ADDITIONALREFERENCE Additional reference AN20 –

Ingenico document - Reproduction or disclosure prohibited without written authorization

98
ACCOUNTHOLDER Name of account holder to pay to AN50 Ingenico ePayments

EXTERNALREFERENCE External reference AN30 000000000100002121210

0001000

EFFORTID Payment effort N5 –

Reference given by Ingenico ePayments to payment or taken from the input tag
OVERWRITEPAYMENTREFEREN CE

PAYMENTREFERENCE is

generated by Ingenico ePayments

PAYMENTREFERENCE AN12 –

ATTEMPTID Attempt number N5 –

BANKACCOUNTNUMBER Bank account number AN50 062000-11002112

CITY City of the bank to pay to AN50 Sydney

SWIFTCODE Swift code of bank (if applicable) AN2 CTBAAU2S

COUNTRYDESCRIPTION Country of bank AN50 Australia

BANKNAME Name of bank to pay to AN55 Commonwealth Bank

The biller identifier allocated to Ingenico ePayments

CUSTOMERPAYMENTREFERENC

E and BILLERID must be provided to the consumer for BPAY even though the Ingenico
ePayments bank details are returned
BILLERID AN27 747089 - Ingenico
ePayments

CURRENCYCODE ISO 4217 currency code AN3 AUD

AMOUNT Amount N12 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

ENDROW Marker (no key) – –

Additional for direct debit payments

Key Definition Type Example

ROW Marker (no key) – –

ADDITIONALREFERENCE Additional reference AN20 –

Key Definition Type Example

EXTERNALREFERENCE External Reference AN30 000000000100002121210000100001

STATUSID Status N5 –

CURRENCYCODE ISO 4217 currency code AN3 EUR

AMOUNT Amount N12 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

ENDROW Marker (no key) – –

Additional for cash payments

Key Definition Type Example

Ingenico document - Reproduction or disclosure prohibited without written authorization

99
ROW Marker (no key) – –

MERCHANTID Merchant ID generated by Ingenico ePayments N4 –

ORDERID Unique order ID generated by Ingenico ePayments N10 9998890004

EFFORTID Payment effort N5 –

ATTEMPTID Indicates how many attempts have been made for this payment N5 –

ADDITIONALREFERENCE Additional reference AN20 –

EXTERNALREFERENCE External reference AN30 0000000001000021212100001000

STATUSID Status N5 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

Reference given by Ingenico ePayments to payment

PAYMENTREFERENCE is generated by Ingenico ePayments

For Western Union payments, PAYMENTREFERENCE is the Western Union account

number

PAYMENTREFERENCE AN12 –

Provides an additional means of reconciliation for Gateway merchants

SERVICEPROVIDERID Must be configured to be returned AN16 –

Provides an additional means of reconciliation for Gateway merchants

PROVIDERREFERENCE Must be configured to be returned AN16 –

ENDROW Marker (no key) – –

Additional for real-time bank transfer payments

Key Definition Ty Example

ROW MARKER (NO KEY) - -

MERCHANTID Merchant ID generated by Ingenico ePayments N4 –

ORDERID Unique order ID generated by Ingenico ePayments N10 9998890004

EFFORTID Payment effort N5 –

ATTEMPTID Indicates how many attempts have been made for this payment N5 –

Reference generated by Ingenico ePayments to payment

PAYMENTREFERENCE is generated by Ingenico ePayments and must be provided to the consumer as a

reference to be used for the payment

PAYMENTREFER AN –
ENCE 12

ADDITIONALREFE Additional reference AN –

RENCE 20

EXTERNALREFER External reference AN 000000000100002121210

ENCE 30 000100001

STATUSID Status N5 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

Payment product-specific parameters, see the table for each payment product

ENDROW Marker (no key) – –

Additional information when credit card processing is done with 3D v2

Ingenico document - Reproduction or disclosure prohibited without written authorization

100
Key Definition T Example
y
pe

ROW Marker (no key) –

CUSTOMERTH CardHolder 3D authentication method N2

REEDMETHOD

CUSTOMERTH CardHolder 3D authentication timestamp N

REEDDATE 12

CUSTOMERTH CardHolder 3D authentication reference A -

REEDREF N
36

THREEDSSER 3ds server transaction id (send by DO_PAYMENT/IOWP A

VERTRANSAC response) N
TIONID 36

ACSTRANSAC Universally Unique transaction identifier assigned by the A

TIONID ACS to identify a single transaction. N
36

THREEDSMET ACS Method URL to redirect A

HODURL N
256

THREEDSMET Contain data of 3DS Method Notification URL and A

HODURLDATA ThreeDS Server tx id in base64 encoded format N
50
00

CARDHOLDERI Text provided by the ACS/Issuer to Cardholder during a A The Issuer can optionally provide information to Cardholder. For example,
NFO Frictionless transaction that was not authenticated by the N “Additional authentication is needed for this transaction, please contact (Issuer
ACS. 128 Name) at xxx-xxx-xxxx.”

ACSCHALLEN Indication of whether a challenge is required for the A1 Values accepted:

GEMANDATED transaction to be authorised due to local/regional • Y = Challenge is mandated
mandates or other variable. • N = Challenge is not mandated

REDIRECTINFO Marker (no key) –

FORMMETHOD http method type - POST A

PROVIDERURL Redirect URL A

N
20
48

FORMPARAME form parameters submitted to http form post A

TERS N
50
00

ENDREDIRECT Marker (no key) –

INFO

ENDROW Marker (no key) –

Additional for HostedMerchantLink

Here are the different responses. All these keys are communicated to the bank.

l The FORMMETHOD key describes the method used to communicate values to the bank—GET or POST

l The FORMACTION key indicates the target of the POST or GET, which is the URL of the real-time bank payment page

l For GiroPay (816), iDEAL (809), and Raifeissen ELBA (820), no values need to be posted by you to the real-time

bank—Ingenico ePayments provides the complete URL to be used to redirect the consumer

Key Definition Type Example

Method to be used when redirecting

FORMMETH AN4 GET

Ingenico document - Reproduction or disclosure prohibited without written authorization

101
URL to be used when redirecting the consumer
including the REF

FORMACTI AN40 HTTPS://ps.gcsip.com/orb/orb?REF=00000905012345678900000100001&MAC=2

ON 00 34134adabg3245

Key Definition Type Example

and the MAC

REF Reference AN50 00000905012345678900000100001

MAC Signature AN51 2 234134adabg3245

Signature used by Ingenico ePayments in conjunction with the provided RETURNU

RL and the REF

RETURNMA C AN51 2 8abd57696gh5dg0

Additional for Nordea E-maksu—Finland (802)

Key Definition Type Example

FORMMETHOD Method used when redirecting AN4 POST

FORMACTION URL used when redirecting the consumer AN2 HTTPS://solo3.nordea.fi:443/cgi- bin/SOLOPM01
50

SOLOPMT_ CUR Currency of payment AN3 EUR

SOLOPMT_ Amount with dot to separate the decimals N12 299.00

AMOUNT

SOLOPMT_ Payment version AN4 0002

VERSION

SOLOPMT_ STAMP Unambiguous code for technical specification of the payment AN20 Displays the MERCHANTID (5) + ORDERID (10) +
EFFORTID (5)

SOLOPMT_ RCV_ID Merchant’s agreement Number AN10 As supplied by the bank

SOLOPMT_ l 1=Finnish
LANGUAGE
l 2=Swedish N1 –

l 3=English

SOLOPMT_ REF Standard reference on the payment AN20 Displays the PAYMENTREFERENCE

SOLOPMT_ DATE EXPRESS or the payment due date AN10 EXPRESS

SOLOPMT_ MSG Message for the account statement of the consumer, as provided to AN2 –
Ingenico ePayments 34

SOLOPMT_ Return address following payment, as provided to Ingenico ePayments AN1 –

RETURN 20

SOLOPMT_ Return address if payment is cancelled, as provided to Ingenico AN1 –

CANCEL ePayments 20

Ingenico document - Reproduction or disclosure prohibited without written authorization

102
Key Definition Type Example

SOLOPMT_ REJECT Return address if payment is rejected, as provided to Ingenico ePayments AN120 –

SOLOPMT_ MAC Checksum of the payment details AN32 –

SOLOPMT_ CONFIRM If confirmation of payment is required AN3 YES

SOLOPMT_ KEYVERS for example, 0001 N4 0001

FORMMETHOD Method used when redirecting AN4 POST

Additional for Nordea E-Betaling—Denmark (803)

Key Definition Type Example

FORMMETHOD Method to be used when redirecting AN4 POST

FORMACTION URL to be used when redirecting the consumer AN250 HTTPS://solo3.nordea.fi:443/cgi- bin/SOLOPM01

SOLOPMT_ CUR Currency of payment AN3 DKK

SOLOPMT_ AMOUNT Amount with dot to separate the decimals N12 299.00

SOLOPMT_ Payment version AN4 0002

VERSION

SOLOPMT_ STAMP Unambiguous code for technical specification of the payment AN20 Displays the MERCHANTID (5) + ORDERID (10) +
EFFORTID (5)

SOLOPMT_ RCV_ID Merchant's agreement Number AN10 As supplied by the bank

l 1=Finnish

SOLOPMT_ l 2=Swedish
LANGUAGE
l 3=English N1 5

l 4=Estonian

l 5=Danish

SOLOPMT_ REF Standard reference on the payment AN20 Displays the PAYMENTREFERENCE

SOLOPMT_ DATE EXPRESS or the payment due date AN10 EXPRESS

SOLOPMT_ MSG Not used for Nordea E-betaling—Denmark AN234 –

SOLOPMT_ RETURN Return address following payment, as provided to Ingenico AN120 –

ePayments

SOLOPMT_ CANCEL Return address if payment is cancelled, as provided to Ingenico AN120 –

ePayments

SOLOPMT_ REJECT Return address if payment is rejected, as provided to Ingenico AN120 –

ePayments

SOLOPMT_ MAC Checksum of the payment details AN32 –

Key Definition Type Example

SOLOPMT_ CONFIRM Confirmation of the payment YES (or NO) AN3 YES

SOLOPMT_ KEYVERS For example, 0001 N4 0001

Additional for Nordea E-betalning—Sweden (805)

Ingenico document - Reproduction or disclosure prohibited without written authorization

103
Key Definition Type Example

FORMMETHOD Method used when redirecting AN4 POST

FORMACTION URL used when redirecting the consumer AN250 HTTPS://gfs.nb.se:443/e- betalning/direktbetalning

NB_VERSION Version of the Nordea system AN4 0001

NB_RCV_ID Account at the Nordea system AN14 –

NB_DB_CUR Currency code of the payment AN3 SEK

NB_DB_ AMOUNT Payment amount (with comma for decimal) N12 29,95

NB_STAMP Unambiguous code for technical specification of the payment AN20 Displays the MERCHANTID (5)ORDERID (10)
EFFORTID (5)

NB_DB_REF Standard reference on the payment N25 Displays the PAYMENTREFERENCE

NB_HMAC Signature of the payment request AN32 –

NB_CANCEL Return URL if payment is cancelled by consumer AN120 –

NB_REJECT Return URL if payment is rejected by Nordea system AN120 –

NB_RETURN Return URL if payment was completed AN120 –

NB_KVV

SOLOPMT_ Not used for Nordea Sweden N1 1

LANGUAGE

SOLOPMT_ DATE Not used for Nordea Sweden AN10 EXPRESS

SOLOPMT_ Not used for Nordea Sweden N4 0001

KEYVERS

SOLOPMT_ Not used for Nordea Sweden AN3 YES

CONFIRM

SOLOPMT_ MSG Message for the account statement of the consumer, as provided to AN234 –
Ingenico ePayments

Additional for iDEAL—The Netherlands (809)

Key Definition Type Example

FORMMETH OD Method used when redirecting

AN4 GET

FORMACTIO URL used AN4 HTTPS://ideal.abnamro.nl/nl/consumer/ProcessTransaction?ideal=1&ingewikkeld

Key Definition Type Example

when redirecting the consumer

N 000 ecode=123&trxid=123456789112

Unique ID that is assigned by the acquiring bank—This also appears on the consumer bank
statement

TRANSACTI
ONID
N16 1234123456789012

Ingenico document - Reproduction or disclosure prohibited without written authorization

104
Additional code provided with the RETURNUR

L after the transaction— Use this to check if the combination of this key and the provided
TRANSACTI ONID

correspond to an order

ENTRANCE
CODE
AN40 0000000001999892061400001000018303
610187

Additional for GiroPay—Germany (816)

Key Defini tion Typ e Example

Met hod used whe n redir ectin g

FORM METH OD AN 4

GET

URL

used whe n redir ectin

FORM ACTIO N AN 400 HTTPS://testpm.pago.de/perl/mp/process/multipay?SessionID=895587601&err=HTTPS%3A%2F

0 %2Fps.gcsip.nl%2Fwdl%2FRequestInfo.jsp%3FRETURNSTATUS%3DCANCEL%26&ibv=1

Key Defini tion Typ e Example

g the cons umer

358Additional for PaySafeCard—Various countries (830)

Key Definiti on Type Example

Metho d

used when redire cting

FORMMET AN
HOD 4
GET

URL

used when redire cting the

consu mer

FORMACTI AN HTTPS://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet?mid=
ON 400 1000000433&mtid=999100579019&amount=1.00&currency=EUR&language=de

Ingenico document - Reproduction or disclosure prohibited without written authorization

105
Merch ant Client ID for paysa
fecard (PPID 830)

MERCHAN AN
TCLIENTID 50
1234567890abcdefGHIJK

Additional for PayPal—Various countries (840)

Key Definitio n Type Example

Metho d used when redirec

ting
FORMME
THOD
AN4 GET

URL

used when redirec ting the

consu mer

FORMAC AN4 HTTPS://ps.gcsip.nl/orb/orb?ACTION=DO_ START&REF=000000999120080331010000100001&

TION 000 MAC=RbSBcK%2FfTst7Xa

3ahDgJhvoSHb0lbTVjdbh66flV1Wo%3D

Examples

Bank payment

<XML>

<ACTION>DO_PAYMENT</ACTION>

<META>

</META>

<CITY>Barcelona</CITY>

Ingenico document - Reproduction or disclosure prohibited without written authorization

106
<SURNAME>Driel</SURNAME>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>DO_PAYMENT</ACTION>

<META>

</META>

<CITY>Barcelona</CITY>

<SURNAME>Driel</SURNAME>

</PAYMENT>

</PARAMS>

<META>

</META>

<ROW>

Ingenico document - Reproduction or disclosure prohibited without written authorization

107
<ATTEMPTID>1</ATTEMPTID>

<ACCOUNTHOLDER>GlobalCollect BV</ACCOUNTHOLDER>

<CITY>Amsterdam</CITY>

<BANKNAME>ABN AMRO Bank</BANKNAME>

<COUNTRYDESCRIPTION>Nederland</COUNTRYDESCRIPTION>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Direct debit payment

<XML>

<ACTION>DO_PAYMENT</ACTION>

<META>

</META>

<ACCOUNTNAME>Cruijff</ACCOUNTNAME>

<SURNAME>Cruijff</SURNAME>

<CITY>Barcelona</CITY>

Ingenico document - Reproduction or disclosure prohibited without written authorization

108
<ZIP>1000 AA</ZIP>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>DO_PAYMENT</ACTION>

<META>

</META>

<ACCOUNTNAME>Cruijff</ACCOUNTNAME>

<SURNAME>Cruijff</SURNAME>

<CITY>Barcelona</CITY>

</PAYMENT>

</PARAMS>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

109
<RESPONSEDATETIME>20040718114145</RESPONSEDATETIME>

</META>

<ROW>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Credit card payment

<XML>

<ACTION>DO_PAYMENT</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

110
Possible response A
<XML>

<ACTION>DO_PAYMENT</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

<META>

</META>

<ROW>

</ROW>

</RESPONSE>

Ingenico document - Reproduction or disclosure prohibited without written authorization

111
</REQUEST>

</XML>

Possible response B
…

<META>

</META>

<ERROR>

REQUEST 1212121 VALUE 4567350000427976 OF FIELD CREDITCARDNUMBER DID NOT PASS THE

LUHNCHECK

</MESSAGE>

</ERROR>

</RESPONSE>

Ingenico document - Reproduction or disclosure prohibited without written authorization

112
DO_PAYOUT
This API call sends a request to Ingenico ePayments to perform a payout via bank transfer. The do payout structure is

REQUEST ACTION META PARAMS

ORDER PAYMENT

Input keys

Key Definition Type Req Example

ACTION DO_PAYOUT AN R DO_PAYOUT

META Marker (no key) – – –

MERCHANTID ID of Merchant N10 R 8888

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – – –

PARAMS Marker (no key) – – –

ORDER Marker (no key) – – –

Unique order ID generated by Ingenico ePayments

The combination of MERCHANTID and ORDERID must be unique within WebCollect

ORDERID N10 R 9998890004

MERCHANTORDERID Order ID generated by the merchant N10 O 1234567899

LANGUAGECODE Language code AN2 O en

Unique reference of merchant for payment

MERCHANTREFERENCE allowed

input is ASCII 32–126 characters—Do not include trailing spaces in the

MERCHANTREFERENCE

MERCHANTREFERENCE is required by Ingenico ePayments

MERCHANTREFEREN AN30 R GC000088881234567890200610
CE 3101

INVOICENUMBER Reference identifying the invoice, the order is referring to in your system AN20 O INV200610310001

CUSTOMERID Reference identifying the consumer in your system AN15 O CUST12345678901234

Key Definition Type Req Example

SURNAME Surname of consumer AN35 O –

FIRSTNAME First name of consumer AN15 O –

COMPANYNAME Company name of consumer AN40 O –

STREET Street of consumer AN50 O –

HOUSENUMBER House number of the consumer AN15 O –

ZIP Zip of the consumer AN10 O –

CITY City of the consumer AN40 O –

STATE State of the consumer AN35 O –

EMAILADDRESS Email address of the consumer AN70 O –

ENDORDER Marker (no key) – – –

PAYMENT Marker (no key) – – –

CURRENCYCO ISO 4217 currency code AN3 R EUR

Ingenico document - Reproduction or disclosure prohibited without written authorization

113
AMOUNT Amount (in cents!) to be refunded N12 R 1990 (=19.
90)

ISO3166 country code of consumer

COUNTRYCODE automatically determines the payment product—For more information about country codes, see
ISO country codes
COUNTRYCODE AN2 R DE

Surname billing

If this required key is empty, the value is copied from the same key in the order segment—If that key is empty too, an
error occurs
SURNAME N35 R –

First name billing

If this optional key is empty, the value is copied from the same key in the order segment

FIRSTNAME N15 O –

Company name billing

If this optional key is empty, the value is copied from the same key in the order segment

COMPANYNAME AN40 O –

Street billing

If this required key is empty, the value is copied from the same key in the order segment—If that key is empty too, an
error occurs
STREET AN50 R –

House number billing

If this optional key is empty, the value is copied from the same key in the order segment

HOUSENUMBER AN15 O –

Zip billing

ZIP ZIP is required for Norway and USA AN10 O –

CITY City billing AN40 R –

Key Definition Type Req Example

If this required key is empty, the value is copied from the same key in the order segment—If that key is empty too, an
error occurs

State billing

If this optional key is empty, the value is copied from the same key in the order segment

STATE AN35 O –

Email address billing

If this optional key is empty, the value is copied from the same key in the order segment

EMAILADDRESS AN70 O –

Payment product=Country-specific parameters

ENDPAYMENT Marker (no key) – – –

ENDPARAMS Marker (no key) – – –

Sepa Payouts (1270)

Key Definition Ty R Example

pe eq

PAYMENPRO Payment product identifier N5 R 1270 (Sepa

DUCTID Payout)

BANKCOUNT ISO 3166 country code of the consumer bank A R NL

RYCODE N2

Ingenico document - Reproduction or disclosure prohibited without written authorization

114
IBAN International bank account number A R NL59INGB000
N34 0241943

BIC BIC (bank identification code) A R INGBNL2A

N11

ACCOUNTNA Account holder A R J SMITH

ME N30

CUSTOMERB City of the consumer bank A R Amsterdam

ANKCITY N35

Date of the payout sent to the bank by Ingenico Epayments.

PAYOUTDATE Format: YYYYMMDD N8 O 20170502

Text to the printed on the bank account statement of the creditor. PAYOUTTEXTis limited to AN50- If you enter a text
string longer than this limi, it is out- off- you don't receive an error.
PAYOUTTEXT A R PAYOUTTEXT
N50

Return keys

Key Definition Type Example

RESULT OK or NOK AN OK

META Marker (no key) – –

– –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

Key Definition Type Example

ROW Marker (no key) – –

MERCHANTID Merchant ID N10 1234

ORDERID Unique order ID generated by Ingenico N10 9998890004

ePayments

EFFORTID Internal sequence number N5 -1

ATTEMPTID Attempt number N5 1

STATUSID Status N5 800

Date and time of refund

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

PAYMENTREFERENCE Refund reference N20 0

ADDITIONALREFEREN Additional reference N20 EX2006102701

EXTERNALREFERENCE External reference N20 EX2006102701

ENDROW Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 400300

MESSAGE Message for error or event AN4000 PAYMENTATTEMPT (MERCHANTID={0}, ORDERID={1}, EFFORTID={2})
NOT_FOUND

ENDERROR Marker (no key) – –

Example

Ingenico document - Reproduction or disclosure prohibited without written authorization

115
<XML>

<ACTION>DO_PAYOUT</ACTION>

<META>

</META>

<ORDER>

<SURNAME>Möller</SURNAME>

<STREET>Schönestraüme</STREET>

<CITY>München</CITY>

<EMAIL>[email protected]</EMAIL>

</ORDER>

<PAYOUTTEXT>Gruesse von GlobalCollect</PAYOUTTEXT>

<ACCOUNTNAME>Müller</ACCOUNTNAME>

<BANKNAME>Deutsche Bank</BANKNAME>

<CUSTOMERBANKCITY>München</CUSTOMERBANKCITY>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response

Ingenico document - Reproduction or disclosure prohibited without written authorization

116
<XML>

<ACTION>DO_PAYOUT</ACTION>

<META>

</META>

<ORDER>

<SURNAME>Möller</SURNAME>

<STREET>Schönestraüme</STREET>

<EMAIL>[email protected]</EMAIL>

<CITY>München</CITY>

</ORDER>

<ACCOUNTNAME>Müller</ACCOUNTNAME>

<CUSTOMERBANKCITY>München</CUSTOMERBANKCITY>

<PAYOUTTEXT>Gruesse von GlobalCollect</PAYOUTTEXT>

<BANKNAME>Deutsche Bank</BANKNAME>

</PAYMENT>

</PARAMS>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

117
<REQUESTID>204999</REQUESTID>

</META>

<ROW>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

118
DO_REFUND
This API call does refunds.

Refunds can be made on credit card and bank payments present in WebCollect and (in the first weeks) on orders that are not present in WebCollect.

To accommodate the different data used for bank refunds, several payment products have been created. We provide you with the required keys and
the local name of each key for each of these payment products here.

One-click refunds
If you provide the generic input keys and whatever required input keys you must provide for your payment in your INSERT_ORDERWITHPAYMENT
or DO_PAYMENT API call, you can enable one-click refunds for payments made using

l Direct debit

l iDEAL

l Sofortüberweisung (Only possible in EUR countries)

As long as you provide the generic input keys and whatever required input keys you must provide for your payment, the only key you need to proceed
with your one-click refund is

l ORDERID

The do refund structure is REQUEST

ACTION META

PARAMS PAYMENT

Input keys

l For Argentina only, the MERCHANTREFERENCE cannot contain more than 15 digits—This is due to limitations at Sub1

l For Argentina, EMAILADDRESS is mandatory and must contain a valid email address—If the email confirming the

transaction is refused the transaction is canceled

l Only For recurring transactions, EFFORTID is mandatory.

Key Definition Type Req Example

ACTION DO_REFUND AN R DO_REFUND

META Marker (no key) – – –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN O 123.123.123.123

VERSION Version of interface AN O 1.0

ENDMETA Marker (no key) – – –

PARAMS Marker (no key) – – –

PAYMENT Marker (no key) – – –

PROFILETOKEN Token provided by merchant AN O af16af70-2bf5-44e9-a087-

40 68c87f67e3a1

ORDERID Unique order ID generated by Ingenico ePayments N10 R 9998890004

Ingenico document - Reproduction or disclosure prohibited without written authorization

119
Order ID generated by the merchant

MERCHANTORDERID is required when no order exists in WebCollect and you use

REFERENCEORIGPAYMENT to

submit your API call: DO_REFUND

MERCHANTORD N10 O 1234567899
ERID

EFFORTID Payment number in cases of recurring payments only N5 O 1

Key Definition Ty R Example

pe eq

When MERCHANTREFERENCE

has been used in the request of the original order, use MERCHANTREFERENCE instead of
REFERENCEORIGPAYMENT

When MERCHANTREFERENCE

has not been used in the request of the original order, use REFERENCEORIGPAYMENT
MERCHANTREFERE AN R 00000000220000055555000
NCE containing the reference of the original payment as reported 30 0100001

When no order exists in WebCollect, use REFERENCEORIGPAYMENT

containing your own original reference

Do not include trailing spaces in the MERCHANTREFERENCE

REFERENCEORIGPA AN O 00000000220000055555000
YMENT 30 0100001

ISO 4217 currency code

CURRENCYCODE and

CURRENCYCODE COUNTRYCODE are required for orders that do not exist yet in WebCollect AN3 O USD

Amount (in cents!) to be refunded

AMOUNT AMOUNT is required for a partial refund N12 O 29990 (=299.90)

ISO3166 country code of consumer

CURRENCYCODE and

COUNTRYCODE COUNTRYCODE are required for orders that do not exist yet in WebCollect AN2 R –

Refund date

REFUNDDATE Format: YYYYMMDD D O 20021030

SURNAME Surname of Account Holder AN O –

FIRSTNAME First name of Account Holder AN O –

PREFIXSURNAME Surname prefix of account holder AN O –

TITLE Title AN O –
35

COMPANYNAME Company name AN O –

COMPANYDATA Company data AN O –

STREET Street AN O –
50

HOUSENUMBER House Number AN O –

ADDITIONALADDRES Additional address information AN O –

SINFO 50

ZIP Zip AN O –
10

Ingenico document - Reproduction or disclosure prohibited without written authorization

120
CITY City AN O –
40

Key Definition Type Req Example

STATE State AN35 O –

EMAILADDRESS Email address AN70 O –

EMAILTYPEINDICATOR Type of email N1 O –

...

Payment method specific parameters are provided in tables, below

...

ENDPAYMENT Marker (no key) – – –

ENDPARAMS Marker (no key) – – –

Credit card refund (1)

Key Definition Type Req

Payment product identifier

PAYMENTPRODUCTID PAYMENTPRODUCTID, CREDITCARDNUMBER, and EXPIRYDATE are N5 O

required for non-WebCollect refunds

Number of the credit card

CREDITCARDNUMBER PAYMENTPRODUCTID, CREDITCARDNUMBER, and EXPIRYDATE are N19 O

required for non-WebCollect refunds

Expiry date Format: MMYY

PAYMENTPRODUCTID, CREDITCARDNUMBER, and EXPIRYDATE are

EXPIRYDATE required for non-WebCollect refunds N4 O

Bank refund non-country-specific (1001)

Key Definition Ty R Example

pe eq

PAYMENTPRO Payment product identifier N5 R 1001

DUCTID (Bank
refund)

BANKCOUNTR ISO 3166 country code of the consumer bank AN2 R –

YCODE

SWIFTCODE Swift code (Required for Mexico) (Required for Russia) AN O ABNANL2A
11

BANKACCOUN Bank account number (Required for Mexico N11) AN R 1234567890

TNUMBER 10

BRANCHCODE Branch code (Required for Mexico N3) AN O –

BANKCODE Bank code (Required for Mexico N3) AN O –

BANKCHECKDI Check digit (Required for Mexico N1) AN2 O –

GIT

BANKNAME Name of the consumer bank AN R –

255

BANKADDRESS City of the consumer bank AN R –

255

Ingenico document - Reproduction or disclosure prohibited without written authorization

121
ACCOUNTNAME Account holder AN R –
35

FIRSTNAME Consumer first name AN O Jack

SURNAME Consumer surname AN O Buuren

PATRONYMICN Patronymic Name (Required for refunds in Russia) AN O –

AME 50

FISCALNUMBER Fiscal registration number of the consumer (BIK in Russia, Required for refunds in Russia) AN O –
11

City

CITY is required for Argentina, Bahrain, Bulgaria, Croatia, Egypt, Greece, Iceland, Kuwait, Lithuania, Mexico, Qatar,
Turkey, the United Arab Emirates, and the United States of America
CITY AN O –
40

Street

STREET STREET, HOUSENUMBER, and ZIP are required AN O –

Key Definition Type Req Example

Bahrain, Egypt, Kuwait, Qatar, and the United Arab Emirates

House number

STREET, HOUSENUMBER, and ZIP are required for Bahrain, Egypt, Kuwait, Qatar, and the United Arab
Emirates
HOUSENUMBER AN15 O –

Zip

STREET, HOUSENUMBER, and ZIP are required for Bahrain, Egypt, Kuwait, Qatar, and the United Arab
Emirates
ZIP AN10 O –

International Bank Account Number

IBAN IBAN is required for Kuwait and the United Arab Emirates AN20 O AT6119043002345732
01

Bank refund Australia (1002)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1002 (Bank refund Australia)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R AU

SWIFTCODE Swift code / BIC AN11 O ABNANL2A

BANKACCOUNTNUMBER Account number AN9 R 123456789

ACCOUNTNAME Account holder AN35 R

BANKCODE BSB NUMBER N6 R 123456

BANKNAME Name of the consumer bank AN255 R

BANKADDRESS City of the consumer bank AN255 R

Bank refund Denmark (1005)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1005 (Bank refund Denmark)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R DK

Ingenico document - Reproduction or disclosure prohibited without written authorization

122
BIC BIC AN11 R ABNANL2A

ACCOUNTNAME Account holder AN35 R –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

IBAN International Bank Account Number AN18 R DK5000400440116243

Bank refund Norway (1011)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1011 (Bank refund Norway)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R NO

BIC BIC AN11 R ABNANL2A

ACCOUNTNAME Account holder AN35 R –

ZIP Consumer Zip AN10 R –

CITY Consumer City AN40 R –

Key Definition Type Req Example

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

IBAN International Bank Account Number AN15 R NO9386011117947

Bank refund Sweden (1013)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1013 (Bank refund Sweden)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R SE

SWIFTCODE Swift code /BIC AN11 R ABNANL2A

ACCOUNTNAME Account holder AN35 R –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

IBAN International Bank Account Number AN24 O SE1212312345678901234561

Bank refund Switzerland (1014)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1014 (Bank refund Switzerland)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R CH

SWIFTCODE Swift code / BIC AN11 R ABNANL2A

ACCOUNTNAME Account holder AN35 R –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

IBAN International Bank Account Number AN21 R CH3900762011623852957

Ingenico document - Reproduction or disclosure prohibited without written authorization

123
Bank refund United Kingdom (1015)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1015 (Bank refund United Kingdom)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R GB

SWIFTCODE Swift code / BIC AN11 O ABNANL2A

BANKACCOUNTNUMBER Account number N8 R 12345678

ACCOUNTNAME Account holder AN35 R –

BANKCODE Sort code N6 R 123456

BANKNAME Name of the consumer bank AN255 O –

BANKADDRESS City of the consumer bank AN255 O –

IBAN International Bank Account Number AN22 O GB29NWBK60161331926819

Bank refund Japan (1016)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1016 (Bank refund Japan)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R JP

BANKACCOUNTNUMBER Account number N7 R 1234567

Key Definition Type Req Example

ACCOUNTNAME Account holder AN35 R –

SWIFTCODE Swift code / BIC AN11 O

BANKCODE Bank code N4 or N5 R 1234

BRANCHCODE Branchcode N3 or N4 R 123

BANKNAME Name of the consumer bank AN255 O –

BANKADDRESS City of the consumer bank AN255 R –

Bank refund Czech Republic (1019)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1019 (Bank refund Czech Republic)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R CZ

SWIFTCODE Swift code / BIC AN11 R ABNANL2A

ACCOUNTNAME Account holder AN35 R –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

IBAN International Bank Account Number AN25 R CZ6508000000192000145399

Bank refund Hungary (1021)

Key Definition Type Req Example

Ingenico document - Reproduction or disclosure prohibited without written authorization

124
PAYMENTPRODUCTID Payment product identifier N5 R 1021 (Bank refund Hungary)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R HU

SWIFTCODE Swift code / BIC AN11 R ABNANL2A

ACCOUNTNAME Account holder AN35 R –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

IBAN International Bank Account Number AN28 R HU42117730161111101800000000

Bank refund Poland (1024)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1024 (Bank refund Poland)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R PL

BIC BIC AN11 R ABNANL2A

ACCOUNTNAME Account holder AN35 R –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

IBAN International Bank Account Number AN28 R PL61109010140000071219812874

Bank refund South Africa (1026)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1026 (Bank refund South Africa)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R ZA

Key Definition Type Req Example

SWIFTCODE Swift code / BIC AN11 O ABNANL2A

BANKACCOUNTNUMBER Bank Account Number N11 R 1245878901

ACCOUNTNAME Account holder AN35 R –

FIRSTNAME Consumer first name AN15 R Jack

SURNAME Consumer surname AN35 R Buuren

BRANCHCODE Branch code N6 R 123456

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 O –

FIRSTNAME Consumer first name AN15 R Jack

SURNAME Consumer surname AN35 R Buuren

Bank refund Brazil (1027)

l COMPANYNAME and FISCALNUMBER (CNPJ) are required for business consumer transactions

l FISCALNUMBER (CPF) is required for non-business consumer transactions

l HOUSENUMBER is required if the house number is not included in the STREET field for all transactions

Ingenico document - Reproduction or disclosure prohibited without written authorization

125
Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1027 (Bank refund Brazil)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R BR

SWIFTCODE Swift code / BIC AN11 O ABNANL2A

Bank account number

BANKACCOUNTNUMBER BANKACCOUNTNUMBER can be 3–10 digits in length N10 R 124587890

ACCOUNTNAME Account holder AN35 R –

COMPANYNAME Name of company AN40 R Cruijff Sports

FISCALNUMBER Fiscal registration number of the consumer (CPF) AN11 R 28001238938

FISCALNUMBER Tax registration number of the company for a business consumer (CNPJ) AN14 R 12345678901234

BANKCODE Bank code N3 R 123

Branch code

BRANCHCODE BRANCHCODE can be 3–4 digits in length N4 R 1234

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 O –

FIRSTNAME First name AN15 R Jack

SURNAME Last name of consumer AN35 R Buuren

STREET Street address of consumer AN50 R Polarisavenue

HOUSENUMBER House number address of consumer AN15 O 1

ADDITIONALADDRESSINFO Additional address information AN50 O A

ZIP Zip code address of consumer AN10 O 1000 AA

CITY City of consumer AN40 R

STATECODE State code of the consumer AN9 R

COUNTRYCODE Country code of the consumer AN2 R

Key Definition Type Req Example

COUNTRYCODE is required for orders that do not exist yet in WebCollect

EMAIL Email address of the consumer AN70 R

Bank refund China (1028)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1028 (Bank refund China)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R CN

SWIFTCODE Swift code/ BIC AN11 O ABNANL2A

BANKACCOUNTNUMBER Account number N16 R 1234567890123456

Account holder

ACCOUNTNAME ACCOUNTNAME and BANKNAME must be in Chinese characters AN35 R

Name of the consumer bank

BANKNAME ACCOUNTNAME and BANKNAME must be in Chinese characters AN255 R

BANKADDRESS City of the consumer bank AN255 O –

Bank refund Hong Kong (1030)

Ingenico document - Reproduction or disclosure prohibited without written authorization

126
Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1030 (Bank refund Hong Kong)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R HK

SWIFTCODE Swift code / BIC AN11 O ABNANL2A

BANKACCOUNTNUMBER Account number N16 R 1234567890123456

BANKCODE Bank code N3 O 123

BRANCHCODE Branchcode N3 O 123

ACCOUNTNAME Account holder AN35 R –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 O –

Bank refund Taiwan (1031)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1031 (Bank refund Taiwan)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R TW

SWIFTCODE Swift code / BIC AN11 R ABNANL2A

BANKACCOUNTNUMBER Account number N16 R 1234567890123456

BANKCODE Bank code N3 R 123

BRANCHCODE Branchcode N4 R 1234

ACCOUNTNAME Account holder AN35 R –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 O –

Bank refund New Zealand (1032)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1032 (Bank refund New Zealand)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R NZ

SWIFTCODE Swift code / BIC AN11 O ABNANL2A

BANKACCOUNTNUMBER Account Number N15 R 123456789012345

ACCOUNTNAME Account holder AN35 R –

ZIP Consumer Zip AN10 R –

CITY Consumer City AN40 R –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

Bank refund Singapore (1034)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1034 (Bank refund Singapore)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R SG

SWIFTCODE Swift code / BIC AN11 R

Ingenico document - Reproduction or disclosure prohibited without written authorization

127
BANKACCOUNTNUMBER Account Number N12 R

BANKCODE Bank code N3 R 123

ACCOUNTNAME Account holder AN35 R –

ZIP Consumer Zip AN10 O –

CITY Consumer City AN40 O –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

Bank refund Canada (1035)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1035 (Bank refund Canada)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R CA

SWIFTCODE Swift code/BIC AN11 O

BANKACCOUNTNUMBER Account Number N12 R

BANKCODE Bank code N5 R

BRANCHCODE Branch code AN5 R

ACCOUNTNAME Account holder AN35 R –

ZIP Consumer Zip AN10 O –

CITY Consumer City AN40 O –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

Bank refund Indonesia-IDR (1036)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1036 (Bank refund Indonesia- IDR)

Key Definition Type Req Example

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R –

SWIFTCODE Swift code/BIC AN11 R –

BANKACCOUNTNUMBER Account number N14 R –

ACCOUNTNAME Account holder AN35 R –

ZIP Consumer Zip AN10 O –

CITY Consumer City AN40 R –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

Bank refund Indonesia-USD (1037)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1037 (Bank refund Indonesia - USD)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R –

Ingenico document - Reproduction or disclosure prohibited without written authorization

128
SWIFTCODE Swift code AN11 R –

BANKACCOUNTNUMBER Account Number N14 R –

ACCOUNTNAME Account holder AN35 R –

ZIP Consumer Zip AN10 O –

CITY Consumer City AN40 R –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

Bank refund Malaysia (1038)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1038 (Bank refund Malaysia)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R

SWIFTCODE Swift code/BIC AN11 O

BANKACCOUNTNUMBER Account Number N14 R

ACCOUNTNAME Account holder AN35 R –

ZIP Consumer Zip AN10 O –

CITY Consumer City AN40 O –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

Bank refund Philippines (1039)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1039 (Bank refund Philippines)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R

SWIFTCODE Swift code / BIC AN11 R

BANKACCOUNTNUMBER Account Number N15 R

ACCOUNTNAME Account holder AN35 R –

ZIP Consumer Zip AN10 O –

Key Definition Type Req Example

CITY Consumer City AN40 O –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

Bank refund Thailand (1041)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1041 (Bank refund Thailand)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R

SWIFTCODE Swift code/BIC AN11 R

BANKACCOUNTNUMBER Account Number N R

Ingenico document - Reproduction or disclosure prohibited without written authorization

129
ACCOUNTNAME Account holder AN35 R –

ZIP Consumer Zip AN10 O –

CITY Consumer City AN40 O –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

Bank refund Romania—EUR (1042)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1042 (Bank refund Romania - EUR)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R RO

BIC BIC AN11 R

ACCOUNTNAME Account holder AN35 R –

ZIP Consumer Zip AN10 O –

CITY Consumer City AN40 O –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 O –

IBAN International Bank Account Number AN26 R RO49AAAA1831007593840000

Bank refund Romania (1043)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1042 (Bank refund Romania)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R RO

BIC BIC AN11 R

ACCOUNTNAME Account holder AN35 R –

ZIP Consumer Zip AN10 O –

CITY Consumer City AN40 O –

BANKNAME Name of the consumer bank AN255 R –

BANKADDRESS City of the consumer bank AN255 R –

IBAN International Bank Account Number AN26 R RO49AAAA1831007593840000

SEPA bank refund (1070)

Key Definition Type Req Example

PAYMENTPRODUCTID Payment product identifier N5 R 1070 (SEPA bank refund)

BANKCOUNTRYCODE ISO 3166 country code of the consumer bank AN2 R NL

IBAN International Bank Account Number AN50 R NL39RABO0300065264

SURNAME Surname of account holder AN35 R –

Return keys

Key Definition Type Example

RESULT OK or NOK AN OK

Ingenico document - Reproduction or disclosure prohibited without written authorization

130
META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETI Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

MERCHANTID Merchant ID N10 1

ORDERID Order ID N10 9998890004

EFFORTID Internal sequence number N5 -2

ATTEMPTID Attempt number N5 4

STATUSID Status N5 800

Date and time of refund

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

PAYMENTREFEREN Refund reference N20 185800004860

ADDITIONALREFER Additional reference N20 19998890004

ENCE

EXTERNALREFERE External reference N20 0000000001123455556900001

NCE

Provides an additional means of reconciliation for

Gateway merchants

Must be configured to be returned

SERVICEPROVIDER AN255 –
ID

Provides an additional means of reconciliation for

Gateway merchants

Must be configured to be returned

PROVIDERREFERE AN255 –
NCE

ENDROW Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 400300

PAYMENTATTEMPT (MERCHANTID={0}, ORDERID={1}, EFFORTID=

{2}) NOT_ FOUND
MESSAGE Message for error or event AN40
00

ENDERROR Marker (no key) – –

Example—Bank refund

<XML>

<ACTION>DO_REFUND</ACTION>

<META>

</META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

131
<BANKACCOUNTNUMBER>12345678</BANKACCOUNTNUMBER>

<BANKADDRESS>BankStreet 3</BANKADDRESS>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>DO_REFUND</ACTION>

<META>

</META>

<BANKADDRESS>BankStreet 3</BANKADDRESS>

Ingenico document - Reproduction or disclosure prohibited without written authorization

132
<BANKACCOUNTNUMBER>12345678</BANKACCOUNTNUMBER>

</PAYMENT>

</PARAMS>

<META>

</META>

<ROW>

<COUNTRYDESCRIPTION>United Kingdom</COUNTRYDESCRIPTION>

<ACCOUNTHOLDER>GlobalCollect BV</ACCOUNTHOLDER>

<BANKNAME>Barclays Bank</BANKNAME>

<CITY>London</CITY>

<SPECIALID>Sort Code 20-00-00</SPECIALID>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Example—Credit card
<XML>

<ACTION>DO_REFUND</ACTION>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

133
<VERSION>1.0</VERSION>

</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>DO_REFUND</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

Ingenico document - Reproduction or disclosure prohibited without written authorization

134
<RESULT>OK</RESULT>

<META>

</META>

<ROW>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Example—eWallet
<XML>

<ACTION>DO_REFUND</ACTION>

<META>

</META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

135
<AMOUNTSIGN>+</AMOUNTSIGN>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Example—One-click refund
<XML>

<ACTION>DO_REFUND</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

136
DO_RISKASSESSMENT
This API call performs a fraud check but does not process the payment.

The do risk assessment structure is REQUEST

ACTION META PARAMS

ORDER

AIRLINEDATA (Optional) FLIGHTLEGS (Optional) FLIGHTLEG (Optional, 0 – N)

PAYMENT RISKASSESSMENT

Input keys

Key Definition Type Req Example

ACTION DO_RISKASSESSMENT AN R DO_RISKASSESSMENT

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

ORDER Marker (no key) – R –

ORDERID Unique order ID generated by Ingenico ePayments N10 R 9998890004

MERCHANTORDERID Order ID generated by the merchant N10 O 1234567899

Type of order

l 1=Normal order (default)

ORDERTYPE l 4=Variable amount recurring order N1 O 1

AMOUNT Amount of the order in cents N12 O 29990 (=299.90)

CURRENCYCODE ISO 4217 currency code AN3 O USD

Key Definition Type Req Example

LANGUAGECODE ISO 639 language code for consumer AN2 O en

COUNTRYCODE ISO 3166 country code of consumer AN2 R US

IPADDRESSCUSTOMER IP address of consumer in session AN32 O 124.124.124.124

CUSTOMERID ID of consumer AN15 O 1

FIRSTNAME First name AN15 O Jack

PREFIXSURNAME In between first name and surname AN15 O van

SURNAME Last name of consumer AN35 O Buuren

STREET Street address consumer AN50 O Polarisavenue

HOUSENUMBER House number address consumer AN15 O 1

ADDITIONALADDRESSINFO Additional address information AN50 O A

ZIP Zip code address consumer AN10 O 1000 AA

CITY City of consumer AN40 O New York

STATE State address consumer AN35 O New York

Ingenico document - Reproduction or disclosure prohibited without written authorization

137
SHIPPINGFIRSTNAME First name AN15 O Jack

SHIPPINGPREFIXSURNAME In between first name and surname AN15 O van

SHIPPINGSURNAME Last name of consumer AN35 O Buuren

SHIPPINGSTREET Street address consumer AN50 O Polarisavenue

SHIPPINGHOUSENUMBER House number address consumer AN15 O 1

SHIPPINGADDITIONALADDRESS Additional address information AN50 O A

INFO

SHIPPINGZIP Zip code address consumer AN10 O 1000 AA

SHIPPINGCITY City of consumer AN40 O New York

SHIPPINGSTATE State address consumer AN35 O New York

SHIPPINGCOUNTRYCODE ISO 3166 country code of consumer AN2 O US

Unique reference of merchant for payment

MERCHANTREFERENCE

allowed input is ASCII 32–126 characters—Do not include trailing spaces in the
MERCHANTREFERENCE
MERCHANTREFERENCE AN30 R –

EMAIL Email address of consumer AN70 O someone@email.

com

PHONENUMBER Phone number consumer AN20 O +34201234567

Day of birth of consumer (for fraud detection reasons) (ccyymmdd)

BIRTHDATE N8 O 19780203

ENDORDER Marker (no key) – R –

Key Definition Type Req Example

AIRLINEDATA Marker (no key) – O If airline date is

present

AIRLINECODE Airline numeric code N3 R 123

AIRLINENAME Name of airline AN20 R KLM

AIRLINEINVOICENUMBER Airline tracing number N6 O 465321

Travel agent code

For transactions using Elavon, AGENTNUMBERICCODE is

limited to N8

This spelling (AGENTNUMBERICCODE) N6

N8
AGENTNUMBERICCODE must be used O 123456 or 12345678

The ticket or document number contains

l Airline code—3-digit airline code number

l Form code—A maximum of 3

digits indicating the type of document, the source of issue and the number of coupons it
contains

l Serial number—A maximum

of 8 digits allocated on a sequential basis, provided that the total number of digits

allocated to the form code and serial number shall not

exceed ten

You can replace TICKETNUMBER with PNR if

the ticket number is unavailable

TICKETNUMBER AN13 R 0741243235556

PNR Passenger name record AN6 O

ETICKETINDICATOR E for eTicket AN1 O E

Ingenico document - Reproduction or disclosure prohibited without written authorization

138
l ET=ETicket

l CTO=City Ticket Office

TICKETDELIVERYMETHOD l ATO=Airport Ticket Office AN3 O ET

l TBM=Ticket By Mail

l TOD=Ticket On Departure

POINTOFSALE IATA point of sale name AN25 O –

Place of issue

For sales in the US, the last two characters (pos 14–15) must be US state code

PLACEOFISSUE AN15 O –

PASSENGERNAME Name of passenger AN49 R Johan Cruijff

FLIGHTDATE Date of the Flight CCYYMMDD N8 O 20141231

ISTHIRDPARTY Is the payer the ticket holder AN5 O T

Key Definition Type Req Example

(T/F)

ISREGISTEREDCUSTOM Identifies a known consumer (T/F) AN5 O T

POSCITYCODE This is the city code point of sale AN10 O AMS

Consumer reference used when searching the Ingenico ePayments interface

CUSTOMERID AN16 O 14

This is the date of issue recorded in the airline system

In a case of multiple issuances of the same ticket to a cardholder, the merchant should use the
last ticket date

Format: YYYYMMDD

ISSUEDATE is required for Elavon

ISSUEDATE and RESTRICTEDTICKET are

required for PayPal

ISSUEDATE N8 O 20090402

Airline data restricted ticket (non-refundable)

l 0=No restrictions, the ticket is (partially) refundable

l 1=Restricted, the ticket is

non-refundable

ISSUEDATE and RESTRICTEDTICKET are

RESTRICTEDTICKET required for PayPal N1 O 0

FLIGHTLEGS Marker (no key) – O If flight legs are

present

... flight legs... – – –

ENDFLIGHTLEGS Marker (no key) – O –

ENDAIRLINEDATA Marker (no key) – O –

PAYMENT Marker (no key) – O –

… payment details... – O –

ENDPAYMENT Marker (no key) – O –

RISKASSESSMENT Marker (no key) – R –

Ingenico document - Reproduction or disclosure prohibited without written authorization

139
Indicates which services are to be executed—Comma separated list

l C=Country IP check (Quova)

l V=Bank Account Validation

SERVICES l D=Direct debit fraud check (Intercard) AN R C,D

Key Definition Type Req Example

l R=Credit card fraud check (RetailDecisions)

ENDRISKASSESSMENT Marker (no key) – R –

FRAUDFIELDS Marker (no key) – O –

EBT_USER_DATA1 AN256 O

EBT_USER_DATA2 AN256 O

EBT_USER_DATA3 AN256 O

EBT_USER_DATA4 AN256 O

EBT_USER_DATA5 AN256 O

EBT_USER_DATA6 AN256 O

EBT_USER_DATA7 AN256 O

EBT_USER_DATA8 AN256 O

EBT_USER_DATA9 AN256 O

EBT_USER_DATA10 AN256 O

EBT_USER_DATA11 AN256 O

EBT_USER_DATA12 AN256 O

EBT_USER_DATA13 AN256 O

EBT_USER_DATA14 AN256 O

EBT_USER_DATA15 AN256 O

EBT_USER_DATA16 AN256 O

Specifies if the consumer enters a password to gain access to an account registered with the merchant

These values only

l Y=Yes

l N=No

EBT_PASSWORD AN1 O Y

Specifies if the consumer has a history of online shopping with the merchant

These values only

l Y=Yes

EBT_PREVCUST l N=No AN1 O Y

Gift card type These values only

l 1=Celebrate Fall

l 2=Grandparent's Day l 4=Independence Day l A=Anniversary

l B=Birthday

l C=Congratulations l D=April Fool's Day l E=Easter

EBGIFTCARDTYPE l F=Father's Day AN1 O W

Ingenico document - Reproduction or disclosure prohibited without written authorization

140
Key Definition Type Req Example

l G=Graduation

l H=Holiday

l I=Season's Greetings

l J=Passover

l K=Kwanzaa

l L=Halloween

l M=Mother's Day

l N=New Year's Day

l O=Bosses' Day

l P=St. Patrick's Day

l Q=Sweetest Day

l R=Christmas

l S=Baby Shower l T=Thanksgiving l U=Other

l V=Valentine's Day

l W=Wedding

l X=Secretary's Day

l Y=Chinese New Year

l Z=Hanukkah

EBGIFTMESSAGE AN160 O

EBSHIPCOMMENTS AN160 O

EBWEBSITE The website from which the purchase is made AN60 O https://www.yourwebsite.com

ENDFRAUDFIELDS Marker (no key) – O –

ENDPARAMS Marker (no key) – R –

For each flight leg

Key Definition Type Req Example

FLIGHTLEG Marker (no key) – O –

LEGNUMBER Sequence of flight leg number N5 R 1

LEGDATE Date of the leg CCYYMMDD D8 R 20141231

ORIGINAIRPORT Origin airport/city code AN3 R AMS

ARRIVALAIRPORT Arrival airport/city code AN3 R LAX

l O or blank=stopover permitted

l X=stopover not permitted

STOPOVERCODE STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are AN1 O

required for PayPal

AIRLINECLASS Reservation Booking Designator AN2 R 1

CARRIERCODE IATA carrier code AN2 R KL

FAREBASIS Fare Basis/Ticket Designator AN15 O INTERNET

The flight number assigned by the airline carrier with no leading spaces

FLIGHTNUMBER STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are AN5 O 791

required for PayPal

The departure time in local time at the departure airport

DEPARTURETIME Format: HH:MM AN6 O 17:59

Ingenico document - Reproduction or disclosure prohibited without written authorization

141
Key Definition Type Req Example

STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are

required for PayPal

ENDFLIGHTLEG Marker (no key) – O –

For payment in general

Key Definition Type Req Example

PAYMENT Marker (no key) – R –

PROFILETOKEN Token provided by merchant AN40 O af16af70-2bf5-44e9-a087-

68c87f67e3a1

Amount to be paid

AMOUNT AMOUNT and CURRENCYCODE are required for RetailDecisions, optional N12 R 29990
otherwise

ISO 4217 currency code

CURRENCYCODE AMOUNT and CURRENCYCODE are required for RetailDecisions, optional AN3 R USD
otherwise

LANGUAGECODE ISO 639 language code for consumer AN2 O en

COUNTRYCODE ISO 3166 country code of consumer AN2 R US

... < payment method dependent keys > – R –

... < see the appropriate table in INSERT_ ORDERWITHPAYMENT or DO_PAYMENT> – R –

ENDPAYMENT Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

ORDERID Unique order ID generated by Ingenico ePayments N10 9998890004

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

FRAUD Marker (no key) – –

SERVICE Marker (no key) – Multiple instances possible

The Risk Services code

l C=Country IP check (Quova)

SERVICECODE l V=Bank Account Validation AN2 R

l D=Direct debit fraud check (Intercard)

l R=Credit card fraud check (RetailDecisions)

l A=Accepted, no fraud suspected

l C=Challenged

SERVICERESULT l E=Error AN1 D

l D=Denied (fraud suspected)

l N=No advice/no fraud score (possible)

Ingenico document - Reproduction or disclosure prohibited without written authorization

142
Key Definition Type Example

DETAILS Marker (no key) – Supplied only if applicable

… service details … – –

ENDDETAILS Marker (no key) – –

ENDSERVICE Marker (no key) – –

ENDFRAUD Marker (no key) – –

The direct debit fraud check does not return any details. For the other risk services, the details that return are explained here.

County IP check (Quova)—C

Key Definition Type Example

CITY City AN4000 amsterdam

COUNTRY ISO country code AN2 nl

STATE US state abbreviation or international state name AN4000 noord-holland

IPROUTINGTYPE Only given if satellite or anonymizer AN4000 satellite

Credit card fraud check (RetailDecisions)—R

Key Definition Type Example

FRAUDCODE Result of the fraud service AN4 0000

FRAUDNEURAL Result of the fraud service AN4 150

FRAUDRCF Result of the fraud service AN400 GEO, TUMBLES, PHONEVEL, HIGHUSE

Bank account validation—V

Key Definition Type Example

REFBANKCODE Reformatted bank code according to local clearing rules AN15 150000

REFBRANCHCODE Reformatted branch code according to local clearing rules AN15 1234

REFACCOUNTNUMBER Reformatted account number according to local clearing AN30 12345679

rules

NEWBANKNAME Bank name returned matching the bank code of the AN40 BARCLAYS BANK PLC
request

CHECKSPERFORMED Marker (no key) – –

CHECK Marker (no key) – Multiple instances possible

CHECKCODE Code of the validation check N4 For a complete list per country, see the WebCollect error codes
guide

Result of the check performed

l PASSED

CHECKRESULT l ERROR AN10 PASSED

l WARNING

l NOTCHECKED

ENDCHECK Marker (no key) – –

ENDCHECKSPERFORMED Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

143
Example

<XML>

<ACTION>DO_RISKASSESSMENT</ACTION>

<META>

</META>

<ORDER>

<SURNAME>Smith</SURNAME>

<STREET>1 Main St.</STREET>

<CITY>Burlington</CITY>

</ORDER>

</PAYMENT>

</RISKASSESSMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>DO_RISKASSESSMENT</ACTION>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

144
<IPADDRESS>20.60.98.38</IPADDRESS>

</META>

<ORDER>

<SURNAME>Smith</SURNAME>

<STREET>1 Main St.</STREET>

<CITY>Burlington</CITY>

</ORDER>

</PAYMENT>

</RISKASSESSMENT>

</PARAMS>

<META>

</META>

<FRAUD>

</SERVICE>

Ingenico document - Reproduction or disclosure prohibited without written authorization

145
</FRAUD>

</RESPONSE>

</REQUEST>

</XML>

Example—Request for country IP check and credit card fraud check

<XML>

<ACTION>DO_RISKASSESSMENT</ACTION>

<META>

</META>

<ORDER>

<EMAIL>[email protected]</EMAIL>

<SURNAME>Cruijff</SURNAME>

<FIRSTNAME>Jopie</FIRSTNAME>

<CITY>Barcelona</CITY>

<STATE>Catalunia</STATE>

</ORDER>

Ingenico document - Reproduction or disclosure prohibited without written authorization

146
<CREDITCARDNUMBER>4567350000427977</CREDITCARDNUMBER>

</PAYMENT>

</RISKASSESSMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>DO_RISKASSESSMENT</ACTION>

<META>

</META>

<ORDER>

<EMAIL>[email protected]</EMAIL>

<SURNAME>Cruijff</SURNAME>

<FIRSTNAME>Jopie</FIRSTNAME>

<CITY>Barcelona</CITY>

Ingenico document - Reproduction or disclosure prohibited without written authorization

147
</ORDER>

</PAYMENT>

</RISKASSESSMENT>

</PARAMS>

<META>

</META>

<FRAUD>

</DETAILS>

</SERVICE>

<CITY>amsterdam</CITY>

<STATE>noord-holland</STATE>

</DETAILS>

</SERVICE>

</FRAUD>

</RESPONSE>

Ingenico document - Reproduction or disclosure prohibited without written authorization

148
</REQUEST>

</XML>

Example—Request for direct debit fraud check and bank account validation
<XML>

<ACTION>DO_RISKASSESSMENT</ACTION>

<META>

</META>

<ORDER>

<EMAIL>[email protected]</EMAIL>

<SURNAME>Cruijff</SURNAME>

<FIRSTNAME>Jopie</FIRSTNAME>

<CITY>Barcelona</CITY>

<STATE>Catalunia</STATE>

</ORDER>

<BANKNAME>Caixa</BANKNAME>

<ACCOUNTNAME>Cruijff</ACCOUNTNAME>

Ingenico document - Reproduction or disclosure prohibited without written authorization

149
<COUNTRYCODEBANK>DE</COUNTRYCODEBANK>

</PAYMENT>

</RISKASSESSMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>DO_RISKASSESSMENT</ACTION>

<META>

</META>

<ORDER>

<EMAIL>[email protected]</EMAIL>

<SURNAME>Cruijff</SURNAME>

<FIRSTNAME>Jopie</FIRSTNAME>

<CITY>Barcelona</CITY>

<STATE>Catalunia</STATE>

</ORDER>

Ingenico document - Reproduction or disclosure prohibited without written authorization

150
<PAYMENT>

<BANKNAME>Caixa</BANKNAME>

<ACCOUNTNAME>Cruijff</ACCOUNTNAME>

</PAYMENT>

</RISKASSESSMENT>

</PARAMS>

<META>

</META>

<FRAUD>

</SERVICE>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

Ingenico document - Reproduction or disclosure prohibited without written authorization

151
<CHECKCODE>0050</CHECKCODE>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>WARNING</CHECKRESULT>

</CHECK>

<CHECK>

Ingenico document - Reproduction or disclosure prohibited without written authorization

152
<CHECKCODE>0120</CHECKCODE>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

<CHECK>

<CHECKRESULT>PASSED</CHECKRESULT>

</CHECK>

</CHECKSPERFORMED>

</DETAILS>

</SERVICE>

</FRAUD>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

153
DO_VALIDATE
This API call performs an authentication validation attempt for online credit cards. The do validate structure is

REQUEST ACTION META PARAMS

PAYMENT

Input keys

Key Definition Type Req Example

ACTION DO_VALIDATE AN R DO_VALIDATE

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – – –

PAYMENT Marker (no key) – – –

ORDERID Order Identification N10 R 9998890004

EFFORTID Payment effort number (from first Do Payment) N5 R 00001

(Default=1)

SURNAME Last name of Cardholder AN35 O Buuren

ATTEMPTID Payment attempt number (from first Do Payment) N5 R 00001

The signed PaRes message from the issuing bank

SIGNEDPARES Determines if a Validate Authentication is done AN R –

Indicates if the authorization should be executed—Can be used to overrule merchant-level

configuration

l 0=Authorization only
AUTHENTICATIONINDICATOR N1 O 1
l 1=Continue if possible

l 2=Validation only

ENDPAYMENT Marker (no key) – – –

ENDPARAMS Marker (no key) – – –

Additional for EMV 3DS (aka 3D v2)

Key Definition Type Req Example

PAYMENT MARKER (NO KEY) - R -

CHALLENGERESPONSEDATA Challenge response received from ACS in base64 encoded form AN5000 O

THREEDSSERVERTRANSACTIONID 3ds server transaction id (send by DO_PAYMENT/IOWP response) AN36 O

ENDPAYMENT MARKER (NO KEY) - R -

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Ingenico document - Reproduction or disclosure prohibited without written authorization

154
Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

Key Definition Type Example

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

STATUSID Status N5 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

PAYMENTREFER Reference given by Ingenico ePayments to payment AN12 Returned after authorization
ENCE

ADDITIONALREFE AN20
RENCE

External Reference of credit card payment—Should be used as REFERENCEORIGPAYMENT in

eventual refunds (see DO_REFUND)
EXTERNALREFER AN30 00000000010000212121000010
ENCE 0001

AVSRESULT Result of the AVS service AN1 Z

CVVRESULT Result of the CVV2/CVC2 service AN1 M

FRAUDRESULT Result of the fraud service AN1 D

FRAUDCODE Result of the fraud service AN4 0000

FRAUDNEURAL Result of the fraud service AN4 150

FRAUDRCF Result of the fraud service AN4 GEO, TUMBLES, PHONEVEL,

00 HIGHUSE

321234

AUTHORISATION Authorization code AN10 Returned optionally after

CODE authorization

Electronic Commerce Indicator provides authentication validation results returned after

AUTHENTICATIONVALIDATION

l 0=Failed authentication (no liability shift)

l 01=Incomplete authentication (MasterCard)

l 02=Successful authentication

(MasterCard)

l 05=Successful authentication (Visa, Diners Club)

l 06=Authentication attempted (Visa)

l 07=Failed authentication (no liability shift)

l (empty)=Not checked or not enrolled, but attempt made (MasterCard)

If Elavon is the acquirer, these ECI values apply

l 06=Authentication attempted (Visa, MasterCard, Maestro)

l 02=Successful authentication
ECI N1 Returned after
(MasterCard, Maestro) AuthenticationValidation

l 05=Successful authentication (Visa, Diners Club)

l 07=Internet (not a 3D Secure transaction)

CAVV CAVV or AVV result Returned after valid

AuthenticationValidation
Indicates Authentication validation value AN50

ENDROW Marker (no key) – –

Additional for EMV 3DS (aka 3D v2)

Key Definition Type Example

ROW MARKER (NO KEY) -

CUSTOMERTHREEDMETHOD CardHolder 3D authentication method N2

CUSTOMERTHREEDDATE CardHolder 3D authentication timestamp N12

CUSTOMERTHREEDREF CardHolder 3D authentication reference AN36 -

Ingenico document - Reproduction or disclosure prohibited without written authorization

155
THREEDSSERVERTRANSACTIONID 3ds server transaction id (send by DO_PAYMENT/IOWP response) AN36

ACSTRANSACTIONID Universally Unique transaction identifier assigned by the ACS to identify a single transaction. AN36

ENDROW MARKER (NO KEY)

Example

<XML>

<ACTION>DO_VALIDATE</ACTION>

<META>

</META>

<SIGNEDPARES>123432kjvdhasiyfdiasyi23u4h2452g</ SIGNEDPARES >

<AUTHENTICATIONINDICATOR>1</ AUTHENTICATIONINDICATOR >

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response with valid authentication and authorization

<XML>

<ACTION>DO_VALIDATE</ACTION>

<META>

</META>

<SIGNEDPARES>123432kjvdhasiyfdiasyi23u4h2452g</ SIGNEDPARES >

Ingenico document - Reproduction or disclosure prohibited without written authorization

156
<AUTHENTICATIONINDICATOR>1</ AUTHENTICATIONINDICATOR >

</PAYMENT>

</PARAMS>

<META>

</META>

<ROW>

<FRAUDCODE>0000</FRAUDCODE

<CAVV>33240a04aa06dfsafdfas29092fsdaf555</CAVV>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Possible response with valid authentication and no authorization

<XML>

<ACTION>DO_VALIDATE</ACTION>

<META>

</META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

157
<PARAMS>

<SIGNEDPARES>123432kjvdhasiyfdiasyi23u4h2452g</SIGNEDPARES>

</PAYMENT>

</PARAMS>

<META>

</META>

<ROW>

<CAVV>33240a04aa06dfsafdfas29092fsdaf555</CAVV>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Possible response with invalid authentication

<XML>

<ACTION>DO_VALIDATE</ACTION>

<META>

</META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

158
<PAYMENT>

<SIGNEDPARES>123432kjvdhasiyfdiasyi23u4h2452g</SIGNEDPARES>

</PAYMENT>

</PARAMS>

<META>

</META>

<ERROR>

<MESSAGE>REQUEST 2 INVALID PARES</MESSAGE>

</ERROR>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

159
GET_BANKDETAILS
This API call converts and compares bank details such as BBAN and IBAN information. This API call provides three possible results

l Conversion of BBAN to IBAN

l Conversion of IBAN to BBAN

l Comparison of IBAN and BBAN The get bank details structure is

REQUEST ACTION META PARAMS

GENERAL

List of European IBAN parameters by country

Country Length Example

Andorra AN24 AD12 00012030200359100100

Austria AN20 AT611904300235473201

Belgium AN16 BE68539007547034

Bosnia and Herzegovina AN 20 BA391290079401028494

Bulgaria AN 22 BG80BNBG96611020345678

Croatia AN 21 HR1210010051863000160

Cyprus AN 28 CY17002001280000001200527600

Czech Republic AN 24 CZ6508000000192000145399

Denmark AN 18 DK5000400440116243

Estonia AN 20 EE382200221020145685

Finland AN 18 FI2112345600000785

Faeroe Islands AN 18 FO1464600009692713

France AN 27 FR1420041010050500013M02606

Germany AN 22 DE89370400440532013000

Gibraltar AN 23 GI75NWBK000000007099453

Greece AN 27 GR1601101250000000012300695

Greenland AN 18 GL8964710001000206

Hungary AN 28 HU42117730161111101800000000

Iceland AN 26 IS140159260076545510730339

Ireland AN 22 IE29AIBK93115212345678

Italy AN 27 IT60X0542811101000000123456

Latvia AN 21 LV80BANK0000435195001

Liechtenstein AN 21 LI21088100002324013AA

Lithuania AN 20 LT121000011101001000

Luxembourg AN 20 LU280019400644750000

Macedonia AN 19 MK07300000000042425

Malta AN 31 MT84MALT011000012345MTLCAST001S

Ingenico document - Reproduction or disclosure prohibited without written authorization

160
Country Length Example

Monaco AN 27 MC5813488000010051108001292

Montenegro AN 22 ME25505000012345678951

The Netherlands AN 18 NL91ABNA0417164300

Norway AN 15 NO9386011117947

Poland AN 28 PL27114020040000300201355387

Portugal AN 25 PT50000201231234567890154

Romania AN 24 RO49AAAA1B31007593840000

Serbia AN 22 RS35260005601001611379

Slovakia AN 24 SK3112000000198742637541

Slovenia AN 19 SI56191000000123438

Spain AN 24 ES9121000418450200051332

Sweden AN 24 SE3550000000054910000003

Switzerland AN 21 CH9300762011623852957

United Kingdom AN 22 GB29NWBK60161331926819

Mauritius AN 30 MU17 BOMM 0101 1010 3030 0200 000M UR

Tunisia AN 24 TN5914207207100707129648

Input keys

Key Definition Type Req Example

ACTION GET_BANKDETAILS AN R GET_BANKDETAILS

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

GENERAL Marker (no key) – R –

International bank account number

IBAN IBAN or ACCOUNTNUMBER is required AN50 R NL91ABNA0417164300

Sets the account number to be validated

ACCOUNTNUMBER IBAN or ACCOUNTNUMBER is required AN30 R 12345678A2

Sets the bank code to be validated

BANKCODE, BRANCHCODE, and

BANKCODE BANKCHECKDIGIT are required for some countries if ACCOUNTNUMBER is given AN15 R 200000

Sets the branch code to be validated

BANKCODE, BRANCHCODE, and

BRANCHCODE BANKCHECKDIGIT are required for some countries if ACCOUNTNUMBER is given AN15 R 12345

Sets the check digit to be validated

BANKCHECKDIGIT BANKCODE, BRANCHCODE, and AN2 R 1

BANKCHECKDIGIT are required for some countries if

Ingenico document - Reproduction or disclosure prohibited without written authorization

161
Key Definition Type Req Example

ACCOUNTNUMBER is given

COUNTRYCODEBANK ISO 3166 Country code where bank account is held AN2 R DE

ENDGENERAL Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 NOK

META Marker (no key) – –

REQUESTID Internal ID of request N20 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ERROR Marker (no key) – Multiple instances possible

Code of the syntax or system error

CODE No keys are communicated for empty keys in the response N10 500123

Clarifying message to previous error code

MESSAGE No keys are communicated for empty keys in the response AN4000 Account number exceeds maximum length

ENDERROR Marker (no key) – –

IBAN Marker (no key) if BBAN and no IBAN in input – –

IBAN International Bank Account Number AN50 –

ENDIBAN Marker (no key) – –

BBAN Marker (no key) if IBAN and no BBAN in input – –

ACCOUNTNUMBER Account number – –

BANKCODE Bank code/bankleithzahl/sorting code – –

BRANCHCODE Branch code – –

BANKCHECKDIGIT Check digit(s) – –

ENDBBAN Marker (no key) – –

BANKDATA Marker (no key) if valid IBAN or BBAN and bank data present – –

REFBANKCODE Reformatted bank code according to local clearing rules AN15 150000

REFBRANCHCODE Reformatted branch code according to local clearing rules AN15 1234

REFACCOUNTNUMBER Reformatted account number according to local clearing rules AN30 12345679

NEWBANKNAME Bank Name returned matching the bank code of the request AN40 BARCLAYS BANK PLC

ENDBANKDATA Marker (no key) – –

SWIFT Marker (no key) if valid IBAN or BBAN and swift data present – –

Key Definition Type Example

BIC Swift BIC – –

CHIPSUID CHIPSUID – –

POBOXNUMBER PO Box number – –

POBOXZIP PO Box ZIP – –

POBOXLOCATION PO Box location – –

POBOXCOUNTRY PO Box country – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

162
CATEGORY Swift category – –

EXTRAINFO Swift EXTRAINFO – –

ROUTINGBIC Swift Routing BIC – –

ENDSWIFT Marker (no key) if valid IBAN or BBAN – –

Examples

Convert BBAN to IBAN

<XML>

<ACTION>GET_BANKDETAILS</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

</REQUEST>

</XML>

Possible OK response
<XML>

<ACTION>GET_BANKDETAILS</ACTION>

<META>

</META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

163
<COUNTRYCODEBANK>DE</COUNTRYCODEBANK>

</GENERAL>

</PARAMS>

<META>

</META>

<SWIFT>

<SERVICES>FINTG+</SERVICES>

<BIC>PBNKDEFF100</BIC>

<ROUTINGBIC>PBNKDEFF100</ROUTINGBIC>

<POBOXCOUNTRY>Germany</POBOXCOUNTRY>

</SWIFT>

</BANKDATA>

<IBAN>

</IBAN>

</RESPONSE>

</REQUEST>

</XML>

Possible NOK response

<XML>

<ACTION>GET_BANKDETAILS</ACTION>

<META>

</META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

164
<COUNTRYCODEBANK>DE</COUNTRYCODEBANK>

</GENERAL>

</PARAMS>

<META>

</META>

<ERROR>

<MESSAGE>REQUEST 7617 INVALID BANK DATA: {Modulus check has failed}</MESSAGE>

</ERROR>

</RESPONSE>

</REQUEST>

</XML>

Convert IBAN to BBAN

<XML>

<ACTION>GET_BANKDETAILS</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

</REQUEST>

</XML>

Possible OK response
<XML>

<ACTION>GET_BANKDETAILS</ACTION>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

165
<MERCHANTID>9945</MERCHANTID>

</META>

</GENERAL>

</PARAMS>

<META>

</META>

<SWIFT>

<SERVICES>FINTG+</SERVICES>

<BIC>PBNKDEFF100</BIC>

<ROUTINGBIC>PBNKDEFF100</ROUTINGBIC>

<POBOXCOUNTRY>Germany</POBOXCOUNTRY>

</SWIFT>

<BBAN>

</BBAN>

</BANKDATA>

</RESPONSE>

</REQUEST>

</XML>

Possible NOK response

<XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

166
<REQUEST>

<ACTION>GET_BANKDETAILS</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

<META>

</META>

<ERROR>

<MESSAGE>REQUEST 7619 INVALID IBAN DE7510010010111111111</MESSAGE>

</ERROR>

</RESPONSE>

</REQUEST>

</XML>

Compare IBAN and BBAN

<XML>

<ACTION>GET_BANKDETAILS</ACTION>

<META>

</META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

167
<COUNTRYCODEBANK>GB</COUNTRYCODEBANK>

</GENERAL>

</PARAMS>

</REQUEST>

</XML>

Possible OK response
<XML>

<ACTION>GET_BANKDETAILS</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

<META>

</META>

<SWIFT>

<SERVICES>FINTG+</SERVICES>

<BIC>PBNKDEFF100</BIC>

<ROUTINGBIC>PBNKDEFF100</ROUTINGBIC>

<POBOXCOUNTRY>Germany</POBOXCOUNTRY>

</SWIFT>

Ingenico document - Reproduction or disclosure prohibited without written authorization

168
<BBAN>

</BBAN>

</BANKDATA>

</RESPONSE>

</REQUEST>

</XML>

Possible NOK response

<XML>

<ACTION>GET_BANKDETAILS</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

<META>

</META>

<ERROR>

<MESSAGE>REQUEST 7620 IBAN COUNTRYCODEBANK DE DOES NOT MATCH BBAN COUNTRYCODEBANK GB</MESSAGE>

</ERROR>

Ingenico document - Reproduction or disclosure prohibited without written authorization

169
</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

170
GET_DIRECTORY
This API call retrieves a directory list. For payment products such as iDEAL (809) a list of available issuing banks is returned.

The get directory structure is REQUEST

ACTION META PARAMS

GENERAL

Input keys

Key Definition Type Req Example

ACTION GET_DIRECTORY AN R GET_ DIRECTORY

META Marker (no key) – R –

MERCHANTID ID for merchant (given by Ingenico ePayments) N10 R 1

IP Address the request comes from

IPADDRESS This is verified with the configured addresses at Ingenico ePayments AN32 O 123.123.123.123

VERSION Version of XML interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

GENERAL Marker (no key) – R –

PAYMENTPRODUCTID Payment product identifier N10 R 809

COUNTRYCODE ISO 3166 country code of consumer AN2 R NL

CURRENCYCODE ISO 4217 currency code AN3 R EUR

ENDGENERAL Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT Result of the action AN3 OK or NOK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

Key Definition Type Example

ROW Marker (no key) – –

ISSUERID The unique Ingenico ePayments ID for the issuing bank AN11

ISSUERNAME Name of issuer to present to consumer—As listed in the stored directory information –

Used in the issuer presentation The short-list banks appear first

l Short

ISSUERLIST l Long AN5 Short

COUNTRYNAMES Name of the country for which the ISSUERID is valid AN35 –

ENDROW Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

171
Example
<XML>

<ACTION>GET_DIRECTORY</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>GET_DIRECTORY</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

172
<REQUESTID>3981654</REQUESTID>

</META>

<ROW>

<ISSUERID>ABNANL2A</ISSUERID>

<ISSUERNAME>ABN AMRO Bank</ISSUERNAME>

<ISSUERLIST>Short</ISSUERLIST>

<COUNTRYNAMES>Nederland</COUNTRYNAMES>

</ROW>

<ROW>

<ISSUERID>ABNANL21</ISSUERID>

<COUNTRYNAMES>Nederland</COUNTRYNAMES>

</ROW>

<ROW>

<ISSUERID>FRBKNL2L</ISSUERID>

<ISSUERNAME>Friesland Bank</ISSUERNAME>

<ISSUERLIST>Short</ISSUERLIST>

<COUNTRYNAMES>Nederland</COUNTRYNAMES>

</ROW>

<ROW>

<ISSUERID>RABONL2U</ISSUERID>

<ISSUERNAME>Rabobank</ISSUERNAME>

<ISSUERLIST>Short</ISSUERLIST>

<COUNTRYNAMES>Nederland</COUNTRYNAMES>

</ROW>

<ROW>

<ISSUERID>BRBNL21</ISSUERID>

<ISSUERNAME>RegioBank</ISSUERNAME>

<COUNTRYNAMES>Nederland</COUNTRYNAMES>

</ROW>

<ROW>

<ISSUERID>SNSBNL2A</ISSUERID>

<ISSUERLIST>Short</ISSUERLIST>

<COUNTRYNAMES>Nederland</COUNTRYNAMES>

</ROW>

<ROW>

<ISSUERID>TRIONL2U</ISSUERID>

<ISSUERNAME>Triodos Bank</ISSUERNAME>

Ingenico document - Reproduction or disclosure prohibited without written authorization

173
<COUNTRYNAMES>Nederland</COUNTRYNAMES>

</ROW>

<ROW>

<ISSUERID>FVLBNL22</ISSUERID>

<ISSUERNAME>Van Lanschot Bankiers</ISSUERNAME>

<COUNTRYNAMES>Nederland</COUNTRYNAMES>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

174
GET_ORDER
This API call verifies the existence of an order. The REF and MAC are returned and allow you to redirect the consumer to the payment pages to retry
the payment action.

The get order structure is REQUEST

ACTION META PARAMS

ORDER

Input keys

Key Definition Type Req Example

ACTION GET_ORDER

META Marker (no key) – R –

MERCHANTID ID for merchant (given by Ingenico ePayments) N10 R 1

IP Address the request comes from

IPADDRESS This is verified with the configured addresses at Ingenico ePayments AN32 O 123.123.123.123

VERSION Version of XML interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

ORDER Marker (no key) – R –

ORDERID Unique ID for order N10 R 9998890004

For recurring payments, the number of the failed payment

EFFORTID Default=1 N5 R 1

ENDORDER Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT Result of the action AN3 OK or NOK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

RESPONSEDATETIME Date and time of response N14 20130604123456

Key Definition Type Example

Format: YYYYMMDDHHMMSS

ROW Marker (no key) – –

REF Reference number for redirecting the consumer AN50 000001323100000220100005

MAC Signature for redirecting the consumer AN512 1212safdasdf923742nsdlf90823na

ENDROW Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 100400

MESSAGE Message for error or event AN4000 REQUEST DID NOT HAVE A UNIQUE ORDERID

ENDERROR Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

175
Example

<XML>

<ACTION>GET_ORDER</ACTION>

<META>

</META>

<ORDER>

</ORDER>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>GET_ORDER</ACTION>

<META>

</META>

<ORDER>

</ORDER>

</PARAMS>

<META>

</META>

<ROW>

Ingenico document - Reproduction or disclosure prohibited without written authorization

176
<MAC>mjT4OH3WHK8i86DjM+B/XqkF/MQ=</MAC>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

177
GET_ORDERSTATUS
This API call retrieves the status of and additional information of a payment request for an outstanding order. This API call returns a different
response depending on the version number in the request.

The get order status structure is

REQUEST ACTION META PARAMS

ORDER

Input keys

Key Definition Type Req Example

ACTION GET_ORDERSTATUS AN R GET_

ORDERSTATUS

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 2.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

ORDER Marker (no key) – R –

Order ID

ORDERID is required for GET_ORDERSTATUS v1.0

ORDERID Either ORDERID or MERCHANTORDERID (at least one of them) is required for N10 R 9998890004
GET_ORDERSTATUS v2.0

Order ID generated by the merchant

MERCHANTORDERID Either ORDERID or MERCHANTORDERID (at least one of them) is required for N10 R 1234567899
GET_ORDERSTATUS v2.0

EFFORTID The payment number—Useful in the case of a recurring payment or a refund N5 O 1

Key Definition Type Req Example

Unique reference of merchant for payment

MERCHANTREFERENCE allowed input is ASCII 32–126 characters—Do not include trailing spaces in the
MERCHANTREFERENCE
MERCHANTREFERE N10 O 12345678
NCE 99

ENDORDER Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys version 2.0

Key Definition Ty Example

RESULT OK or NOK AN OK
10

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATE Format: YYYYMMDDHHMMSS N14 20130604123456

TIME

ENDMETA Marker (no key) – –

STATUS Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

178
MERCHANTID ID of Merchant N10 1

ORDERID Unique order ID generated by Ingenico ePayments N10 9998890004

MERCHANTORDE Order ID generated by the merchant N10 1234567899

RID

EFFORTID Last Effort ID N5 1

ATTEMPTID Attempt number N5 1

PAYMENTMETHO Payment method ID N5 1 (=Online CC)

DID

PAYMENTPRODU Payment product identifier N5 1 (=VISA)

CTID

PAYMENTREFER Reference given by Ingenico ePayments to payment AN 123400001021

ENCE 12

Unique reference of merchant for payment

MERCHANTREFERENCE allowed input is ASCII 32–126 characters—Do not include trailing spaces
in the MERCHANTREFERENCE
MERCHANTREFE AN 2121212
RENCE 50

STATUSID Status N5

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

CURRENCYCODE ISO 4217 currency code AN3 EUR

MANDATEID Mandate identifier for this transaction AN In returns for SEPA direct debit
35 transactions

PROFILETOKEN Profile token for this transaction AN In returns for SEPA direct debit
40 transactions

AMOUNT Amount N12 29990

TOTALAMOUNTP Total paid amount N12 29990

AID

FRAUDRESULT Result of the Fraud service—See the WebCollect error codes guide AN1 D

Key Definition Ty Example

FRAUDCODE Result of the Fraud service AN4 0000

FRAUDNEURAL Result of the Fraud service AN4 150

FRAUDRCF Result of the Fraud service AN GEO, TUMBLES, PHONEVEL,

400 HIGHUSE

AVSRESULT Result of the AVS service AN1 Z

CVVRESULT Result of the CVV2/CVC2 service AN1 M

321234 (returned optionally after

authorization)
AUTHORISATIONCODE Authorization code AN
10

SCHEMETRANSACTI Unique transaction identifier returned by Visa and Mastercard for Pre Authorization, Recurring AN AS37504079V1664
ONID and UCOF transactions 15

INITIALSCHEMETRAN The transaction ID given by Visa and Mastercard after the First Recurring/First UCOF/Pre AN MC1238743876289
SACTIONID Authorization 15

Ingenico document - Reproduction or disclosure prohibited without written authorization

179
Electronic Commerce Indicator provides authentication validation results returned after
AUTHENTICATIONVALIDATION

l 0=Failed authentication (no liability shift)

l 1=Incomplete authentication (MasterCard) l 2=Successful authentication (MasterCard) l 0

5=Successful authentication (Visa, Diners

Club)

l 6=Authentication attempted (Visa)

l 7=Failed authentication (no liability shift)

l (empty)=Not checked or not enrolled, but attempt made (MasterCard)

If Elavon is the acquirer, these ECI values apply

l 6=Authentication attempted (Visa, MasterCard, Maestro)

l 2=Successful authentication (MasterCard,

ECI Maestro) N1 Returned after

AuthenticationValidation
l 5=Successful authentication (Visa, Diners Club)

l 7=Internet (not a 3D Secure transaction)

CAVV or AVV result Returned after valid Validation of

an Authentication
CAVV Indicates Authentication validation value AN
50

Returned after a valid Validation of

an Authentication
XID Transaction ID for the Authentication AN
50

CREDITCARDNUMBER Credit card number AN ************7977

EXPIRYDATE Expiry date AN4 1210

CUSTOMERACCOUNT Marker (no key) – –

Status of the third party consumer account returned with the name of the third party account
status—This key does not work with version 1.0
CUSTOMERACCOUN AN For PayPal, status is either
TSTATUS 40 verified or unverified

CUSTOMERADDRES
SSTATUS

ACCOUNTID

PAYERID

Key Definition Type Example

ACCOUNTHOLDERNAME Account holder name AN40 –

In returns for iDEAL (NL), Giropay (DE), and Sofortüberweisung (DE)

transactions
IBAN International bank account number of the AN50
consumer

In returns for iDEAL (NL), Giropay (DE), and Sofortüberweisung (DE)

transactions
BIC Bank identification code for the consumer AN11

ACCOUNTNUMBER Account number of the consumer AN40 –

BANKCODE Bank code AN15 –

BANKNAME Name of bank of the consumer AN40 –

BANKCITY City of bank of the consumer AN40 –

For Sofortüberweisung (payment product 836)

Returns a value of 0 or 1

If the security criterion is zero (No), wait for receipt of payment

Do not send the merchandise until then

SECURITYINDICATOR Security criteria AN1

ENDCUSTOMERACCOU Marker (no key) – –

ENDSTATUS Marker (no key) – –

ERRORS Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

180
ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 900040

MESSAGE Message for error or event AN4000 ORDERID NOT FOUND IN REQUEST

ENDERROR Marker (no key) – –

ENDERRORS Marker (no key) – –

Additional Return Keys for transaction processed with new EMV 3DS version of 3D
Key Definition Type Example

CUSTOMERTHREEDMETH CardHolder 3D authentication method N2 1

CUSTOMERTHREEDDATE CardHolder 3D authentication timestamp N12 format: YYYYMMDDHHMM

CUSTOMERTHREEDREF CardHolder 3D authentication reference AN36 A9885E27-797D-4726-BDE6-

18C502D62C04

THREEDSSERVERTRANS 3ds server transaction id (send by DO_PAYMENT/IOWP response) AN36 bfce9a80-7a8c-4081-acfd-

ACTIONID c08ac507443a

ACSTRANSACTIONID Universally Unique transaction identifier assigned by the ACS to identify a single AN36 A9885E27-797D-4726-BDE6-
transaction. 18C502D62C04

THREEDSMETHODURL ACS Method URL to redirect AN2 only available if the issuer sends it in
56 the response

THREEDSMETHODURLDA Contain data of 3DS Method Notification URL and ThreeDS Server tx id in base64 AN5 only available if the issuer sends it in
TA encoded format 000 the response

CARDHOLDERINFO Text provided by the ACS/Issuer to Cardholder during a Frictionless transaction that AN1 "Additional authentication is needed
was not authenticated by the ACS. 28 for this transaction"

DIRECTORYSERVERTRA Universally unique transaction identifier assigned by the Directory Server (schemes) AN36 f25084f0-5b16-4c0a-ae5d-
NSACTIONID to identify a single transaction b24808a95e4b

CREQ Base64 encoded Creq json data AN5 only available if the issuer asked for a
000 challenge

THREEDSPROTOCOLVER the most recent active protocol version that is supported by the Directory server AN8 2.1.0
SION

New EMV 3DS version Response XML Sample for Frictionless Transaction
<RESPONSE>
<RESULT>OK</RESULT>
<META>
<RESPONSEDATETIME>20190712122108</RESPONSEDATETIME>
<REQUESTID>302</REQUESTID>
</META>
<STATUS>
<STATUSDATE>20190712142108</STATUSDATE>
<FRAUDRESULT>N</FRAUDRESULT>
<THREEDSPROTOCOLVERSION>2.1.0</THREEDSPROTOCOLVERSION>
<PAYMENTREFERENCE>0</PAYMENTREFERENCE>
<CUSTOMERTHREEDDATE>201907121221</CUSTOMERTHREEDDATE>
<EXPIRYDATE>1219</EXPIRYDATE>
<CUSTOMERTHREEDREF>A9885E27-797D-4726-BDE6-18C502D62C04</CUSTOMERTHREEDREF>
<THREEDSSERVERTRANSACTIONID>bfce9a80-7a8c-4081-acfd-c08ac507443a</THREEDSSERVERTRANSACTIONID>
<ORDERID>8071</ORDERID>
<CREDITCARDNUMBER>************0026</CREDITCARDNUMBER>
<EFFORTID>1</EFFORTID>
<ECI>05</ECI>
<CVVRESULT>0</CVVRESULT>
<PAYMENTMETHODID>1</PAYMENTMETHODID>
<ATTEMPTID>1</ATTEMPTID>
<CUSTOMERTHREEDMETHOD>1</CUSTOMERTHREEDMETHOD>
<CAVV>AAABBEg0VhI0VniQEjRWAAAAAAA=</CAVV>
<AMOUNT>5000</AMOUNT>
<AVSRESULT>0</AVSRESULT>
<MERCHANTID>40104</MERCHANTID>
<DIRECTORYSERVERTRANSACTIONID>f25084f0-5b16-4c0a-ae5d-b24808a95e4b</DIRECTORYSERVERTRANSACTION
ID>
<STATUSID>600</STATUSID>
<ACSTRANSACTIONID>A9885E27-797D-4726-BDE6-18C502D62C04</ACSTRANSACTIONID>
<CURRENCYCODE>EUR</CURRENCYCODE>
<PAYMENTPRODUCTID>1</PAYMENTPRODUCTID>
</STATUS>
</RESPONSE>

Ingenico document - Reproduction or disclosure prohibited without written authorization

181
Example

<XML>

<ACTION>GET_ORDERSTATUS</ACTION>

<META>

</META>

<ORDER>

</ORDER>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>GET_ORDERSTATUS</ACTION>

<META>

</META>

<ORDER>

</ORDER>

</PARAMS>

<META>

</META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

182
<STATUSID>800</STATUSID>

</STATUS>

</RESPONSE>

</REQUEST>

</XML>

Example with possible response for PayPal

<XML>

<ACTION>GET_ORDERSTATUS</ACTION>

<META>

</META>

<ORDER>

</ORDER>

</PARAMS>

<META>

</META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

183
<STATUS>

<MERCHANTREFERENCE>PayPal payment 101</MERCHANTREFERENCE>

<CUSTOMERACCOUNTSTATUS>verified</CUSTOMERACCOUNTSTATUS>

</CUSTOMERACCOUNT>

</STATUS>

</RESPONSE>

</REQUEST>

</XML>

SELECT A.MERCHANTID, A.SERVICEPROVIDERID, A.MERCHANTNUMBER, B.MERCHANTNAME, B.ACCOUNTSTATUSID, C.CONTRACTID, C.

VALIDINDICATOR
FROM EPS.MRM_MERCHANTNUMBER A INNER JOIN EPS.MRM_MERCHANT B ON A.MERCHANTID = B.MERCHANTID INNER JOIN
EPS.MRM_CONTRACT C ON A.MERCHANTID = C.MERCHANTID

Ingenico document - Reproduction or disclosure prohibited without written authorization

184
GET_PAYMENTPRODUCTFIELDS
This API call returns the payment keys that are given for a specific payment product. The get payment product fields structure is

REQUEST ACTION META PARAMS

GENERAL

Input keys

Key Definition Type Req Example

ACTION GET_PAYMENTPRODUCTFIELDS AN R GET_PAYMENTPRODUCTFIELDS

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

GENERAL Marker (no key) – R –

PAYMENTPRODUCTID Payment product identifier N5 R See the WebCollect error codes guide

LANGUAGECODE ISO 639 Language code for result AN2 R en

ENDGENERAL Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

PAYMENTFIELDID Payment field ID N5 8010

FIELDNAME Name of payment key AN50 HOUSENUMBER

DESCRIPTION Description of payment key (label) AN –

12Text 3Number 93Date time

10000Short date (MMYY) 10001Credit card number 10003Country code 10004Currency code

10005Language code

DATATYPE Data type of the requested key N5

Ingenico document - Reproduction or disclosure prohibited without written authorization

185
Key Definition Ty Example
pe

10006Expiry date (MMYY)

10007email address 10008positive

amount 10009Sex

10010Date (YYYYMMDD)

10011Bank Code

10012Bank Name (ELV only)

10013Email Type

10097Binary (0=False/1=True)

DATALENGTH Length of number or string N5 –

DATAPRECISION Number of decimals (for numbers) N5 –

Editable by the consumer

EDITABLEINDICA l 0=No N1 0
TOR
l 1=Yes

Mandatory—This key should be interpreted as a bitmap

1st bit=The key required

5th bit=It can be left blank initially if HOSTEDINDICATOR=1

l 0 =No

l 1=Yes

l 17=Yes, but can be left empty if HostedMerchantLink is used—In this case, Ingenico
ePayments presents a page to collect this data
MANDATORYINDI N1 1
CATOR

Visual for consumer—This key should be interpreted as a bitmap

1st bit=The key required

5th bit=It can be left blank initially if HOSTEDINDICATOR=1

l 0=No

l 1=Yes

l 17=Yes, but can be left empty if HostedMerchantLink is used—In this case, Ingenico
ePayments presents a page to collect this data
PRESENCEINDIC N1 1
ATOR

Key should be delivered scrambled

SCRAMBLEDINDI l 0=No N1 0
CATOR

Key Definition Type Example

Source of key

l 0=Order—If no value is supplied in the payment request, the value from the order
request is used

l 1=Consumer
SOURCEINDICAT N1 1
OR l 3=Merchant-determined—usually based on consumer input

ENDROW Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 900060

Ingenico document - Reproduction or disclosure prohibited without written authorization

186
PAYMENTPRODUCTID NOT FOUND IN
REQUEST
MESSAGE Message for error or event AN40
00

ENDERROR Marker (no key) – –

Example

<XML>

<ACTION>GET_PAYMENTPRODUCTFIELDS</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>GET_PAYMENTPRODUCTFIELDS</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

Ingenico document - Reproduction or disclosure prohibited without written authorization

187
<META>

</META>

<ROW>

<FIELDNAME>CREDITCARDNUMBER</FIELDNAME>

<DESCRIPTION>Credit Card number</DESCRIPTION>

</ROW>

...

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

188
GET_PAYMENTPRODUCTS
This API call returns the possible payment products for a specific country code in a specific language. The get payment products structure is

REQUEST ACTION META PARAMS

GENERAL

Input keys

Key Definition Type Req Example

ACTION GET_PAYMENTPRODUCTS AN R GET_ PAYMENTPRODUCTS

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

Key Definition Type Req Example

GENERAL Marker (no key) – R –

LANGUAGECODE ISO 639 language code for the result AN2 R en

COUNTRYCODE ISO 3166 country code for which payment products should be retrieved AN2 R GB

CURRENCYCODE ISO 4217 currency code AN3 O EUR

Indicates if CURRENCYCODE filter is used to help determine the payment products to be used 0=CURRENCYCODE

Default=0—Filter is off, CURRENCYCODE filter is not used filter is off (default)

FILTERINDICATOR N1 O 1=CURRENCYCODE

filter is on

AMOUNT Amount of the order in cents in currency code provided (or when empty in the default currency EUR) N12 O 12000

Type of order

ORDERTYPE l 1=Normal order (default) N5 O 1

l 4=Variable amount recurring order

ENDGENERAL Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

189
PAYMENTMETHODNAME Name of payment method AN50 Credit Card

PAYMENTPRODUCTID Payment product identifier N5

PAYMENTPRODUCTNAME Name of payment product AN12 Visa

MINAMOUNT Minimal amount in cents in requested currency or if empty=EUR N12 500

MAXAMOUNT Maximum amount in cents in requested currency or if empty=EUR N12 500

CURRENCYCODE ISO 4217 currency code AN3 EUR

Types of orders the payment product is suitable for (bitmask)

l 1=Normal order (default)

l 4=Variable amount recurring order

ORDERTYPEINDICATOR l 5=Normal and variable recurring orders N5 1

l 7=All types of orders

ENDROW Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

Key Definition Type Example

CODE Error or event code N10 900100

MESSAGE Message for error or event AN4000 AMOUNT NOT FOUND IN REQUEST

ENDERROR Marker (no key) – –

Example

<XML>

<ACTION>GET_PAYMENTPRODUCTS</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>GET_PAYMENTPRODUCTS</ACTION>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

190
<MERCHANTID>1</MERCHANTID>

</META>

</GENERAL>

</PARAMS>

<META>

</META>

<ROW>

<PAYMENTMETHODNAME>Credit Card</PAYMENTMETHODNAME>

</ROW>

<ROW>

<PAYMENTMETHODNAME>Credit Card</PAYMENTMETHODNAME>

<PAYMENTPRODUCTNAME>American Express</PAYMENTPRODUCTNAME>

</ROW>

<ROW>

<PAYMENTMETHODNAME>Online Bank Transfer</PAYMENTMETHODNAME>

<PAYMENTPRODUCTNAME>NatWest</PAYMENTPRODUCTNAME>

</ROW>

...

</RESPONSE>

</REQUEST>

Ingenico document - Reproduction or disclosure prohibited without written authorization

191
</XML>

GET_PROFILE
This API call retrieves the details of a

l Mandate that must be printed and signed by the consumer for SEPA

l Profile for tokenization The get profile structure is

REQUEST ACTION META PARAMS

PROFILE

Input keys

Key Definition Type Req Example

REQUEST Marker (no key) – GET_PROFILE

ACTION GET_PROFILE AN R

META Marker (no key) – –

MERCHANTID ID for merchant (provided by Ingenico ePayments) N10 R 1

VERSION Version of XML interface AN10 R 1

ENDMETA Marker (no key) – –

PARAMS Marker (no key) – –

Key Definition Type Req Example

PROFILE Marker (no key) – –

PROFILETOKEN Token for payment profile AN40 R af16af70-2bf5-44e9-a087- 68c87f67e3a1

ENDPROFILE Marker (no key) – –

ENDPARAMS Marker (no key) – –

ENDREQUEST Marker (no key) – –

Return keys

Key Definition Type Example

RESPONSE Marker (no key) – –

Result of the action

RESULT l OK AN3 OK

l NOK

When OK

PROFILE Marker (no key) – –

IBAN International Bank Account Number AN50 NL39RABO0300065264

BIC Bank Identifier Code AN11 ABNANL2A

ENDPROFILE Marker (no key) – –

MANDATE Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

192
MANDATEID Unique mandate identifier AN35 1234567253

CUSTOMERCONTRACTIDENTIFIER Identifies the contract between customer and merchant AN35

Identifies the type of transaction that this specific mandate accepts for the SEPA direct
debit

l S=One-off

l F=First recurring
TRANSACTIONTYPE AN2 S
l R=Second and subsequent recurring

l L=Last recurring

Mandate name information

SURNAME Consumer last name AN70 Buuren

COMPANYNAME Consumer company AN50 Johnsons Ltd

FIRSTNAME Consumer first name AN15 Jack

PREFIXSURNAME Prefix of consumer last name AN15 Van

Mandate address information

CITY City of the consumer address AN40 Amsterdam

STREET Street of the consumer address AN50 Polarisavenue

HOUSENUMBER House number of the consumer address AN15 1

ADDITIONALADDRESSINFO Additional information about the consumer address AN50 A

ZIP ZIP code of the consumer address AN10 1000 AA

STATE State of the consumer address AN35 Noord-Holland

STATECODE State code AN9 NH

Key Definition Type Example

COUNTRYCODE ISO 3166 country code of the consumer address AN2 NL

Mandate signature information

MANDATEPLACE City in which the consumer signed the mandate AN40 Hoofddorp

Date of mandate signature

MANDATEDATE Format: YYYYMMDD N8 20131018

MANDATESIGNED l 0=Mandate is not signed N1 1

l 1=Mandate is signed

Mandate pre-notification information

EMAIL Consumer email address AN70 [email protected]

Preference for type of email

EMAILTYPEINDICATOR l 0=Plain text (ASCII) N1 1

l 1=HTML

l 0=Do not send a pre-notification email to the consumer

l 1=Send a pre-notification email to the

consumer on the first collection

PRENOTIFICATION The email is sent from the merchant email address AN1 1

ENDMANDATE Marker (no key) ENDMANDATE

When NOK

ERROR Marker (no key) – –

CODE Result or error code N10

TYPE Type of error AN1

MESSAGE Error message AN4000

ENDERROR Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

193
ENDRESPONSE Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

194
GET_RATE
This API call returns the rate for DCC (dynamic currency conversion) transaction based on the credit card number. The get rate structure is

REQUEST ACTION META PARAMS

GENERAL

Input keys

Key Definition Type Req Example

ACTION GET_RATE AN R GET_RATE

Key Definition Type Req Example

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

GENERAL Marker (no key) – R –

AMOUNT Base amount in cents N12 R 29990 (=299.90)

CURRENCYCODE ISO 4217 currency code of base amount to be converted AN3 R EUR

CREDITCARDNUMBER The complete credit card number N19 O –

ENDGENERAL Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

Dynamic currency conversion indicator

l 1=Dynamic currency conversion offered and accepted

DCCINDICATOR l 0=Dynamic currency conversion does not N1 1

apply

ISO 4217 currency code

ISSUERCURRENCYCODE Returns when dynamic currency conversion applies AN3 EUR

Converted amount (in cents)

ISSUERAMOUNT Returns when dynamic currency conversion applies N12 66089 (=660.89)

Ingenico document - Reproduction or disclosure prohibited without written authorization

195
For receipt-printing purposes only

To meet regulatory requirements, where applicable

Four places for decimals

MARGINRATEPERCENTAGE Returns when dynamic currency conversion applies N6 025000=2.5

For receipt printing purposes only

EXCHANGERATESOURCENAME To meet regulatory requirements, where applicable AN32 Reuters Wholesale Interbank

Key Definition Type Example

For receipt printing purposes only

To meet regulatory requirements, where applicable

Format: YYYYMMDDHHMM

EXCHANGERATESOURCETI Returns when dynamic currency conversion applies N14 20070830120000

MESTAMP

Exchange rate used for transaction Last 4 digits are decimal places

Returns when dynamic currency conversion applies

EXCHANGERATE N12 12341200=1234.12

Timestamp until the exchange rate is valid

EXCHANGERATEVALIDTO Returns when dynamic currency conversion applies N14 20070830180000

Signature—You should provide this MAC in the API: DO_PAYMENT when you want to use
dynamic currency conversion
DCCMAC AN64

ENDROW Marker (no key) – –

See the WebCollect error

codes guide
ERROR Marker (no key)

CODE Error or event code N10 900100

AMOUNT NOT FOUND IN

REQUEST
MESSAGE Message for error or event AN40
00

ENDERROR Marker (no key) – –

Example
<XML>

<META>

</META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

196
</GENERAL>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>GET_PAYMENTPRODUCTS</ACTION>

<META>

</META>

</GENERAL>

</PARAMS>

<META>

</META>

<ROW>

<EXCHANGERATESOURCENAME>Reuters Wholesale Interbank</EXCHANGERATESOURCENAME>

<DCCMAC>S1zfHPifCaEDLN+Xk+PWfg/GWg8=</DCCMAC>

</ROW>

</RESPONSE>

</REQUEST>

Ingenico document - Reproduction or disclosure prohibited without written authorization

197
</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

198
INSERT_ORDER
This API call inserts an order and retrieves the possible payment products for the order.

MerchantLink merchants can use insert order The insert order structure is

REQUEST

ACTION

META

PARAMS

ORDER

ORDERLINES (Optional) ORDERLINE (Optional, 0 – N)

AIRLINEDATA (Optional) FLIGHTLEGS (Optional) FLIGHTLEG (Optional, 0 – N)

Input keys

For Argentina, EMAIL is mandatory and must contain a valid email address—If the email confirming the transaction is

refused the transaction is canceled

Key Definition Ty R Example

pe eq

ACTION INSERT_ORDER AN R INSERT_O

RDER

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN O 123.123.12

32 3.123

VERSION Version of interface AN O 2.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

ORDER Marker (no key) – R –

ORDERID Unique order ID generated by Ingenico ePayments N10 R 9998890004

MERCHANTORDERID Order ID generated by the merchant N10 O 1234567899

Type of order

ORDERTYPE l 1=Normal order (default) N1 O 1

l 4=Variable amount recurring order

AMOUNT Amount of the order in cents N12 R 29990

(=299.90)

SHIPPINGAMOUNT Amount of the shipping costs in cents N12 O 29990

(=299.90)

TAXAMOUNT Tax amount of the order in cents N12 O 29990

(=299.90)

HANDLINGAMOUNT Handling amount of the order in cents N12 O 29990

(=299.90)

AMOUNTSIGN Default + AN1 O +

CURRENCYCODE ISO 4217 currency code AN3 R USD

LANGUAGECODE ISO 639 language code for consumer AN2 R en

IPADDRESSCUSTOMER IP address of consumer in session AN O 124.124.12

32 4.124

COUNTRYCODE ISO 3166 country code of consumer AN2 R US

Ingenico document - Reproduction or disclosure prohibited without written authorization

199
Reference to be used as a payment reference for consumers in cases of bank and check payments—This
number must comply with the Ingenico ePaymentsformat

OVERWRITEPAYMENT AN O 123400012
REFERENCE 12 349

CUSTOMERID ID of consumer AN O 1
15
Mandatory for UCOF transactions

Key Definition Ty R Example

pe eq

For UnionPay International, CUSTOMERID cannot contain spaces

Indicates a mandate

l PRESENT=Mandate present

MANDATE l NOTPRESENT=No mandate (default) A O PRESENT

N10

TITLE Title consumer A O Mr.

N35

FIRSTNAME First name A O Jack

N15

PREFIXSURNAME In between first name and surname A O van

N15

SURNAME Last name of consumer A O Buuren

N35

Street address consumer

STREET If you need to send shipping address to PayPal use the SHIPPING tags A O Polarisavenue
N50

HOUSENUMBER House number address consumer A O 1

N15

ADDITIONALADD Additional address information A O A

RESSINFO N50

Zip code address consumer

ZIP If you need to send shipping address to PayPal use the SHIPPING tags A O 1000 AA
N10

City of consumer

CITY If you need to send shipping address to PayPal use the SHIPPING tags A O New York
N40

State address consumer

STATE If you need to send shipping address to PayPal use the SHIPPING tags A O New York
N35

Title consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPal

SHIPPINGTITLE A O Mr.
N35

First name

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPalr

SHIPPINGFIRSTN A O Jack
AME N15

In between first name and surname

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPal

SHIPPINGPREFIX A O van
SURNAME N15

Ingenico document - Reproduction or disclosure prohibited without written authorization

200
SHIPPINGSURNA Last name of consumer A O Buuren
ME N35

SHIPPINGEMAILA For electronic delivery, this is the email address to which the merchandise was delivered A O andrewlockers
DDRESS N70 @xxx.com

Key Definition Ty R Example

pe eq

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPal

Street address consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPal

SHIPPINGSTREET A O Polarisa
N50 venue

House number address consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPal

SHIPPINGHOUSENUMB A O 1
ER N15

Additional address information

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPal

SHIPPINGADDITIONALA A O A
DDRESSINFO N50

Zip code address consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPal

SHIPPINGZIP A O 1000 AA
N10

City of consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPal

SHIPPINGCITY A O New
N40 York

State address consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPal

SHIPPINGSTATE A O New
N35 York

ISO 3166 country code of consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller

SHIPPINGCOUNTRYCO A O US
DE N2

Key Definition Type Req Example

Protection Program. You can always do shipping handling with PayPal

Ingenico document - Reproduction or disclosure prohibited without written authorization

201
Unique reference of merchant for payment

MERCHANTREFERENCE allowed

input is ASCII 32–126 characters—Do not include trailing spaces in the

MERCHANTREFERENCE

Reported in the operational reports in these keys

l EXTERNAL REFERENCE for

credit card payments

l ADDITIONAL REFERENCE for

non-credit card payments

If left empty MERCHANTID+ORDERID (with

MERCHANTREFERE AN30 R –
NCE leading zeros) is reported in these keys

Soft descriptor for Credit Card and iDEAL payments

DESCRIPTOR is required when instructed by Ingenico ePayments.

For transactions using the real-time bank transfer Netherlands payment product (809), iDEAL,
DESCRIPTOR
AN50
is limited to AN32 AN32
DESCRIPTOR O Shopping.com order
54321

RESELLERID ID of reseller N10 O 1

EMAIL Email address of consumer AN70 O [email protected]

Preference for type of email

EMAILTYPEINDICAT l 0=Plain text N1 O 1

OR
l 1=HTML

COMPANYNAME Company name consumer AN40 O Johnsons Ltd.

COMPANYDATA Additional data on company name AN40 O Sales department

Sex of the consumer

l M=Male

SEX l F=Female AN1 O F

l U=Unknown

VATNUMBER VAT number consumer AN17 O VAT 16

PHONENUMBER Phone number consumer AN20 O +34201234567

FAXNUMBER Fax number consumer AN20 O +34207654321

MOBILEPHONENUM Mobile phone number consumer String 20 R +34201234567

BER

WORKPHONENUMB Work phone number consumer String 20 R +34201234567

INVOICENUMBER Merchant invoice number AN20 O 200302220000000000

INVOICETYPE For future use—Can be left empty AN2 O N

INVOICEDATE Date and time on invoice D O 20030301000000

Key Definition Type R Example

Format: YYYYMMDDHH24MISS

INVOICECLASS For future use—Can be left empty AN10 O

Date and time of order

ORDERDATE Format: YYYYMMDDHH24MISS D O 20030222160000

BIRTHDATE Day of birth of consumer (for fraud detection reasons) CCYYMMDD N8 O 19780203

TEXTQUALIFIER1 For printed invoices AN10 O TEXTQ1

Ingenico document - Reproduction or disclosure prohibited without written authorization

202
TEXTQUALIFIER2 For printed invoices AN10 O TEXTQ2

TEXTQUALIFIER3 For printed invoices AN10 O TEXTQ3

ADDITIONALDATA For printed invoices AN5 O

Start date of the recurring payments Format: CCYYMMDDHH24MISS

STARTDATE time portion (HH24MISS) must use Central European Time (CET) and must reflect CET
daylight-savings time, when it is in use

STARTDATE N14 O 20030828160000

End date of the recurring payments, if no end date is provided and no number of payments is provided

The payments are generated until ended by the merchant

Format: CCYYMMDDHH24MISS

ENDDATE N14 O 20030828160000

NUMBEROFPAYMEN The number of recurrent payments that need to be done N5 O –

NUMBEROFINSTALL The number of installments N5 O 5

MENTS

STEPWEEK Periodicity in weeks N5 O 1 (weekly)

STEPMONTH Periodicity in months N5 O 3 (quarterly)

ENDORDER Marker (no key) – R –

AIRLINEDATA Marker (no key) – O If airline data is

present

AIRLINECODE Airline numeric code N3 R 123

AIRLINENAME Name of airline AN20 R KLM

AIRLINEINVOICENU Airline tracing number N6 O 465321

MBER

Travel agent code

For transactions using Elavon, AGENTNUMBERICCODE is limited to N8

This spelling (AGENTNUMBERICCODE) must be

used N6
N8
AGENTNUMBERICC O 123456 or
ODE 12345678

The ticket or document number contains

TICKETNUMBER l Airline code—3-digit airline code AN13 R 0741243235556

Key Definition Type Req Example

number

l Form code—A maximum of 3 digits indicating the type of document, the source of issue and the number of
coupons it contains

l Serial number—A maximum of 8

digits allocated on a sequential basis, provided that the total number of digits allocated to the form code and serial
number shall not exceed ten

You can replace TICKETNUMBER with PNR if the ticket number is unavailable

PNR Passenger name record AN6 O

ETICKETINDICATOR l E=eTicket AN1 O E

Ingenico document - Reproduction or disclosure prohibited without written authorization

203
l ET=E Ticket

l CTO=City Ticket Office

TICKETDELIVERYME l ATO=Airport Ticket Office AN3 O ET

THOD
l TBM=Ticket By Mail

l TOD=Ticket On Departure

POINTOFSALE IATA point of sale name AN O –

Place of issue

For sales in US, the last two characters (pos 14–15) must be the US state code

PLACEOFISSUE AN O –
15

PASSENGERNAME Name of passenger AN R Johan

49 Cruijff

FLIGHTDATE Date of the Flight CCYYMMDD N8 O 20141231

ISTHIRDPARTY Is the payer the ticket holder (T/F) AN5 O T

ISREGISTEREDCUST Identifies a known consumer (T/F) AN5 O T

OMER

POSCITYCODE This is the city code of the point of sale AN O AMS

Consumer reference used when searching the Ingenico ePayments interface

For UnionPay International, CUSTOMERID cannot contain spaces

CUSTOMERID AN O 14
16

This is the date of issue recorded in the airline system

In a case of multiple issuances of the same ticket to a cardholder, the merchant should use the last ticket date

Format: YYYYMMDD

ISSUEDATE N8 O 20090402

Key Definition Type Req Example

ISSUEDATE is required for Elavon

ISSUEDATE and

RESTRICTEDTICKET are required for PayPal

Airline data restricted ticket (non- refundable)

l 0=No restrictions, the ticket is (partially) refundable

l 1=Restricted, the ticket is non-

refundable

ISSUEDATE and

RESTRICTEDTICKET RESTRICTEDTICKET are required for PayPal N1 O 0

FLIGHTLEGS Marker (no key) – O If flight legs are present

...flightlegs... – – –

ENDFLIGHTLEGS Marker (no key) – O –

ENDAIRLINEDATA Marker (no key) – O –

ORDERLINES Marker (no key) – O If order lines are present

…order lines… Marker (no key) – O –

ENDORDERLINES Marker (no key) – O –

ENDPARAMS Marker (no key) – R –

Ingenico document - Reproduction or disclosure prohibited without written authorization

204
For each order line

Key Definition Type Req Example

ORDERLINE Marker (no key) N5 R

LINENUMBER Sequence of order line number N10 R 1

ITEMID Product code- ID of the item AN12 O DE212

Château Des

Description (116 positions) Number of items (4 positions) Price per item (12 positions) Chapelains 1998

INVOICELINEDATA AN132 O 1 9995

LINEAMOUNT Amount of order line N12 R 9995

LINETAXAMOUNT Tax amount of orderline in cents N12 O 345

MERCHANTPAGENUMBER Page number for invoice N3 O 1

MERCHANTLINENUMBER Line number for invoice N5 O 1

CURRENCYCODE ISO 4217 currency code—If blank, the currency code of the order is the default value AN3 O USD

ENDORDERLINE Marker (no key) – R –

For each flight leg

Key Definition Type Req Example

FLIGHTLEG Marker (no key) – O –

Key Definition Type Req Example

LEGNUMBER Sequence of flight leg number N5 R 1

LEGDATE Date of the leg CCYYMMDD D8 R 20141231

ORIGINAIRPORT Origin airport/city code AN3 R AMS

ARRIVALAIRPORT Arrival airport/city code AN3 R LAX

l O or blank=stopover permitted

l X=stopover not permitted

STOPOVERCODE STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are AN1 O X

required for PayPal

AIRLINECLASS Reservation Booking Designator AN2 R 1

CARRIERCODE IATA carrier code AN2 R KL

FAREBASIS Fare Basis/Ticket Designator AN15 O INTERNET

The flight number assigned by the airline carrier with no leading spaces

FLIGHTNUMBER STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are AN5 O 791

required for PayPal

The departure time in local time at the departure airport Format: HH:MM

STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are

DEPARTURETIME required for PayPal AN6 O 17:59

ENDFLIGHTLEG Marker (no key) – O –

Return keys—MerchantLink

Ingenico document - Reproduction or disclosure prohibited without written authorization

205
Key Definition Type Example

RESULT Result of the action AN3 OK or NOK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ROW Marker (no key) – –

ORDERID Unique order ID generated by Ingenico ePayments N10 9998890004

PAYMENTMETHODNAME Payment method name AN50 Credit Card

PAYMENTPRODUCTID Payment product identifier N5 1

PAYMENTPRODUCTNAME Name of payment product in language AN12 Visa

ENDROW Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 100400

MESSAGE Message for error or event AN4000 REQUEST DID NOT HAVE A UNIQUE ORDERID

ENDERROR Marker (no key) – –

Example—MerchantLink
<XML>

<ACTION>INSERT_ORDER</ACTION>

<META>

</META>

<ORDER>

<FIRSTNAME>Johan</FIRSTNAME>

<SURNAME>Cruijff</SURNAME>

<CITY>Barcelona</CITY>

<STATE>Catalunie</STATE>

Ingenico document - Reproduction or disclosure prohibited without written authorization

206
<EMAIL>[email protected]</EMAIL>

<COMPANYNAME>Cruijff Sports</COMPANYNAME>

</ORDER>

<INVOICELINEDATA>invoiceline 1</INVOICELINEDATA>

<FREETEXT>freetext</FREETEXT>

</ORDERLINE>

<INVOICELINEDATA>invoiceline 2</INVOICELINEDATA>

<FREETEXT>freetext</FREETEXT>

</ORDERLINE>

</ORDERLINES>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>INSERT_ORDER</ACTION>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

207
<VERSION>2.0</VERSION>

</META>

<ORDER>

<FIRSTNAME>Johan</FIRSTNAME>

<SURNAME>Cruijff</SURNAME>

<CITY>Barcelona</CITY>

<STATE>Catalunie</STATE>

<EMAIL>[email protected]</EMAIL>

<COMPANYNAME>Cruijff Sports</COMPANYNAME>

</ORDER>

<INVOICELINEDATA>invoiceline 1</INVOICELINEDATA>

<FREETEXT>freetext</FREETEXT>

</ORDERLINE>

<INVOICELINEDATA>invoiceline 2</INVOICELINEDATA>

Ingenico document - Reproduction or disclosure prohibited without written authorization

208
<FREETEXT>freetext</FREETEXT>

</ORDERLINE>

</ORDERLINES>

</PARAMS>

<META>

</META>

<ROW>

<PAYMENTMETHODNAME>Credit Card</PAYMENTMETHODNAME>

</ROW>

<ROW>

<PAYMENTMETHODNAME>Credit Card</PAYMENTMETHODNAME>

<PAYMENTMPRODUCTNAME>American Express</PAYMENTMPRODUCTNAME>

</ROW>

<ROW>

<PAYMENTMETHODNAME>Credit Card</PAYMENTMETHODNAME>

<PAYMENTMPRODUCTNAME>Eurocard/Mastercard</PAYMENTMPRODUCTNAME>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

209
INSERT_ORDERWITHPAYMENT
This API call combines an API: INSERT_ORDER and an API: DO_PAYMENT. The insert order with payment structure is

REQUEST

ACTION

META

PARAMS

ORDER

ORDERLINES (Optional)

ORDERLINE (Optional, 0 – N)

AIRLINEDATA (Optional) FLIGHTLEGS (Optional) FLIGHTLEG (Optional, 0 – N)

PAYMENT

AUTHENTICATE

Input keys

l For Argentina only, the MERCHANTREFERENCE cannot contain more than 15 digits—This is due to limitations at Sub1

l For Argentina, EMAIL is mandatory and must contain a valid email address—If the email confirming the transaction is

refused the transaction is canceled

Key Definition Type Req Example

ACTION INSERT_ ORDERWITHPAYMENT AN R INSERT_ ORDERWITHPAYMENT

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

ORDER Marker (no key) – R –

MERCHANTORDERID Order ID generated by the merchant N10 O 1234567899

Type of order

ORDERTYPE=4 for SEPA l 1=Normal order (default)

ORDERTYPE direct debit recurring transactions using HostedMerchantLink N1 O l 4=Variable amount recurring
order

Type of transaction, used for SEPA direct debit transactions using

HostedMerchantLink
l F=First transaction
TRANSACTIONTYPE is
l R=Next recurring transaction
required for SEPA direct debit transactions using HostedMerchantLink
TRANSACTIONTYPE AN1 O l S=Single, one-off

transaction

AMOUNT Amount of the order in cents N12 R 29990 (=299.90)

SHIPPINGAMOUNT Amount of the shipping costs in cents N12 O 29990 (=299.90)

TAXAMOUNT Tax amount of the order in cents N12 O 29990 (=299.90)

HANDLINGAMOUNT Handling amount of the order in cents N12 O 29990 (=299.90)

AMOUNTSIGN Default=plus [+] AN1 O +

CURRENCYCODE ISO 4217 currency code AN3 R USD

LANGUAGECODE ISO 639 language code for AN2 R en

Ingenico document - Reproduction or disclosure prohibited without written authorization

210
Key Definition Ty R Example
pe eq

consumer

COUNTRYCODE ISO 3166 country code of consumer AN2 R US

Reference to be used as a payment reference for consumers in cases of bank and check payments—This
number must comply with the Ingenico ePayments format

OVERWRITEPAYMENT AN O 12340001
REFERENCE 12 2349

IPADDRESSCUSTOMER IP address of consumer in session AN O 124.124.1

32 24.124

ID of consumer

For UnionPay International, CUSTOMERID cannot contain spaces

CUSTOMERID Mandatory field for UCOF transactions AN O 1

Indicates a mandate

l PRESENT=Mandate present

MANDATE l NOTPRESENT=No mandate (default) AN O PRESENT

TITLE Title consumer AN O Mr.

FIRSTNAME First name AN O Jack

PREFIXSURNAME In between first name and surname AN O Van

SURNAME Last name of consumer AN O Buuren

Street address consumer

To send shipping address for PayPal transactions, only use the SHIPPING tags

STREET AN O Polarisave
50 nue

HOUSENUMBER House number address consumer AN O 1

ADDITIONALADDRESSI Additional address information AN O A

NFO 50

Zip code address consumer

To send shipping address for PayPal transactions, only use the SHIPPING tags

ZIP AN O 1000 AA
10

City of consumer

To send shipping address for PayPal transactions, only use the SHIPPING tags

CITY AN O New York

State address consumer

To send shipping address for PayPal transactions, only use the SHIPPING tags

STATE AN O New York

SHIPPINGTITLE Title consumer AN O Mr.

Ingenico document - Reproduction or disclosure prohibited without written authorization

211
Key Definition Ty R Example
pe eq

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller
Protection Program. You can always do shipping handling with PayPal

First name

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller
Protection Program. You can always do shipping handling with PayPal

SHIPPINGFIRSTNAME A O Jack
N
15

In between first name and surname

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller
Protection Program. You can always do shipping handling with PayPal

SHIPPINGPREFIXSUR A O Van
NAME N
15

Last name of consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller
Protection Program. You can always do shipping handling with PayPal

SHIPPINGSURNAME A O Buuren
N
35

SHIPPINGEMAILADDR For electronic delivery, this is the email address to which the merchandise was delivered A O andrewlockers
ESS N @xxx.com
70

Street address consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller
Protection Program. You can always do shipping handling with PayPal

SHIPPINGSTREET A O Polarisavenue
N
50

House number address consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller
Protection Program. You can always do shipping handling with PayPal

SHIPPINGHOUSENUM A O 1
BER N
15

Additional address information SHIPPING details are required

SHIPPINGADDITIONAL A O A
ADDRESSINFO N
50

Key Definition T R Example

y eq
pe

for PayPal transactions for physical goods if you are using PayPal Seller Protection Program. You can always do
shipping handling with PayPal

Zip code address consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPal

SHIPPINGZIP A O 1000 AA
N
10

Ingenico document - Reproduction or disclosure prohibited without written authorization

212
City of consumer

SHIPPING contact details are required by default for PayPal transactions for physical goods—For information about
changing default requirements, contact your Ingenico ePayments implementation manager

SHIPPINGCITY A O New York

N
40

State address consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPal

SHIPPINGSTA A O New York

TE N
35

ISO 3166 country code of consumer

SHIPPING details are required for PayPal transactions for physical goods if you are using PayPal Seller Protection
Program. You can always do shipping handling with PayPal

SHIPPINGCO A O US
UNTRYCODE N2

Unique reference of merchant for payment

MERCHANTREFERENCE

allowed input is ASCII 32–126 characters—Do not include trailing spaces in the MERCHANTREFERENCE

MERCHANTR A R –
EFERENCE N
30

Soft descriptor for Credit Card, iDEAL and Sofort payments A

N
DESCRIPTOR 50 O Shopping.com
order 54321
A
N
32

Key Definition Type Req Example

DESCRIPTOR is required when instructed by Ingenico ePayments

For transactions using the real-time bank transfer Netherlands payment product (809), iDEAL,
DESCRIPTOR is limited to AN32

For transactions using the real-time bank transfer payment product (836), Sofort, DESCRIPTOR is
limited to AN40

RESELLERID ID of reseller N10 O 1

EMAIL Email address of consumer AN70 O someone@email.

com

Preference for type of email

EMAILTYPEINDICA l 0=Plain text N1 O 1

TOR
l 1=HTML

COMPANYNAME Company name consumer AN50 O Johnsons Ltd

COMPANYDATA Additional data on company name AN40 O Sales department

SEX Sex consumer (M or F or U) AN1 O M

VATNUMBER VAT number consumer AN17 O VAT 16

PHONENUMBER Phone number consumer AN20 O +34201234567

MOBILEPHONENU Mobile phone number consumer String R +34201234567

MBER 20

WORKPHONENUM Work phone number consumer String R +34201234567

BER 20

Ingenico document - Reproduction or disclosure prohibited without written authorization

213
FAXNUMBER Fax number consumer AN20 O +34207654321

INVOICENUMBER Invoice number merchant (on printed invoice) AN20 O 2003022200000000

0001

INVOICETYPE For future use can be left empty AN2 O N

Date and time on invoice

INVOICEDATE Format: YYYYMMDDHH24MISS D O 20030301000000

INVOICECLASS For future use can be left empty AN10 O

Date and time of order

ORDERDATE Format: YYYYMMDDHH24MISS D O 20030222160000

Day of birth of consumer (for fraud detection reasons) CCYYMMDD

BIRTHDATE N8 O 19780203

TEXTQUALIFIER1 For printed invoices AN10 O TEXTQ1

TEXTQUALIFIER2 For printed invoices AN10 O TEXTQ2

TEXTQUALIFIER3 For printed invoices AN10 O TEXTQ3

ADDITIONALDATA For printed invoices AN500 O

Start date of the recurring payments

Format: CCYYMMDDHH24MISS

STARTDATE time portion (HH24MISS) must use Central European Time (CET) and must

STARTDATE N14 O 20030828160000

Key Definition Ty R Example

pe eq

reflect CET daylight-savings time, when it is in use

End date of the recurring payments

If no end date and no number of payments is provided

The payments are generated until you end them

Format: CCYYMMDDHH24MISS

ENDDATE N14 O 20030828160

000

NUMBEROFPAY The number of recurrent payments that need to be done N5 O

MENTS

NUMBEROFINST The number of installments N5 O 5

ALLMENTS

STEPWEEK Periodicity in weeks N5 O 1 (weekly)

STEPMONTH Periodicity in months N5 O 3 (quarterly)

ENDORDER Marker (no key) – R –

AIRLINEDATA Marker (no key) – O If airline data

is present

AIRLINECODE Airline numeric code N3 R 123

AIRLINENAME Name of airline AN R KLM

AIRLINEINVOICE Airline tracing number N6 O 465321

NUMBER

Travel agent code

For transactions using Elavon, AGENTNUMBERICCODE is

limited to N8

This spelling (AGENTNUMBERICCODE) N6

N8
AGENTNUMBERI must be used O 123456 or
CCODE 12345678

Ingenico document - Reproduction or disclosure prohibited without written authorization

214
The ticket/document number is

l Airlines Code=3-digit Airlines code number

l Form Code=A maximum of 3

digits indicating the type of document, the source of issue and the number of coupons

It is

l Serial Number=A maximum of 8 digits allocated on a sequential basis, provided that the total number of digits
allocated to the Form Code and Serial Number shall not exceed ten

TICKETNUMBER AN R 07412432355
13 56

Key Definition Type Req Example

You can replace TICKETNUMBER with PNR if

the ticket number is unavailable

PNR Passenger name record AN6 O

ETICKETINDICATOR l E=eTicket AN1 O E

l ET=E Ticket

l CTO=City Ticket Office

TICKETDELIVERYMETHOD l ATO=Airport Ticket Office AN3 O ET

l TBM=Ticket By Mail

l TOD=Ticket On Departure

POINTOFSALE IATA point of sale name AN25 O

Place of issue

For sales in the US the last two characters (pos 14–15) must be the US state code

PLACEOFISSUE AN15 O

PASSENGERNAME Name of passenger AN49 R Johan Cruijff

FLIGHTDATE Date of the flight CCYYMMDD N8 O 20141231

ISTHIRDPARTY Is the payer the ticket holder (T/F) AN5 O T

ISREGISTEREDCUSTOMER Identifies a known consumer (T/F) AN5 O T

POSCITYCODE This is the city code of the point of sale AN10 O AMS

Consumer reference used when searching the Ingenico ePayments interface

For UnionPay International, CUSTOMERID cannot contain spaces

CUSTOMERID AN16 O 14

This is the date of issue recorded in the airline system

In a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date

Format: YYYYMMDD

ISSUEDATE is required for Elavon

ISSUEDATE and RESTRICTEDTICKET are

required for PayPal

ISSUEDATE N8 O 20090402

Airline data restricted ticket (non-refundable)

RESTRICTEDTICKET l 0=No restrictions, the ticket N1 O 0

Ingenico document - Reproduction or disclosure prohibited without written authorization

215
Key Definition Type Req Example

is (partially) refundable

l 1=Restricted, the ticket is non-refundable

ISSUEDATE and RESTRICTEDTICKET are

required for PayPal

FLIGHTLEGS Marker (no key) – O If flightlegs are

present

...flightlegs...

ENDFLIGHTLEGS Marker (no key) – O –

ENDAIRLINEDATA Marker (no key) – O –

ORDERLINES Marker (no key) – O –

…order lines... O

ENDORDERLINES Marker (no key) – O –

PAYMENT Marker (no key) – R –

…payment details… R

ENDPAYMENT Marker (no key) – R –

FRAUDFIELDS Marker (no key) – O –

EBT_USER_DATA1 AN256 O

EBT_USER_DATA2 AN256 O

EBT_USER_DATA3 AN256 O

EBT_USER_DATA4 AN256 O

EBT_USER_DATA5 AN256 O

EBT_USER_DATA6 AN256 O

EBT_USER_DATA7 AN256 O

EBT_USER_DATA8 AN256 O

EBT_USER_DATA9 AN256 O

EBT_USER_DATA10 AN256 O

EBT_USER_DATA11 AN256 O

EBT_USER_DATA12 AN256 O

EBT_USER_DATA13 AN256 O

EBT_USER_DATA14 AN256 O

EBT_USER_DATA15 AN256 O

EBT_USER_DATA16 AN256 O

Specifies if the consumer enters a password to gain access to an account registered with the
merchant

These values only

l Y=Yes

l N=No
EBT_PASSWORD AN1 O Y

Specifies if the consumer has a history of online shopping with the merchant

These values only

EBT_PREVCUST AN1 O Y

Ingenico document - Reproduction or disclosure prohibited without written authorization

216
Key Definition Type Req Example

l Y=Yes

l N=No

Gift card type These values only

l 1=Celebrate Fall

l 2=Grandparent's Day l 4=Independence Day l A=Anniversary

l B=Birthday

l C=Congratulations l D=April Fool's Day l E=Easter

l F=Father's Day

l G=Graduation

l H=Holiday

l I=Season's Greetings

l J=Passover

l K=Kwanzaa

l L=Halloween

l M=Mother's Day

l N=New Year's Day

l O=Bosses' Day

l P=St. Patrick's Day

EBGIFTCARDTYPE l Q=Sweetest Day AN1 O W

l R=Christmas

l S=Baby Shower l T=Thanksgiving l U=Other

l V=Valentine's Day

l W=Wedding

l X=Secretary's Day

l Y=Chinese New Year

l Z=Hanukkah

EBGIFTMESSAGE AN160 O

EBSHIPCOMMENTS AN160 O

EBWEBSITE The website from which the purchase is made AN60 O https://www.yourwebsite.com

ENDFRAUDFIELDS Marker (no key) – O –

ENDPARAMS Marker (no key) – R –

Additional for each order line

Key Definition Type Req Example

ORDERLINE Marker (no key) N5 R –

LINENUMBER Sequence of order line number N10 R 1

ITEMID Product code- ID of the item AN12 O DE212

Description (116 positions) Château Des

INVOICELINEDATA Number of items (4 positions) Price per item (12 positions) AN132 O Chapelains

Key Definition Type Req Example

Ingenico document - Reproduction or disclosure prohibited without written authorization

217
1998

1 9995

LINEAMOUNT Amount of order line N12 R 9995

LINETAXAMOUNT Tax amount of orderline in cents N12 O 345

MERCHANTPAGENUMBER Page number for invoice N3 O 1

MERCHANTLINENUMBER Line number for invoice N5 O 1

CURRENCYCODE ISO 4217 currency code—If blank, the currency code of the order is the default value AN3 O USD

ENDORDERLINE Marker (no key) – R –

Additional for each flight leg

Key Definition Type Req Example

FLIGHTLEG Marker (no key) – O –

LEGNUMBER Sequence of flight leg number N5 R 1

LEGDATE Date of the leg CCYYMMDD D8 R 201401231

ORIGINAIRPORT Origin airport/city code AN3 R AMS

ARRIVALAIRPORT Arrival airport/city code AN3 R LAX

l O or blank=Stopover permitted

l X=Stopover not permitted

STOPOVERCODE STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are AN1 O X

required for PayPal

AIRLINECLASS Reservation Booking Designator AN2 R 1

CARRIERCODE IATA carrier code AN2 R KL

FAREBASIS Fare Basis/Ticket Designator AN15 O INTERNET

The flight number assigned by the airline carrier with no leading spaces

FLIGHTNUMBER STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are AN5 O 791

required for PayPal

The departure time in local time at the departure airport Format: HH:MM

STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are

DEPARTURETIME required for PayPal AN6 O 17:59

ENDFLIGHTLEG Marker (no key) – O –

Additional for payment in general

Key Definition Type Re q Example

PAYMENT Marker (no key) – R –

PROFILETOKEN Token for payment profile AN40 R 84c19ac1-f64b-492d-ae25-41724afcf086

Payment product identifier—Depends on payment method

l 1=Visa

PAYMENTPRODUCTID l 3=MasterCard N5 R 3

Key Definition Type Re Example

l And so on

Ingenico document - Reproduction or disclosure prohibited without written authorization

218
AMOUNT Amount to be paid N12 R 29990

AMOUNTSIGN Amount sign AN1 O +

CURRENCYC ISO 4217 currency code AN3 R USD

ODE

LANGUAGEC ISO 639 language code for consumer AN2 R en

ODE

COUNTRYCO ISO 3166 country code of consumer AN2 R US

l 0=HostedMerchantLi nk is not to be used

l 1=Hosted

MerchantLink is to be used (default, if configured)

HOSTEDINDICATOR

is optional for transactions via HostedMerchantLink— For more information, contact your
Ingenico ePayments account manager

HOSTEDINDI N1 O 1
CATOR

URL to be used for returning the consumer to your site after the transaction in cases of a
redirected payment or HostedMerchantLink

AN5 HTTPS://www.merchanturl.com
12 /landingpage.jsp?a=b& c=d
RETURNURL O

… < payment method depending keys > – R –

… < see the following table – R –

ENDPAYMENT Marker (no key) – R –

Additional for credit card online payments

Key Definition T R Example

y eq
pe

Expiry date Format: MMYY

EXPIRYDATE and CREDITCARDNUMBER

are optional for transactions via HostedMerchantLink in case you choose to have them submitted by the consumer on the
Ingenico ePayments hosted pages, for example, if a merchant is not PCI compliant

EXPIRYDATE N4 R 1206

CREDITCAR Credit Card number N R 456735000

DNUMBER 19 0427977

Key Definition Type R Example

EXPIRYDATE and CREDITCARDNUMBER

are optional for transactions via HostedMerchantLink in case you choose to have them submitted by the consumer on
the Ingenico ePayments hosted pages, for example, if a merchant is not PCI compliant

ISSUENUMBER Issue number N2 O 01

CVV key 123

The card verification value (CVV) is 3 or 4 digits on the back, or front [Amex], of a credit card. It is required for the CVV Max 4 pos
check Amex Max
CVV N4 O 3 pos MC,
Visa

CVVINDICATOR l 0=Bypass CVV check N1 O 1

l 1=CVV present (default)

AVSINDICATOR l 0=Bypass AVS check N1 O 1

l 1=AVS present

Ingenico document - Reproduction or disclosure prohibited without written authorization

219
1=Final authorisation
AUTHTYPE 2=Pre-authorisation N1 O 1
3=Purchase

All 3 types apply both to Visa and Mastercard depending on the capabilities of the acquirer.

Purchase also appies to Union Pay and MIR (Russia)

Indicates if the authorization should be executed—Can be used to overrule merchant- level configuration

l 0=Authorization only

l 1=Continue if possible

l 2=Authentication only

AUTHENTICATIONINDICATOR is required for the 3D Secure check—For more information, contact your Ingenico
ePayments account manager
AUTHENTICA N1 O 1
TIONINDICAT
OR

Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION

l 0=Failed authentication (no liability shift)

l 1=Incomplete authentication (MasterCard) l 2=Successful authentication (MasterCard) l 5=Successful

authentication (Visa, Diners

Club)

l 6=Authentication attempted (Visa)

l 7=Failed authentication (no liability shift)

l (empty)=Not checked or not enrolled, but attempt made (MasterCard)

If Elavon is the acquirer, these ECI values apply

l 6=Authentication attempted (Visa, MasterCard, Maestro)

ECI N1 R 1
l 2=Successful authentication (MasterCard,

Maestro)

DIRECTORYS Universally unique transaction identifier assigned by the Directory Server (schemes) to identify a single transaction AN
ERVERTRANS 36
ACTIONID

THREEDSPR the most recent active protocol version that is supported by the Directory server ?
OTOCOLVER
SION

UCOFINDICAT Possible values AN O FIRST

OR
FIRST
SUBSEQUENT

Indicates to the scheme that is either the transaction with which the consumer is agreeing with the merchant to store the
card (FIRST) or is a future transaction where the card is already stored (SUBSEQUENT)

UCOF (Unscheduled Card On File) is only possible with Order Type 1

UCOFREQUE Possible Values AN O CIT

STOR
CIT (Customer Initiated Transaction)
MIT (Merchant Initiated Transaction

By Default all First UCOFs are CIT, because the consumer is agreeing to store the card. Subsequent can be CIT (like
single clik to buy) or MIT (like top ups). If the merchant is sending this parameter in the first UCOF, it will be validated to
contain only CIT

UCOF (Unscheduled Card On File) is only possible with Order Type 1

INITIALSCHE The transaction ID given by Visa or Mastercard after the First Recurring/First UCOF/Pre Authorization to send in the AN O MC1238743
METRANSACT authorization request of: 15 876289
IONID
A subsequent Recurring transaction

A subsequent UCOF MIT

A no show or delay charge

All these are MIT transactions that needs the linking to the initial Transaction where the consumer was present. If this
value was not provided in the first transaction, the merchant can send the transaciton ID of any subsequent. Please
check the response of this API call and GET_ORDERSTATUS

Ingenico document - Reproduction or disclosure prohibited without written authorization

220
MITREASON Specific for hospitality, Visa requests the flagging of industry specific Merchant Initiated Transactions. The options are: FIX O NO_SHOW
VA
NO_SHOW LU
ES
DELAY_CHARGE

INCREMENTAL_AUTHORIZATION (for future use)

RESUBMISSION (for future use)

REAUTHORIZATION (for future use)

For this transaction the INITALTRANSACTIONID is needed in order to do the linking with the original Pre Authorization
(where the consumer was present)

Key Definition T R Example

y eq
pe

l 5=Successful authentication (Visa, Diners Club)

l 7=Internet (not a 3D Secure transaction)

ECI Electronic Commerce Indicator provides authentication validation results returned after the N1 R 1
authentication

DIRECTORYSERV Universally unique transaction identifier assigned by the Directory Server (schemes) to A New 3DS V2
ERTRANSACTIONID identify a single transaction N
36

THREEDSPROTOC the most recent active protocol version that was used to perform the authentication AN R New 3DS V2 value is "2.1.0" to start
OLVERSION with

CAVV This is mandatory for ECI 1,2 and 5,6 A O

N
40

This is the Base64 encoded string

provided in the authentication
response

For MasterCard and Maestro, the

XID can be used,

It is not used in 3DS V2

XID The transaction ID that is used in the authentication A O
N
50

THREEDSSERVER The transaction ID generated by the 3D Server (replaces the XID used in 3DS V1) A R New 3DS V2
TRANSACTIONID N
50

This is the Base64 encoded string

provided in the authentication
response

XID The transaction ID that is used A O

N
50

The algorithm, from your 3D Secure provider, used to generate the authentication CAVV

Required when

l The 3D Secure authentication for the transaction is managed by a non-Ingenico

ePayments 3D Secure authentication provider

l You process the transaction through Atos

CAVVALGORITHM A O 1
N1

The 3D Secure authentication result from your 3D Secure provider

Required when

l The 3D Secure authentication for the transaction is managed by a non-Ingenico

ePayments 3D Secure authentication provider

l You process the transaction through Atos

VALIDATIONRESU A O Y (required only for 3DS V1)
LT N1

Ingenico document - Reproduction or disclosure prohibited without written authorization

221
Sales Transaction Type, Commerce Type, or ECI of the transaction

l 1=Internet (Default)

l 2=Call center

STTINDICATOR l 3=Recurring N1 O 1

l 4=MOTO

l 5=Card Holder Present

NAME This is the name present on the credit card A O S. Aneelux

N
45

First name of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more
information about fraud screening, see Fraud screening service
FIRSTNAME A O Jack
N
15

In between first name and surname

The name and address of the cardholder can be relevant for fraud screening—For more
information about fraud screening, see Fraud
PREFIXSURNAME A O van
N
15

Key Definition Ty R Example

pe eq

screening service

Last name of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service
SURNAME AN O Buuren
35

Street address of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service

STREET, HOUSENUMBER, and ZIP are

required for the Address Verification Service (AVS) check

STREET AN O Polarisaven
50 ue

House number of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service

STREET, HOUSENUMBER, and ZIP are

required for the Address Verification Service (AVS) check

HOUSENUMBER AN O 1
15

CUSTOMERIPADDR The IP address of the consumer doing the payment AN O 123.123.12

ESS 32 3.123

Additional address information

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service
ADDITIONALADDRE AN O A
SSINFO 50

Zip code address of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service

STREET, HOUSENUMBER, and ZIP are

required for the Address Verification Service (AVS) check

ZIP AN O 1000 AA
10

City of cardholder

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service
CITY AN O New York
40

Ingenico document - Reproduction or disclosure prohibited without written authorization

222
STATE State of cardholder AN O New York
35

Key Definition Ty R Example

pe eq

The name and address of the cardholder can be relevant for fraud screening—For more information about fraud
screening, see Fraud screening service

PHONENUMBER Telephone number of the cardholder AN O +34201234567

Email address of the cardholder

For Argentina, EMAIL is mandatory and must contain a valid email address—If the email confirming the
transaction is refused the transaction is canceled
EMAIL AN O someone@em
70 ail.com

BIRTHDATE Birth date of the cardholder (for fraud detection purposes) (ccyymmdd) N8 O 19780203

Dynamic currency conversion indicator

l 1=Dynamic currency conversion offered and accepted

l 0=Dynamic currency conversion does not

apply

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic currency
conversion does not apply

DCCINDICATOR N1 R 1

Amount the consumer has to pay after applying dynamic currency conversion

l Mandatory=Dynamic currency conversion applies

l Ignored= Dynamic currency conversion does

not apply

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic currency
conversion does not apply

ISSUERAMOUNT N12 R –

ISO 4217 currency code of the consumer

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

ISSUERCURREN AN3 R EUR

CYCODE

Key Definition Ty R Example

pe eq

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic

currency conversion does not apply

For receipt printing purposes only

To meet regulatory requirements, where applicable

Four decimal places

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic

currency conversion does not apply

MARGINRATEPERCE N6 R 025000=2.5
NTAGE

Ingenico document - Reproduction or disclosure prohibited without written authorization

223
For receipt printing purposes only—To meet regulatory requirements, where applicable

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic

currency conversion does not apply

Reuters
Wholesale
EXCHANGERATESO AN R Interbank
URCENAME 32

Exchange rate used for transaction Last four digits are decimal places

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic

currency conversion does not apply

EXCHANGERATE N12 R 12341200=1234.

Time stamp until the exchange rate is valid

DCCINDICATOR, ISSUERAMOUNT, ISSUERCURRENCYCODE, MARGINRATEPERCENTAGE,

EXCHANGERATESOURCENAME, EXCHANGERATE, and

EXCHANGERATEVALIDTO are required if dynamic currency conversion applies, ignored if dynamic

currency conversion does not apply

EXCHANGERATEVAL N14 R 20070830180000

IDTO

Additional information when credit card processing is done with 3D v2

Key Definition T Req Example

y
pe

this is the new tag that we are introducing in

order to support EMVCo 3DS (aka 3D v2).
The first batch of data resolves around
authentication of the consumer towards the
merchant.

AUTHENTICA Marker (no key) – O –

RECURRINGF Indicates the minimum number of days N4 R. the field Number of days: DDDD
REQUENCY between authorizations is only
required if this Example: 30, 60, 90, 180, 365
is the first
recurring
transaction

RECURRINGE Indicates the date after which no further N8 R. the field the recurring expiry date should be such that will allow at least the first
XPIRY authorizations shall be performed is only subsequent occurrence to happen. For example if today is the 15th August
required if this 2019 and the recurring frequency is set to 30 days the the recurring expiry
is the first should be set to at least 16th September 2019, otherwise the transaction ill
recurring result to an error.
transaction.
Date format =YYYYMMDD

Example: 20200916

CUSTOMERA Cardholder authentication method on N2 O 1 = Guest Login

UTHENTICATI Merchant site 2 = Login to the cardholder account at the 3DS Requestor system using 3DS
ONTOMERCH Requestor’s own credentials
ANTMETHOD 3 = Login to the cardholder account at the 3DS Requestor system using
federated ID
4 = Login to the cardholder account at the 3DS Requestor system using
issuer credentials
5 = Login to the cardholder account at the 3DS Requestor system using third-
party authentication
6 = Login to the cardholder account at the 3DS Requestor system using
FIDO Authenticator

CUSTOMERA Date of Cardholder authentication on N O Date format =YYYYMMDDHHMM Example: 201912311260

UTHENTICATI Merchant Site 12
ONTOMERCH
ANTUTCTIME
STAMP

Ingenico document - Reproduction or disclosure prohibited without written authorization

224
PRIORTHREE CardHolder prior 3D authentication method N2 O Mechanism used by the Cardholder to previously authenticate to the 3DS
DSMETHOD Requestor.
1 = Frictionless authentication occurred by ACS2 = Cardholder challenge
occurred by ACS
3 = AVS verified
4 = Other issuer methods

PRIORTHREE CardHolder prior 3D authentication N O Date and time in UTC of the prior cardholder
DSUTCTIMES timestamp 12 authentication "YYYYMMDDHHMM"
TAMP

PRIORTHREE CardHolder prior 3D authentication A O This data element provides additional information to the ACS to determine
DSACSTRAN reference N the best approach for handing a request.
SACTIONID 36

Key Definition Ty R Example

pe eq

the second bath of data includes information on the browser of the consumer

DEVICEBROWSERAC HTTP accept headers from the Cardholder’s browser. A R Required when BROWSER method
CEPTHEADER N2
048

DEVICEBROWSERIPA IP address of the browser as returned by the HTTP headers. A R Note: Required when BROWSER method is
DDRESS N45 used and for the regions where this is
acceptable.
Example IPv4 address: 1.12.123.255
IPv6 address:2011:0db8:85a3:0101:0101:
8a2e:0370:7334

BROWSERLOCALE ISO 639 language code. Returned from navigator.language property. A R pa-in en-au en
N8

BROWSERSCREENHE Total height of the Cardholder’s screen in pixels. A R Required for BROWSER method
IGHT Value is returned from the screen.height property. N6

BROWSERSCREENWI Total width of the cardholder’s screen in pixels. A R Required for BROWSER method
DTH Value is returned from the screen.width property. N6

DEVICEBROWSERTIM Time difference between UTC time and the Cardholder browser local time, in A R Required for BROWSER method
EZONEOFFSETMINUT minutes. N6
ES

DEVICEBROWSERUS Exact content of the HTTP user-agent header. A R Required for BROWSER method
ERAGENT N2
048

Key Definition T R Example

y eq
pe

the following set of data includes information regarding the account that the consumer has
on the merchant website

CUSTOMERACCOUNTCREATEDA Date that the cardholder opened the account with the 3DS Requestor. N8 O Date format =
TE YYYYMMDD
Example: 20191231

CUSTOMERACCOUNTPASSWORD Date that cardholder’s account with the 3DS Requestor had a password change or account N8 O Date format =
CHANGEDATE reset. YYYYMMDD
Example: 20191231

Ingenico document - Reproduction or disclosure prohibited without written authorization

225
CUSTOMERACCOUNTPASSWORD Indicates the length of time since the cardholder’s account with the 3DS Requestor had a N2 O 1 = No change
CHANGEINDICATOR password change or account reset. 2 = Changed during
this transaction
3 = Less than 30
days
4 = 30-60 days
5 = More than 60
days

CUSTOMERACCOUNTNUMBEROF Number of purchases with this cardholder account during the previous six months. N4 O Example : 42
PURCHASESLASTSIXMONTHS

CUSTOMERACCOUNTNUMBEROF Number of Add Card attempts in the last 24 hours. N3 O Example : 547
ADDCARDATTEMPTSLAST24HOU
RS

CUSTOMERACCOUNTPAYMENTA Date that the payment account was enrolled in the cardholder’s account with the 3DS N8 O Date format =
CCOUNTONFILECREATEDATE Requestor. YYYYMMDD
Example: 20191231

CUSTOMERACCOUNTPAYMENTA Indicates the length of time that the payment account was enrolled in the cardholder’s N2 O 1 = No account
CCOUNTONFILEAGEINDICATOR account with the 3DS Requestor. (guest check-out)
2 = During this
transaction
3 = Less than 30
days
4 = 30-60 days
5 = More than 60
days

CUSTOMERACCOUNTSHIPPINGA Date when the shipping address used for this transaction was first used with the 3DS N8 O Date format =
DDRESSFIRSTUSAGEDATE Requestor. YYYYMMDD
Example: 20191231

Key Definition Type R Example

the following set of data gives more information regarding the order details

DELIVERYTIMEFR Indicates the merchandise delivery timeframe N1 O 1 = Electronic Delivery

AMEINDICATOR 2 = Same day shipping
3 = Overnight shipping
4 = Two-day or more shipping

PURCHASEDGIFTC For prepaid or gift card purchase, the purchase amount total of prepaid or N15 its number O for example, USD 123.45 is 123
ARDAMOUNT gift card(s) in major units probably, just like
payment amount

PURCHASEDGIFTC For prepaid or gift card purchase, total count of individual prepaid or gift N2 O
ARDCOUNT cards/codes purchased.

PURCHASEDGIFTC For prepaid or gift card purchase, the currency code of the card as defined AN3 O USD
ARDCURRENCYCO in ISO 4217
DE

PREORDEREDITE For a pre-ordered purchase, the expected date that the merchandise will N8 O Date format = YYYYMMDD
MSAVAILABILITYD be available. Example: 20191231
ATE

PREORDERINDICA Indicates whether Cardholder is placing an order for merchandise with a N1 O 1 = Merchandise available
TOR future availability or release date. 2 = Future availability

REORDERITEMSIN Indicates whether the cardholder is reordering previously purchased N1 O 1 = First time ordered
DICATOR merchandise 2 = Reordered

Ingenico document - Reproduction or disclosure prohibited without written authorization

226
SHIPPINGADDRES Indicates shipping method chosen for the transaction. N1 O 1 = Ship to cardholder’s billing
SINDICATOR Merchants must choose the Shipping Indicator code that most accurately address
describes the cardholder’s specific transaction, not their general business. 2 = Ship to another verified address
If one or more items are included in the sale, use the Shipping Indicator on file with merchant
code for the physical goods, or if all digital goods, use the Shipping 3 = Ship to address that is different
Indicator code that describes the most expensive item. than the cardholder’s billing address
4 = “Ship to Store” / Pick-up at local
store (Store address shall be
populated in shipping address fields)
5 = Digital goods (includes online
services, electronic gift cards and
redemption codes)
6 = Travel and Event tickets, not
shipped
7 = Other (for example, Gaming,
digital services not shipped, emedia
subscriptions, etc.)

CUSTOMERBILLIN Indicates whether the Cardholder Shipping Address and Cardholder Billing N1 O 1 = Shipping Address matches
GSHIPPINGADDRE Address are the same. Billing Address
SSMATCH 0 = Shipping Address does not
match Billing Address

THREEDSAUTHEN Indicates whether a challenge is requested for this transaction. N1 O 1 = No preference

TICATIONCHALLEN For example: 2 = No challenge requested
GEINDICATOR For 01-PA, a 3DS Requestor may have concerns about the transaction, 3 = Challenge requested: 3DS
and request a challenge. Requestor Preference
For 02-NPA, a challenge may be necessary when adding a new card to a 4 = Challenge requested: Mandate
wallet.
For local/regional mandates or other variables.

THREERIINDICATOR Indicates the type of 3RI request. ?

This data element provides additional information to the ACS to determine
the best approach for handing a 3RI request.

ACCOUNTTYPE Indicates the type of account. For example, for a multi-account card N1 O 1 = Not Applicable
product. (Required in some accounts) 2 = Credit
3 = Debit

Key Definition T R Example

y eq
pe

last section provides additional information

TRANSACTI Identifies the type of transaction that is being authenticated N2 O 01 =

ONTYPE Goods /
Service
purchase
03 =
Check
Acceptance

10 =
Account
Funding
11 =
Quasi-
Cash
Transaction

28 =
Prepaid
Activation
& Load

CHALLENGE Dimensions of the challenge window that has been displayed to the CH. ACS will reply with content that is formatted to N1 R 1 = 250x
WINDOWSIZE appropriately render in this window to provide the best user experience. Pre-configured sizes are width x height in pixels of 400
the window displayed in the CH browser window 2 = 390 x
400
3 = 500 x
600
4 = 600 x
400
5 = Full
Screen

METHODNO it is the end point of client application which will receive method notification from issuing bank A R
TIFICATION N
URL 2
0
48

CHALLENGE it is the end point of client application which will receive challenge notification from issuing bank A R
NOTIFICATI N
ONURL 2
56

ENDAUTHE Marker (no key) – O –

NTICATE

Ingenico document - Reproduction or disclosure prohibited without written authorization

227
Additional for invoice payments

Key Definition Type Req Example

COMPANYDATA Company data AN50 O Ltd.

COMPANYNAME Name of company AN40 O Cruijff Sports

COUNTRYCODE ISO 3166 country code AN2 R ES

CUSTOMERID ID of consumer AN15 O 1

ADDITIONALREFERENCE Additional reference to be printed on invoice AN20 O 3243243243

INVOICEDATE Date on which invoice is to be made N8 O 20030831

Invoice number

INVOICENUMBER INVOICENUMBER is required to facilitate matching for bank payments and bank transfer payments AN20 O 21212121

INVOICECLASS Future use AN10 O

l N=Invoice (default)

l NR=Reminder on invoice

INVOICETYPE l R=Renewal AN2 O R

l RR=Reminder on renewal

l M=Mailing

TITLE Title consumer AN35 O Mr.

Key Definition Type Req Example

A valid name and address are required to ensure correct delivery of the invoice

SEX Sex consumer (M or F or U) AN1 O M or F or U

First name

FIRSTNAME A valid name and address are required to ensure correct delivery of the invoice AN15 O Jack

In between first name and surname

PREFIXSURNAME A valid name and address are required to ensure correct delivery of the invoice AN15 O van

Last name of consumer

SURNAME A valid name and address are required to ensure correct delivery of the invoice AN35 R Buuren

Street address of consumer

STREET A valid name and address are required to ensure correct delivery of the invoice AN50 R Polarisavenue

House number address of consumer

HOUSENUMBER A valid name and address are required to ensure correct delivery of the invoice AN15 O 1

Additional address information

ADDITIONALADDRESSINFO A valid name and address are required to ensure correct delivery of the invoice AN50 O A

Zip code address of consumer

ZIP A valid name and address are required to ensure correct delivery of the invoice AN10 O 1000 AA

City of consumer

CITY A valid name and address are required to ensure correct delivery of the invoice AN40 R New York

State address of consumer

STATE A valid name and address are required to ensure correct delivery of the invoice AN35 O New York

LANGUAGECODE ISO 639 language code of consumer AN3 O en

Ingenico document - Reproduction or disclosure prohibited without written authorization

228
We recommend that you exclude the HOUSENUMBER key if a house number is already included with the street information. WebCollect checks for a
house number and a street, and the AVSDATA1 populates with the house number and street. If the house number is present in both places, the
AVSDATA1 populates with two house numbers followed by the street. This could cause a failure of the AVS check.

Example with house number in HOUSENUMBER key

HOUSENUMBER: 12

STREET: Bundles Clay Lane South Nutfield AVSDATA1:12 Bundles Clay Lane

Example with house number in STREET key HOUSENUMBER: Empty

STREET: 12 Bundles Clay Lane South Nutfield AVSDATA1:12 Bundles Clay Lane

Example with house number in both HOUSENUMBER and STREET keys

HOUSENUMBER: 12

STREET: 12 Bundles Clay Lane South Nutfield AVSDATA1:12 12 Bundles Clay L

Additional for real-time bank transfer payments

l IBAN and BIC are optional for transactions using Sofortüberweisung in Germany

l This feature of payment product Sofortüberweisung (836) is only supported in Germany (DE)

Key Definition Type Req Example

COMPANYDATA Company data AN50 O Ltd.

Key Definition Ty R Example

pe eq

COMPANYNAME Name of company AN O Cruijff Sports

COUNTRYCODE ISO 3166 country code AN2 R ES

ID of consumer

CUSTOMERID For UnionPay International, CUSTOMERID cannot contain spaces AN O 1

INVOICENUMBER Invoice number AN O 21212121

TITLE Title consumer AN O Mr.

FIRSTNAME First name AN O Jack

PREFIXSURNAME In between first name and surname AN O van

SURNAME Last name of consumer AN O Buuren

STREET Street address consumer AN O Polarisavenue

Ingenico document - Reproduction or disclosure prohibited without written authorization

229
HOUSENUMBER House number address consumer AN O 1
15

ADDITIONALADDRES Additional address information AN O A

SINFO 50

ZIP Zip code address consumer AN O 1000 AA

CITY City of consumer AN O New York

STATE State address consumer AN O New York

LANGUAGECODE ISO 639 language code of consumer AN3 R En

IBAN International bank account number of the consumer AN O DE46940594210000

50 012345

BIC Bank identification code for the consumer AN O TESTDETT421

ID of the issuing bank of the consumer

ISSUERID is required for iDEAL (809) in the Netherlands (NL) when you are not using
HostedMerchantLink
ISSUERID AN O ABNANL2A
11

Expiration period in minutes (maximum 60 minutes both for iDEAL and eCard, maximum 120 minutes
for Sofort)

The consumer has to perform the payment before the end of this period

Default=60

EXPIRATIONPERIOD is optional for Sofort (836) iDEAL (809) and eCard (402) and for all transactions
EXPIRATIONPERIOD that use HostedMerchantLink N4 O 15

Additional for CashU

Key Definition Type Req Example

CITY City of consumer AN40 R New York

Additional for Konbini

Key Definition Type Req Example

EMAIL Email address of consumer AN70 R [email protected]

PHONENUMBER Phone number consumer AN20 R +34201234567

CITY City of consumer AN40 R New York

Additional for direct debit payments

Key Definition Type Req Example

COMPANYDATA Company data AN50 O Ltd.

COMPANYNAME Name of company AN40 O Cruijff Sports

COUNTRYCODE ISO 3166 Country code AN2 R ES

CUSTOMERID ID of consumer AN15 O 1

TITLE Title consumer AN35 O Mr.

FIRSTNAME First name AN15 O Jack

PREFIXSURNAME In between first name and surname AN15 O van

SURNAME Last name of consumer AN35 R Buuren

Ingenico document - Reproduction or disclosure prohibited without written authorization

230
STREET Street address consumer AN50 R Polarisavenue

HOUSENUMBER House number address consumer AN15 O 1

ADDITIONALADDRESSIN Additional address information AN50 O A

ZIP Zip code address consumer AN10 R 1000 AA

CITY City of consumer AN40 R New York

STATE State address consumer AN35 O New York

BANKCODE Depends on the payment product that is used –

BANKNAME Depends on the payment product that is used –

BRANCHCODE Depends on the payment product that is used –

BANKCHECKDIGIT Depends on the payment product that is used –

ACCOUNTNUMBER Depends on the payment product that is used –

ACCOUNTNAME Depends on the payment product that is used –

DATECOLLECT Depends on the payment product that is used Format:

YYYYMMDD

DIRECTDEBITTEXT Depends on the payment product that is used –

AUTHORISATIONID Depends on the payment product that is used –

l 0=Do not send a pre-notification email to the consumer

l 1=Send a pre-notification email to the consumer on the first collection

The email is sent from your email address

PRENOTIFICATION PRENOTIFICATION is required for transacations via HostedMerchantLink AN1 O 1

CUSTOMERBANKSTREET Depends on the payment product that is used –

CUSTOMERBANKNUMBER Depends on the payment product that is used –

CUSTOMERBANKZIP Depends on the payment product that is used –

CUSTOMERBANKCITY Depends on the payment product that is used –

Depends on payment product

TRANSACTIONTYPE is required for SEPA direct debit transactions (payment product 770)—
Values can be
TRANSACTIONTYPE AN2 O –
l S=One-off

Key Definition Type Req Example

l F=First recurring

l R=Second and subsequent recurring

l L=Last recurring

IBAN Depends on the payment product that is used –

ADDRESSLINE Depends on the payment product that is used –

Additional for cash payments

New validation rules for Registered Boleto Bancario:

l For all the below fields only uppercase letters (A-Z) and digits (0-9) are allowed . No Portuguese diacritics are allowed.

l Only one space between words is allowed.

l Only "-" (dash) and " ' " (apostrophe) allowed as special characters.

l When "-" or " ' " are used, no spaces are allowed between words. For example: D'EL-REI is correct, D'EL - REI is incorrect.

l For business consumer COMPANYNAME and FISCALNUMBER (CNPJ) are required.

Ingenico document - Reproduction or disclosure prohibited without written authorization

231
l For non-business consumer FIRSTNAME, SURNAME and FISCALNUMBER (CPF) is required.

l STREET, HOUSENUMBER and ADDITIONALADDRESSINFO combined must be less than AN52.

Key Definition Type R Example

COMPANYNA Name of company AN40 R Carlos LTDA

FISCALNUMBER Fiscal registration number of AN11 R 21298750091

the consumer (CPF)

FISCALNUMBER Tax registration number of AN14 R 73400584000166

the company for a business
consumer (CNPJ)

FIRSTNAME First name AN15 R Carlos

PREFIXSURNA In between first name and This is not used for registered Boleto O
ME surname

SURNAME Last name of consumer AN35 R Albuquerque

STREET Street address consumer AN50 R R Jose Soares de Macedo

Note: STREET, HOUSENUMBER and

ADDITIONALADDRESSINFO combined must be less than AN52

HOUSENUMB House number address AN15 R 29

ER consumer
Note: STREET, HOUSENUMBER and
ADDITIONALADDRESSINFO combined must be less than AN52

ADDITIONALA Additional address AN50 O 2nd floor

DDRESSINFO information
Note: STREET, HOUSENUMBER and
ADDITIONALADDRESSINFO combined must be less than AN52

ZIP Zip code address consumer AN8 R 08151010

Note: Can only contain digits (0-9) and should be valid against the
STATECODE. See the ZIP-STATECODE table below.

CITY City of consumer AN20 R Sao Paulo

STATE State address consumer This is not used for registered Boleto O

STATECODE State code of the consumer AN2 R SP

Please see the ZIP-STATECODE tabl

e below for the valid state codes.

EMAIL Email address of the This is not used for registered Boleto O
consumer

Valid ZIP STATECODE combination for Registered Boleto Bancario

Low Range High Range STATECODE Description

1000000 9999999 SP Sao Paulo Metropolitan Region including the suburbs or the area outside the Sao Paulo metropolitan region

11000000 19999999 SP State of Sao Paulo

20000000 28999999 RJ State of Rio de Janeiro

29000000 29999999 ES State of Espirito Santo

30000000 39999999 MG State of Minas Gerais

40000000 48999999 BA State of Bahia

49000000 49999999 SE State of Sergipe

50000000 56999999 PE State of Pernambuco

57000000 57999999 AL State of Alagoas

58000000 58999999 PB State of Paraiba

59000000 59999999 RN State of Rio Grande do Norte

60000000 63999999 CE State of Ceara

64000000 64999999 PI State of Piaui

65000000 65999999 MA State of Maranhao

66000000 68899999 PA State of Para

68900000 68999999 AP State of Amapa

69000000 69299999 AM State of Amazonas (part 1)

69300000 69399999 RR State of Roraima

Ingenico document - Reproduction or disclosure prohibited without written authorization

232
69400000 69899999 AM State of Amazonas (part 2)

69900000 69999999 AC State of Acre

70000000 72799999 DF Federal District (part 1)

72800000 72999999 GO State of Goias (part 1)

73000000 73699999 DF Federal District (part 2)

73700000 76799999 GO State of Goias (part 2)

76800000 76999999 RO State of Rondonia (part 1)

77000000 77999999 TO State of Tocantins

78000000 78899999 MT State of Mato Grosso

78900000 78999999 RO State of Rondonia (part 2)

79000000 79999999 MS State of Mato Grosso do Sul

80000000 87999999 PR State of Parana

88000000 89999999 SC State of Santa Catarina

90000000 99999999 RS State of Rio Grande do Sul

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 –

Key Definition Type Example

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

Format:
YYYYMMDDHHMMSS
RESPONSEDATETIME N14 20130604123456

ENDMETA Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 21000020

Message for error or event REQUEST {0} VALUE {1} OF FIELD CREDITCARDNUMBER DID NOT PASS THE
LUHNCHECK
MESSAGE AN4000

ENDERROR Marker (no key) – –

Additional for online credit card payments

Key Definition Type Example

ROW Marker (no key) – –

PAYMENTREFERENCE Reference given by Ingenico ePayments to payment AN12 –

ADDITIONALREFERENCE Additional reference AN20 –

Ingenico document - Reproduction or disclosure prohibited without written authorization

233
External Reference of credit card payment, this value should be used as
REFERENCEORIGPAYMEN

T in eventual refunds (see DO_ REFUND)

If you provide a reference and

l ORDERTYPE=1 the return is 30 characters

l ORDERTYPE=4 the return

is 30 characters

If you do not provide a reference and

l ORDERTYPE=1 the return is 30 characters

l ORDERTYPE=4 the return

EXTERNALREFERENCE AN30 000000000100002121210000
is 25 characters 10000

ORDERID Unique order ID generated by Ingenico ePayments N10 9998890004

SCHEMETRANSACTIONIDENTI Unique transaction identifier returned by scheme. AN15 AS37504079V1664

FIE R

STATUSID Status N5

EFFORTID Payment effort N5 –

MERCHANTID Merchant ID given by Ingenico ePayments N4 –

Key Definition Type Example

Indicates how many attempts have been made for this payment

ATTEMPTID N5 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

SCHEMETRANSACTI Unique transaction identifier returned by Visa and Mastercard for Pre AN AS37504079V1664
ONID Authorization, Recurring and UCOF transactions 15

INITIALSCHEMETRAN The transaction ID given by Visa and Mastercard after the First AN MC1238743876289
SACTIONID Recurring/First UCOF/Pre Authorization 15

Result of the AVS service

AVSRESULT The results that return depend on the checks performed AN1 Z

Result of the CVV2/CVC2 service

The results that return depend on the checks performed

CVVRESULT AN1 M

Result of the fraud service

FRAUDRESULT The results that return depend on the checks performed AN1 D

Result of the fraud service

FRAUDCODE The results that return depend on the checks performed AN4 0000

FRAUDNEURAL Result of the fraud service AN4 150

FRAUDRCF Result of the fraud service AN GEO, TUMBLES, PHONEVEL, HIGHUSE

400

Authorization code

AUTHORISATIONCODE

AUTHORISATIONCODE appears only when configured by Ingenico ePayments AN 321234

ACSURL URL for redirection of consumer AN Returned after CheckEnrollment with enrolled consumer
255

PAREQ Pareq for redirection—Should be used as hidden key AN Returned after CheckEnrollment with enrolled consumer
4000

Transaction ID for redirection— Should be used as hidden key (for Returned after CheckEnrollment with enrolled consumer
VISA only) and after a valid AuthenticationValidation
XID AN
50

DIRECTORYSERVERT Universally unique transaction identifier assigned by the Directory AN

RANSACTIONID Server (schemes) to identify a single transaction 36

Ingenico document - Reproduction or disclosure prohibited without written authorization

234
THREEDSPROTOCOL the most recent active protocol version that is supported by the ?
VERSION Directory server

Merchant data key for redirection—Should be used as hidden key Returned after CheckEnrollment with enrolled consumer

MD AN
50

PROOFXML Proof XML message AN Returned after CheckEnrollment with enrolled consumer
4000

Provides an additional means of reconciliation for Gateway merchants

Must be configured to be returned

SERVICEPROVIDERID AN –
64

PROVIDERREFEREN Provides an additional means AN –

CE 64

Key Definition Type Example

of reconciliation for Gateway merchants

Must be configured to be returned

ENDROW Marker (no key) – –

Additional information when credit card processing is done with 3D v2 via Ingenico

Key Definition T Example

y
pe

ROW Marker (no key) –

THREEDSSER 3ds server transaction id (send by DO_PAYMENT/IOWP A

VERTRANSAC response) N
TIONID 36

CUSTOMERTH CardHolder 3D authentication method N2

REEDMETHOD

CUSTOMERTH CardHolder 3D authentication timestamp N

REEDDATE 12

CUSTOMERTH CardHolder 3D authentication reference A -

REEDREF N
36

ACSTRANSAC Universally Unique transaction identifier assigned by the A

TIONID ACS to identify a single transaction. N
36

THREEDSMET ACS Method URL to redirect A

HODURL N
256

THREEDSMET Contain data of 3DS Method Notification URL and A

HODURLDATA ThreeDS Server tx id in base64 encoded format N
50
00

ACSCHALLEN Indication of whether a challenge is required for the A1 Values accepted:

GEMANDATED transaction to be authorised due to local/regional • Y = Challenge is mandated
mandates or other variable. • N = Challenge is not mandated

REDIRECTINFO Marker (no key) –

FORMMETHOD http method type - POST A

PROVIDERURL Redirect URL A

N
20
48

FORMPARAME form parameters submitted to http form post A

TERS N
50
00

Ingenico document - Reproduction or disclosure prohibited without written authorization

235
ENDREDIRECT Marker (no key) –
INFO

ENDROW Marker (no key) –

Additional for batch credit card payments

Key Definition Ty Example

ROW Marker (no key) – –

PAYMENTREFER Reference of the payment (with Batch Credit Card payments always 0) AN 0
ENCE 12

ADDITIONALREFE Additional reference AN –

RENCE 20

External Reference of credit card payment, this value should be used as REFERENCEORIGPAYMENT in
eventual refunds (see DO_REFUND)
EXTERNALREFER AN 000000000100002121210
ENCE 30 000100001

ORDERID Unique order ID generated by Ingenico ePayments N10 9998890004

STATUSID Status N5

CURRENCYCODE ISO 4217 currency code AN3 EUR

AMOUNT Amount N12 –

STATUSDATE Date and time of payment N14 20130604123456

Format: YYYYMMDDHH24MISS

ENDROW Marker (no key) – –

Additional for invoice payments

Key Definition Type Example

ROW Marker (no key) – –

PAYMENTREFERENCE Reference given by Ingenico ePayments to payment AN12 –

ADDITIONALREFERENCE Additional reference AN20 –

EXTERNALREFERENCE External Reference AN30 000000000100002121210000100001

ORDERID Unique order ID generated by Ingenico ePayments N10 9998890004

STATUSID Status N5

CURRENCYCODE ISO 4217 currency code AN3 EUR

AMOUNT Amount N12 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

ENDROW Marker (no key) – –

Additional for BPAY—Australia (500)

Key Definition Type Example

ROW Marker (no key) – –

Key Definition Type Example

STATUSID Status N5

Ingenico document - Reproduction or disclosure prohibited without written authorization

236
Reference to be used by consumer for payment

CUSTOMERPAYMENTREFERENC

E and BILLERID must be provided to the consumer for BPAY even though the Ingenico
ePayments bank details are returned
CUSTOMERPAYMENTREF N15 001234567890120
EREN CE

ADDITIONALREFERENCE Additional reference AN20

ACCOUNTHOLDER Name of Account holder to pay to AN50 Ingenico ePayments

EXTERNALREFERENCE External reference AN30 000000000100002121210

0001000

ORDERID Unique order ID generated by Ingenico ePayments N10 9998890004

EFFORTID Payment effort N5

Reference given by Ingenico ePayments to payment or taken from the input tag
OVERWRITEPAYMENTREFEREN CE

PAYMENTREFERENCE is

generated by Ingenico ePayments

PAYMENTREFERENCE AN12

ATTEMPTID Attempt number N5

BANKACCOUNTNUMBER Bank account number AN50 062000-11002112

CITY City of the bank to pay to AN50 Sydney

SWIFTCODE Swift code of bank (if applicable) AN2 CTBAAU2S

COUNTRYDESCRIPTION Country of bank AN50 Australia

BANKNAME Name of bank to pay to AN55 Commonwealth Bank

The biller identifier allocated to Ingenico ePayments

CUSTOMERPAYMENTREFERENC

E and BILLERID must be provided to the consumer for BPAY even though the Ingenico
ePayments bank details are returned
BILLERID AN27 747089 - Ingenico
ePayments

CURRENCYCODE ISO 4217 currency code AN3 AUD

AMOUNT Amount N12 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

ENDROW Marker (no key) – –

Additional for direct debit payments

Key Definition Type Example

ROW Marker (no key) – –

ADDITIONALREFERENCE Additional reference AN20 –

EXTERNALREFERENCE External Reference AN30 000000000100002121210000100001

ORDERID Unique order ID generated by Ingenico ePayments N10 9998890004

STATUSID Status N5

CURRENCYCODE ISO 4217 currency code AN3 EUR

AMOUNT Amount N12 –

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

ENDROW Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

237
Additional for cash payments

Key Definition Type Example

ROW Marker (no key) – –

MERCHANTID Merchant ID generated by Ingenico ePayments N4 –

Unique order ID generated by Ingenico ePayments

ORDERID N10 9998890004

EFFORTID Payment effort N5 –

Indicates how many attempts have been made for this payment

ATTEMPTID N5 –

ADDITIONALREFEREN CE Additional reference AN20 –

EXTERNALREFERENC E External reference AN30 000000000100002121210000100001

Reference given by Ingenico ePayments to payment

PAYMENTREFEREN

CE is generated by Ingenico ePayments

For Western Union payments, PAYMENTREFEREN

CE is the Western Union account number

PAYMENTREFERENCE AN12

STATUSID Status N5

Date and time of payment

STATUSDATE Format: N14 20130604123456

Key Definition Type Example

YYYYMMDDHH24MI SS

Method to be used when redirecting

FORMMETHOD and FORMACTION are

only returned for the cash Brazil payment product

(1503), Boleto Bancário

FORMMETHOD AN4 GET

URL of the Boleto Bancário

FORMMETHOD and FORMACTION are

only returned for the cash Brazil payment product

(1503), Boleto Bancário
AN4 HTTPS://homologacao.pagador.com.br/pagador/reenvia.a sp?
00 0 Id_Transacao=86d61e41-f1ae-43a1-be62- bd3c7=j88d5c
FORMACTION

Provides an additional means of reconciliation for

Gateway merchants

Must be configured to be returned

SERVICEPROVI AN16 –
DERID

Provides an additional means of reconciliation for

Gateway merchants

Must be configured to be returned

PROVIDERREFE AN16 –
RENC E

ENDROW Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

238
Additional for real-time bank transfer payments

Key Definition Type Example

ROW Marker (no key) Type –

MERCHANTID Merchant ID generated by Ingenico ePayments N4 –

ORDERID Unique order ID generated by Ingenico ePayments N10 9998890004

EFFORTID Payment effort N5 –

ATTEMPTID Indicates how many attempts have been made for this payment N5 –

Reference generated by Ingenico ePayments to payment

PAYMENTREFERENCE PAYMENTREFERENCE is generated by AN12

Key Definition Type Example

Ingenico ePayments and must be provided to the consumer as a reference to be used for the
payment

ADDITIONALREFEREN Additional reference AN20 –

EXTERNALREFERENCE External reference AN30 000000000100002121210000100

001

STATUSID Status N5

Date and time of payment

STATUSDATE Format: YYYYMMDDHH24MISS N14 20130604123456

... < payment product depending keys > – –

... < see table below > – –

ENDROW Marker (no key) – –

Additional for HostedMerchantLink

Here are the different responses. All these keys are communicated to the bank.

l The FORMMETHOD key describes the method used to communicate values to the bank—GET or POST

l The FORMACTION key indicates the target of the POST or GET, which is the URL of the real-time bank payment page

l For GiroPay (816), iDEAL (809), and Raifeissen ELBA (820), no values need to be posted by you to the real-time

bank—Ingenico ePayments provides the complete URL to be used to redirect the consumer

Key Definition Type Example

Method to be used when redirecti ng

FORMME
THOD
AN4 GET

Ingenico document - Reproduction or disclosure prohibited without written authorization

239
URL to be used when redirecti ng the consum er
including the REF and the MAC

FORMAC AN4 HTTPS://ps.gcsip.com/orb/orb?REF=000000999121100001480000100001&MAC=oWSxU

TION 000 gytMXY7sO+aaE+42dA2mCZxdnWwQUptcdSm/oI=

REF Referen ce AN5 000000999121100001480000100001

MAC Signatur e AN5 oWSxUgytMXY7sO+aaE+42dA2mCZxdnWwQUptcdSm/oI=

RETURN Signatur AN5 8USyNDgjCEF2iVVYguLo5SE2RC967FTKTpW5SBeCrwI=

MAC 12

Key Definition Type Example

e used by Ingenico ePayme nts in conjunct ion with the provided RETUR NURL

and the REF

Additional for Nordea E-maksu—Finland (802)

Key Definition Type Example

FORMMETHOD Method to be used when redirecting AN4 POST

FORMACTION URL to be used when redirecting the consumer AN2 HTTPS://solo3.nordea.fi:443/cgi- bin/SOLOPM01
50

SOLOPMT_ CUR Currency of payment AN3 EUR

SOLOPMT_ Amount with dot to separate the decimals N12 299.00

AMOUNT

SOLOPMT_ Payment version AN4 0002

VERSION

SOLOPMT_ STAMP Unambiguous code for technical specification of the payment AN20 Displays the MERCHANTID (5) + ORDERID (10) +
EFFORTID (5)

SOLOPMT_ RCV_ID Merchant's agreement Number AN10 As supplied by the bank

SOLOPMT_ l 1=Finnish
LANGUAGE
l 2=Swedish N1

l 3=English

SOLOPMT_ REF Standard reference on the payment AN20 Displays the PAYMENTREFERENCE

SOLOPMT_ DATE EXPRESS or the payment due date AN10 EXPRESS

SOLOPMT_ MSG Message for the account statement of the consumer, as provided to AN2 –
Ingenico ePayments 34

SOLOPMT_ Return address following payment, as provided to Ingenico ePayments AN1

RETURN 20

SOLOPMT_ Return address if payment is cancelled, as provided to Ingenico AN1

CANCEL ePayments 20

SOLOPMT_ Return address if payment is rejected, as provided to Ingenico ePayments AN1

REJECT 20

SOLOPMT_ Checksum of the payment details AN32

Ingenico document - Reproduction or disclosure prohibited without written authorization

240
Key Definition Type Example

MAC

SOLOPMT_ CONFIRM If confirmation of payment is required AN3 YES

SOLOPMT_ KEYVERS Example: 0001 N4 0001

Additional for Nordea E-Betaling—Denmark (803)

Key Definition Type Example

FORMMETHOD Method to be used when redirecting AN4 POST

FORMACTION URL to be used when redirecting the consumer AN250 HTTPS://solo3.nordea.fi:443/cgi- bin/SOLOPM01

SOLOPMT_ CUR Currency of payment AN3 DKK

SOLOPMT_ AMOUNT Amount with dot to separate the decimals N12 299.00

SOLOPMT_ Payment version AN4 0002

VERSION

SOLOPMT_ STAMP Unambiguous code for technical specification of the payment AN20 Displays the MERCHANTID (5) + ORDERID (10) +
EFFORTID (5)

SOLOPMT_ RCV_ID Merchant's agreement Number AN10 As supplied by the bank

l 1=Finnish

SOLOPMT_ l 2=Swedish
LANGUAGE
l 3=English N1 5

l 4=Estonian

l 5=Danish

SOLOPMT_ REF Standard reference on the payment AN20 Displays the PAYMENTREFERENCE

SOLOPMT_ DATE EXPRESS or the payment due date AN10 EXPRESS

SOLOPMT_ MSG Not used for Nordea E-betaling—Denmark AN234 –

SOLOPMT_ RETURN Return address following payment, as provided to Ingenico AN120

ePayments

SOLOPMT_ CANCEL Return address if payment is cancelled, as provided to Ingenico AN120

ePayments

SOLOPMT_ REJECT Return address if payment is rejected, as provided to Ingenico AN120

ePayments

SOLOPMT_ MAC Checksum of the payment details AN32

SOLOPMT_ Confirmation of the payment YES (or NO) AN3 YES

CONFIRM

SOLOPMT_ Example: 0001 N4 0001

KEYVERS

Additional for Nordea E-betalning—Sweden (805)

Key Definition Type Example

Ingenico document - Reproduction or disclosure prohibited without written authorization

241
FORMMETHOD Method to be used when redirecting AN4 POST

FORMACTION URL to be used when redirecting the consumer AN2 HTTPS://gfs.nb.se:443/e- betalning/direktbetalning
50

NB_VERSION Version of the Nordea system AN4 0001

NB_RCV_ID Account at the Nordea system AN14

NB_DB_CUR Currency code of the payment AN3 SEK

NB_DB_ AMOUNT Payment amount (with comma for decimals) N12 29,95

NB_STAMP Unambiguous code for technical specification of the payment AN20 Displays the MERCHANTID (5)+ORDERID (10)
+EFFORTID (5)

NB_DB_REF Standard reference on the payment N25 Displays the PAYMENTREFERENCE

NB_HMAC Signature of the payment request AN32

NB_CANCEL Return URL if payment is cancelled by consumer AN1

NB_REJECT Return URL if payment is rejected by Nordea system AN1

NB_RETURN Return URL if payment was completed AN1

NB_KVV

SOLOPMT_ Not used for Nordea Sweden N1 1

LANGUAGE

SOLOPMT_ DATE Not used for Nordea Sweden AN10 EXPRESS

SOLOPMT_ Not used for Nordea Sweden N4 0001

KEYVERS

SOLOPMT_ Not used for Nordea Sweden AN3 YES

CONFIRM

SOLOPMT_ MSG Message for the account statement of the consumer, as provided to AN2 –
Ingenico ePayments 34

Additional for iDEAL—Netherlands (809)

Key Definition Type Example

FORMMETH Method to be used when redirecting

OD
AN4 GET

URL to be used when redirecting the

consumer
FORMACTIO AN4 HTTPS://ideal.abnamro.nl/nl/consumer/ProcessTransaction?ideal=1&ingewikkeld
N 000 ecode=123&trxid=123456789112

TRANSACTI Unique ID assigned by the acquiring

ONID
N16 1234123456789012

Key Definition Type Example

bank— Appears on the bank statement of the consumer

Ingenico document - Reproduction or disclosure prohibited without written authorization

242
Additional code provided with the RETURNUR

L after the transaction— Use this to check if the combination of this key and the provided
TRANSACTI ONID

correspond to an order

ENTRANCE
CODE
AN40 0000000001999892061400001000018303
610187

Additional for GiroPay—Germany (816)

Key Defini tion Typ e Example

Met hod to be used whe n redir ectin

FORM METH
OD
AN 4 GET

URL

to be

used

whe n redir ectin

FORM ACTIO N g the AN HTTPS://testpm.pago.de/perl/mp/process/multipay?SessionID=895587601&err=HTTPS%3A%

400 2F
cons

umer 0 %2Fps.gcsip.nl%2Fwdl%2FRequestInfo.jsp%3FRETURNSTATUS%3DCANCEL%26&ibv=1

358Additional for PaySafeCard—Various countries (830)

Key Definiti on Type Example

Metho d to be used when

redire cting

FORMMET AN
HOD 4
GET

URL

to be

used

when redire cting AN

400
FORMACTI the HTTPS://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet?mid=
ON 0 1000000433&mtid=999100579019&amount=1.00&currency=EUR&language=de
consu

mer

Ingenico document - Reproduction or disclosure prohibited without written authorization

243
Allow s passi ng ID of
client to Paysa fecard

MERCHAN AN 1234567890abcdefGHIJK
TCLIENTID 50

Additional for PayPal—Various countries (840)

Key Definitio n Type Example

Method to be used when redirect ing

FORMMET
HOD
AN4 GET

URL to be used when redirect ing

the consu mer

FORMACTI AN40 HTTPS://ps.gcsip.nl/orb/orb?ACTION=DO_

ON 00 START&REF=000000999120080331010000100001&MAC=RbSBcK%2FfTst7Xa3ahDgJ

hvoSHb0lbTVjdbh66flV1Wo%3D

Example—Bank payment

<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

<FIRSTNAME>Johan</FIRSTNAME>

<SURNAME>Cruijff</SURNAME>

<CITY>Barcelona</CITY>

Ingenico document - Reproduction or disclosure prohibited without written authorization

244
<STATE>Catalunie</STATE>

<EMAIL>[email protected]</EMAIL>

<COMPANYNAME>Cruijff Sports</COMPANYNAME>

</ORDER>

<INVOICELINEDATA>invoiceline 1</INVOICELINEDATA>

<FREETEXT>freetext</FREETEXT>

</ORDERLINE>

<INVOICELINEDATA>invoiceline 2</INVOICELINEDATA>

<FREETEXT>freetext</FREETEXT>

</ORDERLINE>

</ORDERLINES>

<CITY>Barcelona</CITY>

</PAYMENT>

</PARAMS>

</REQUEST>

Ingenico document - Reproduction or disclosure prohibited without written authorization

245
</XML>

Possible response
<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

<FIRSTNAME>Johan</FIRSTNAME>

<SURNAME>Cruijff</SURNAME>

<CITY>Barcelona</CITY>

<STATE>Catalunie</STATE>

<EMAIL>[email protected]</EMAIL>

<COMPANYNAME>Cruijff Sports</COMPANYNAME>

</ORDER>

<INVOICELINEDATA>invoiceline 1</INVOICELINEDATA>

Ingenico document - Reproduction or disclosure prohibited without written authorization

246
<FREETEXT>freetext</FREETEXT>

</ORDERLINE>

<INVOICELINEDATA>invoiceline 2</INVOICELINEDATA>

<FREETEXT>freetext</FREETEXT>

</ORDERLINE>

</ORDERLINES>

<CITY>Barcelona</CITY>

</PAYMENT>

</PARAMS>

<META>

</META>

<ROW>

<ACCOUNTHOLDER>GlobalCollect BV</ACCOUNTHOLDER>

<CITY>Amsterdam</CITY>

<BANKNAME>ABN AMRO Bank</BANKNAME>

Ingenico document - Reproduction or disclosure prohibited without written authorization

247
<STATUSID>800</STATUSID>

<COUNTRYDESCRIPTION>Nederland</COUNTRYDESCRIPTION>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Example—Direct debit payment

<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

</ORDER>

<ACCOUNTNAME>Cruijff</ACCOUNTNAME>

<SURNAME>Cruijff</SURNAME>

<CITY>Barcelona</CITY>

Ingenico document - Reproduction or disclosure prohibited without written authorization

248
<DIRECTDEBITTEXT>00000000019998990011</DIRECTDEBITTEXT>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

</ORDER>

<ACCOUNTNAME>Cruijff</ACCOUNTNAME>

<SURNAME>Cruijff</SURNAME>

<CITY>Barcelona</CITY>

Ingenico document - Reproduction or disclosure prohibited without written authorization

249
</PAYMENT>

</PARAMS>

<META>

</META>

<ROW>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Example—Credit card payment

<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

</ORDER>

Ingenico document - Reproduction or disclosure prohibited without written authorization

250
<PAYMENTPRODUCTID>1</PAYMENTPRODUCTID>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response A
<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

</ORDER>

</PAYMENT>

Ingenico document - Reproduction or disclosure prohibited without written authorization

251
</PARAMS>

<META>

</META>

<ROW>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Possible response B
…

<META>

</META>

<ERROR>

REQUEST 1212121 VALUE 4567350000427976 OF FIELD CREDITCARDNUMBER DID NOT PASS THE LUHNCHECK

</MESSAGE>

</ERROR>

</RESPONSE>

Response with AVS, CVV, fraud, and authorization code

…

Ingenico document - Reproduction or disclosure prohibited without written authorization

252
<RESULT>OK</RESULT>

<META>

</META>

<ROW>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Example—Real-time bank transfer payments Nordea E-Betalning—Sweden (805)

<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

<CITY>Stockholm</CITY>

</ORDER>

Ingenico document - Reproduction or disclosure prohibited without written authorization

253
<PAYMENTPRODUCTID>805</PAYMENTPRODUCTID>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

iDEAL—Netherlands (809)
<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

<CITY>Amsterdam</CITY>

<DESCRIPTOR>Some order description</DESCRIPTOR>

</ORDER>

<CITY>Amsterdam</CITY>

<ISSUERID>ABNANL2A</ISSUERID>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

254
Possible response
<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

… // Parameters from above

</PARAMS>

<META>

</META>

<ROW>

HTTPS://ideal.abnamro.nl/nl/consumer/ProcessTransaction?ideal=1&ingewikkeldecode=123&trxid=123456789112<F ORMACTION>

<ENTRANCECODE>0000000001999892061400001000018303610187

</ENTRANCECODE>

<DESCRIPTION>Some order description</DESCRIPTION>

</ROW>

Ingenico document - Reproduction or disclosure prohibited without written authorization

255
</RESPONSE>

</REQUEST>

</XML>

PayPal (840)
<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

<FIRSTNAME>Jopie</FIRSTNAME>

<PREFIXSURNAME>-El Salvador-</PREFIXSURNAME>

<SURNAME>Cruijff</SURNAME>

<CITY>San Francisco</CITY>

<MERCHANTREFERENCE>Fussbalschuhe</MERCHANTREFERENCE>

</ORDER>

Ingenico document - Reproduction or disclosure prohibited without written authorization

256
<HOSTEDINDICATOR>1</HOSTEDINDICATOR>

<RETURNURL>HTTPS://www.globalcollect.com/</RETURNURL>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

<FIRSTNAME>Jopie</FIRSTNAME>

<PREFIXSURNAME>-El Salvador-</PREFIXSURNAME>

<SURNAME>Cruijff</SURNAME>

<CITY>San Francisco</CITY>

<MERCHANTREFERENCE>Fussbalschuhe</MERCHANTREFERENCE>

</ORDER>

Ingenico document - Reproduction or disclosure prohibited without written authorization

257
<AMOUNT>100</AMOUNT>

<RETURNURL>HTTPS://www.globalcollect.com/</RETURNURL>

</PAYMENT>

</PARAMS>

<META>

</META>

<ROW>

<RETURNMAC>e3dIA+1e7R0T4rkNfmpIurhBm9ADSMuGIVSA7lu3d9o=</RETURNMAC>

<ADDITIONALREFERENCE>Fussbalschuhe</ADDITIONALREFERENCE>

<EXTERNALREFERENCE>Fussbalschuhe</EXTERNALREFERENCE>

<MAC>RbSBcK/fTst7Xa3ahDgJhvoSHb0lbTVjdbh66flV1Wo=</MAC>

<FORMACTION>HTTPS://ps.gcsip.nl/orb/orb?ACTION=DO_ START&REF=000000999120080331010000100001&MAC=RbSBcK%
2FfTst7Xa3ahDgJhvoSHb0lbTVjdbh66flV1Wo

%3D</FORMACTION>

</ROW>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

258
INVALIDATE_PROFILE

This API call informs Ingenico ePayments about the invalidation of a

l Mandate for SEPA

l Profile for tokenization

The invalidate profile structure is REQUEST

ACTION META PARAMS

PROFILE

Input keys

Key Definition Type Req Example

ACTION INVALIDATE_PROFILE AN R INVALIDATE_PROFILE

META Marker (no key) – –

MERCHANTID ID of merchant N10 R 1

VERSION Version of interface AN10 R 1.0

ENDMETA Marker (no key) – –

PARAMS Marker (no key) – R –

PROFILE Marker (no key) – R –

PROFILETOKEN Token for the next payment; only if OK AN40 R {323529-235795d-232957- 9823759}

Date of the mandate cancellation signature

MANDATECANCELDATE Format: MMMMYYDD N8 O 20130101

ENDPROFILE Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

Result of the action

RESULT l OK AN3 OK

l NOK

PROFILETOKEN Token for the next payment; only if OK AN40 {323529-235795d-232957- 9823759}

ERROR Marker (no key); only if NOK – Refer to the WebCollect error codes guide

CODE Error or event code N10 400220

TYPE Type of error AN1 Y

MESSAGE Message for error or event AN4000 DOPAYMENT_ORDER_NOT_FOUND

ENDERROR Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

259
MODIFY_ORDER
This API call communicates, for example, a change of address for a recurring payment by mailed invoice. This API call is applicable to recurring
orders only.

The modify order structure is REQUEST

ACTION META PARAMS

ORDER

Input keys

Key Definition Type Req Example

ACTION MODIFY_ORDER AN R MODIFY_ORDER

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

ORDER Marker (no key) – R –

ORDERID Unique ID for order N10 R 9998890004

LANGUAGECODE ISO 639 language code for consumer AN2 O en

AMOUNT New amount (in cents) N12 O 30000

TITLE Title consumer AN35 O Mr.

FIRSTNAME First name AN15 O Jack

PREFIXSURNAME In between first name and surname AN15 O van

SURNAME Last name of consumer AN35 O Buuren

STREET Street address consumer AN50 O Polarisavenue

HOUSENUMBER House number address consumer AN15 O 1

ADDITIONALADDRESSINFO Additional address information AN50 O A

ZIP Zip code address consumer AN10 O 1000 AA

CITY City of consumer AN40 O New York

STATE State address consumer AN35 O New York

EMAIL Email address of consumer AN70 O [email protected]

Preference for type of email

EMAILTYPEINDICATOR l 0=Plain text N1 O 1

l 1=HTML

COMPANYNAME Company name consumer AN50 O Johnsons Ltd

COMPANYDATA Additional data on company name AN40 O Sales department

SEX Sex of the consumer (M or F or U) AN1 O M or F or U

VATNUMBER VAT number of the consumer AN17 O VAT 16

PHONENUMBER Phone number of the consumer AN20 O +34201234567

Key Definition Type Req Example

FAXNUMBER Fax number of the consumer AN20 O +34207654321

INVOICENUMBER Invoice number merchant (on printed invoice) AN20 O 20030222000000000001

Ingenico document - Reproduction or disclosure prohibited without written authorization

260
INVOICETYPE For future use can be left empty AN2 O N

INVOICECLASS For future use can be left empty AN10 O

BIRTHDATE Day of birth of consumer (for fraud detection reasons) (ccyymmdd) N8 O 19780203

TEXTQUALIFIER1 For printed invoices AN10 O TEXTQ1

TEXTQUALIFIER2 For printed invoices AN10 O TEXTQ2

TEXTQUALIFIER3 For printed invoices AN10 O TEXTQ3

ADDITIONALDATA For printed invoices AN500 O

ENDORDER Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT Result of the action AN3 OK or NOK

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 300400

MESSAGE Message for error or event AN4000 ORDER_NOT_FOUND_OR_MODIFICATION_NOT_ POSSIBLE

ENDERROR Marker (no key) – –

Example

<XML>

<ACTION>MODIFY_ORDER</ACTION>

<META>

</META>

<ORDER>

<CITY>Barcelona</CITY>

<STATE>Catalunie</STATE>

</ORDER>

Ingenico document - Reproduction or disclosure prohibited without written authorization

261
</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>MODIFY_ORDER</ACTION>

<META>

</META>

<ORDER>

<CITY>Barcelona</CITY>

<STATE>Catalunie</STATE>

</ORDER>

</PARAMS>

<META>

</META>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

262
PROCESS_CHALLENGED
This API call processes challenged payments with the fraud result challenged 525: Authorized and checked, waiting for explicit instructions for
settlement.

The process challenged structure is REQUEST

ACTION META PARAMS

PAYMENT

Input keys

Key Definition Type Req Example

ACTION PROCESS_CHALLENGED AN R PROCESS_CHALLENGED

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

PAYMENT Marker (no key) – R –

ORDERID Unique ID for order N10 R 9998890004

EFFORTID Default 1 N5 O 1

ENDPAYMENT Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

Format: YYYYMMDDHHMMSS

RESPONSEDATETIME N14 20130604123456

ENDMETA Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 400300

MESSAGE Message for error or event AN4000 PAYMENTATTEMPT (MERCHANTID={0}, ORDERID=

{1}, EFFORTID={2}) NOT_FOUND

ENDERROR Marker (no key) – –

Example

<XML>

<ACTION>PROCESS_CHALLENGED</ACTION>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

263
<IPADDRESS>123.123.123.123</IPADDRESS>

</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response A
<XML>

<ACTION>PROCESS_CHALLENGED</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

<META>

</META>

</RESPONSE>

</REQUEST>

</XML>

Possible response B
…

Ingenico document - Reproduction or disclosure prohibited without written authorization

264
<RESPONSE>

<META>

</META>

<ERROR>

<MESSAGE>PAYMENT IS NOT CHALLENGED. MERCHANTID 1, ORDERID 9998990011, EFFORTID 1

</MESSAGE>

</ERROR>

</RESPONSE>

Ingenico document - Reproduction or disclosure prohibited without written authorization

265
REJECT_ORDER
This API call rejects an order based on first payment information. No further payments are made. This API call is applicable to recurring orders only.

The reject order structure is REQUEST

ACTION META PARAMS

ORDER

Input keys

Key Definition Type Req Example

ACTION REJECT_ORDER AN R REJECT_ORDER

META Marker (no key) – R –

MERCHANTID ID for merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

ORDER Marker (no key) – R –

ORDERID Order ID of order to reject N10 R 9998890004

ENDORDER Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Ty Example

RESULT OK or NOK AN OK
10

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSE Format: YYYYMMDDHHMMSS N14 20130604123456

DATETIME

ENDMETA Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

Error or event code

CODE, MESSAGE, and TYPE are always returned for rejected transactions using the
real-time bank transfer Netherlands payment product (809), iDEAL
CODE N10 300360

Message for error or event ORDER_NOT_FOUND_ OR_UPDATE_NOT_

POSSIBLE_WITH_ CURRENT_STATUS
MESSAGE CODE, MESSAGE, and TYPE are always returned for rejected transactions using the AN
real-time bank 4000

Key Definition Ty Example

transfer Netherlands payment product (809), iDEAL

Ingenico document - Reproduction or disclosure prohibited without written authorization

266
Type of error or event B=Non-re-tryable error C=Configuration error
D=Customer input error
CODE, MESSAGE, and TYPE are always returned for rejected transactions using the real-time bank
transfer Netherlands payment product (809), iDEAL S=System error
TYPE A
N1

ENDE Marker (no key) – –

RROR

Example

<XML>

<ACTION>REJECT_ORDER</ACTION>

<META>

</META>

<ORDER>

</ORDER>

</PARAMS>

</REQUEST>

</XML>

Possible response
<XML>

<ACTION>REJECT_ORDER</ACTION>

<META>

</META>

<ORDER>

</ORDER>

</PARAMS>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

267
</META>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

268
SET_PAYMENT
This API

l Settles payments with an additional status for online credit cards of 600: Authorized, waiting for explicit instructions for settlement

l Settles credit cards that have passed AVS or CVV or fraud screening with a status of 525: Authorized and checked,

waiting for explicit instructions for settlement The set payment structure is

REQUEST ACTION META PARAMS

PAYMENT

Input keys

Key Definition Type Req Example

ACTION SET_PAYMENT AN R SET_ PAYMENT

META Marker (no key) – R –

MERCHANTID Merchant identifier N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

PAYMENT Marker (no key) – R –

af16af70-2bf5- 44e9-
a087-
PROFILETOKEN Token for the next payment AN40 O
68c87f67e3a1

ORDERID Unique order identifier generated by Ingenico ePayments N10 R 9998890004

EFFORTID Default=1 N5 R 1

PAYMENTPRODUCTID Payment product identifier N5 R 1

Amount to be settled in cents

AMOUNT AMOUNT must not exceed the authorized amount—One settlement per authorization N12 O 29990 (=299.90)

CURRENCYCODE ISO 4217 currency code AN3 O USD

Changed date collect direct debit

DATECOLLECT Format: YYYYMMDD D8 O

Unique reference of merchant for payment

MERCHANTREFEREN MERCHANTREFERENCE allowed input is ASCII 32–126 characters—Do not include trailing AN30 O
CE spaces in the

Key Definition Type Req Example

MERCHANTREFERENCE

ENDPAYMENT Marker (no key) – R –

AIRLINEDATA Marker (no key) – O If airline date is

present

AIRLINECODE Airline numeric code N3 R 123

AIRLINENAME Name of airline AN20 R KLM

AIRLINEINVOICENUM Airline tracing number N6 O 465321

BER

Ingenico document - Reproduction or disclosure prohibited without written authorization

269
Travel agent code

For transactions using Elavon, AGENTNUMBERICCODE is limited to N8 N6 123456 or

N8
AGENTNUMBERICCO This spelling (AGENTNUMBERICCODE) must be used O 12345678
DE

The ticket or document number contains

l Airline code—3-digit airline code number

l Form code—A maximum of 3 digits indicating the type of document, the source of issue and the
number of coupons it contains

l Serial number—A maximum of 8 digits allocated on a

TICKETNUMBER AN13 R 0741243235556
sequential basis, provided that the total number of digits allocated to the form code and serial number
shall not exceed ten

PNR Passenger name record AN6 O

ETICKETINDICATOR l E=eTicket AN1 O E

l ET=E Ticket

l CTO=City Ticket Office

l ATO=Airport Ticket Office

TICKETDELIVERYME l TBM=Ticket By Mail AN3 O ET

THOD
l TOD=Ticket On Departure

You can replace TICKETNUMBER with PNR if the ticket number is unavailable

POINTOFSALE IATA point-of-sale name AN25 O

Place of issue

PLACEOFISSUE For sales in the US the last two characters (position 14–15) must be the US state code AN15 O

PASSENGERNAME Name of passenger AN49 R Johan Cruijff

Date of the flight

FLIGHTDATE Format: CCYYMMDD N8 O 20141231

ISTHIRDPARTY Is the payer the ticket holder (T/F) AN5 O T

ISREGISTEREDCUST Identifies a known consumer (T/F) AN5 O T

OMER

POSCITYCODE This is the city code of the point of sale AN10 O AMS

CUSTOMERID Consumer reference used when searching in the Ingenico ePayments interface AN16 O 14

This is the date of issue recorded in the airline system

ISSUEDATE In a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date N8 O 20090402

Key Definition Type Req Example

Format: YYYYMMDD ISSUEDATE is required for Elavon

ISSUEDATE and RESTRICTEDTICKET are required for PayPal

Airline data restricted ticket (non-refundable)

l 0=No restrictions, the ticket is (partially) refundable

RESTRICTEDTICKET l 1=Restricted, the ticket is non-refundable N1 O 0

ISSUEDATE and RESTRICTEDTICKET are required for PayPal

FLIGHTLEGS Marker (no key) – O If flightlegs are present

... flightlegs ... – – –

ENDFLIGHTLEGS Marker (no key) – O –

ENDAIRLINEDATA Marker (no key) – O –

ENDPARAMS Marker (no key) – R –

Ingenico document - Reproduction or disclosure prohibited without written authorization

270
Additional for each flight leg

Key Definition Type Req Example

FLIGHTLEG Marker (no key) – O –

LEGNUMBER Sequence of flight leg number N5 R 1

LEGDATE Date of the leg CCYYMMDD D8 R 20141231

ORIGINAIRPORT Origin airport/city code AN3 R AMS

ARRIVALAIRPORT Arrival airport/city code AN3 R LAX

l O or blank=stopover permitted

l X=stopover not permitted

STOPOVERCODE STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are AN1 O X

required for PayPal

AIRLINECLASS Reservation Booking Designator AN2 R 1

CARRIERCODE IATA carrier code AN2 R KL

FAREBASIS Fare Basis/Ticket Designator AN15 O INTERNET

The flight number assigned by the airline carrier with no leading spaces

FLIGHTNUMBER STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are AN5 O 791

required for PayPal

The departure time in local time at the departure airport Format: HH:MM

STOPOVERCODE, FLIGHTNUMBER, and DEPARTURETIME are

DEPARTURETIME required for PayPal AN6 O 17:59

ENDFLIGHTLEG Marker (no key) – O –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 –

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 410110

MESSAGE Message for error or event AN4000 REQUEST 2501 UNKNOWN ORDER OR NOT PENDING

ENDERROR Marker (no key) – –

Example

<XML>

<ACTION>SET_PAYMENT</ACTION>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

271
</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response A
<XML>

<ACTION>SET_PAYMENT</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

<META>

</META>

</RESPONSE>

</REQUEST>

</XML>

Possible response B
…

Ingenico document - Reproduction or disclosure prohibited without written authorization

272
<RESULT>NOK</RESULT>

<META>

</META>

<ERROR>

<MESSAGE>REQUEST 257 UNKNOWN ORDER OR NOT PENDING</MESSAGE>

</ERROR>

</RESPONSE>

Ingenico document - Reproduction or disclosure prohibited without written authorization

273
SET_PAYOUT
This API call settles payouts with the additional status for payouts of 600: Waiting for explicit instructions to process the payout.

The set payment structure is REQUEST

ACTION META PARAMS

PAYOUT

Input keys

Key Definition Type Req Example

ACTION SET_PAYOUT AN R SET_PAYOUT

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

Key Definition Type Req Example

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

PAYOUT Marker (no key) – R –

ORDERID Unique ID for order N10 R 9998890004

PAYMENTPRODUCTID Payment product identifier N5 R 1201

Default=1

EFFORTID In most cases, you must set EFFORTID=-1 to match the original N5 R 1

Changed payout date

DATEPAYOUT Format: YYYYMMDD D8 O 20120604

ENDPAYOUT Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 RESULT

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 410110

MESSAGE Message for error or event AN4000 REQUEST 2501 UNKNOWN ORDER OR NOT PENDING MESSAGE

ENDERROR Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

274
Example

<XML>

<ACTION>SET_PAYOUT</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response A
<XML>

<ACTION>SET_PAYOUT</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

<META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

275
</META>

</RESPONSE>

</REQUEST>

</XML>

Possible response B
…

<META>

</META>

<ERROR>

<MESSAGE>REQUEST 2574 UNKNOWN ORDER OR NOT PENDING</MESSAGE>

</ERROR>

</RESPONSE>

Ingenico document - Reproduction or disclosure prohibited without written authorization

276
SET_REFUND
This API call settles refunds with the additional status for refunds of 600: Pending, waiting for explicit instructions for processing.

The set refund structure is REQUEST

ACTION META PARAMS

PAYMENT

Input keys

Key Definition Type Req Example

ACTION SET_REFUND AN R SET_REFUND

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

PAYMENT Marker (no key) – R –

ORDERID Order ID of order to refund N10 R 9998890004

EFFORTID Effort ID of the payment (if left empty –1 is presumed) N5 R –

PAYMENTPRODUCTID Payment product identifier – R –

Amount to be refunded in cents

AMOUNT AMOUNT must not exceed the authorized amount—One settlement per authorization N12 O 12000

ENDPAYMENT Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 –

META Marker (no key) – –

REQUESTID Internal ID of request N10 12345111

Date and time of response

RESPONSEDATETIME Format: YYYYMMDDHHMMSS N14 20130604123456

ENDMETA Marker (no key) – –

ERROR Marker (no key) – See the WebCollect error codes guide

CODE Error or event code N10 410110

MESSAGE Message for error or event AN4000 REQUEST 2501 UNKNOWN ORDER OR NOT

Key Definition Type Example

PENDING

ENDERROR Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

277
Example

<XML>

<ACTION>SET_REFUND</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Possible response A
<XML>

<ACTION>SET_PAYMENT</ACTION>

<META>

</META>

</PAYMENT>

</PARAMS>

<META>

</META>

</RESPONSE>

</REQUEST>

Ingenico document - Reproduction or disclosure prohibited without written authorization

278
</XML>

Possible response B
…

<META>

</META>

<ERROR>

<MESSAGE>REQUEST 257 UNKNOWN ORDER OR NOT PENDING</MESSAGE>

</ERROR>

</RESPONSE>

Ingenico document - Reproduction or disclosure prohibited without written authorization

279
TEST_CONNECTION

This API call tests your connection with the Ingenico ePayments payment platform WebCollect.

Responses

l If the response is OK, the connection is working correctly

l If the response is NOK, the connection is not working correctly—Check your settings on your end

If your connection is still not working correctly, contact Ingenico ePayments The test connection structure is

REQUEST ACTION META

Input keys

Key Definition Type Req Example

ACTION TEST_CONNECTION AN R TEST_CONNECTION

META Marker (no key) – R –

MERCHANTID ID of Merchant N10 R 1

IPADDRESS IP address of merchant server AN32 O 123.123.123.123

VERSION Version of interface AN10 O 1.0

ENDMETA Marker (no key) – R –

Return keys

Key Definition Type Example

RESULT OK or NOK AN10 OK

Example
<XML>

<ACTION>TEST_CONNECTION</ACTION>

<META>

</META>

</REQUEST>

</XML>

Possible response
<XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

280
<ACTION>TEST_CONNECTION</ACTION>

<META>

</META>

</RESPONSE>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

281
UPDATE_PROFILE
This API call informs Ingenico ePayments of a

l Mandate modification for SEPA

l Profile modification for tokenization The update profile structure is

REQUEST ACTION META PARAMS

PROFILE MANDATE

Input keys

Key Definition Type Req Example

ACTION UPDATE_PROFILE AN R UPDATE_PROFILE

META Marker (no key) – –

Key Definition Type Req Example

MERCHANTID ID of merchant N10 R 1

VERSION Version of interface AN10 R 1.0

ENDMETA Marker (no key) – –

PARAMS Marker (no key) – –

PROFILE Marker (no key) – –

PROFILETOKEN Token for the next payment; only if OK AN40 R {323529-235795d- 232957-
9823759}

COUNTRYCODE ISO 3166 country code of the consumer address AN2 R NL

CUSTOMERID ID of customer AN15 O 1

… billing address information …

… credit card information …

… eWallet information …

Direct debit information

IBAN International Bank Account Number AN50 O NL39RABO0300065264

BIC Bank Identifier Code AN11 O ABNANL2A

ENDPROFILE Marker (no key) – –

MANDATE Marker (no key) – –

CUSTOMERCONTRACTIDENTI Identifies the contract between customer and merchant AN35 O

FIER

Identifies the type of transaction that this specific mandate accepts for the SEPA
direct debit

l S=One-off

l F=First recurring
TRANSACTIONTYPE AN2 R S
l R=Second and subsequent recurring

l L=Last recurring

Mandate name information

SURNAME Debtor last name AN70 R Buuren

FIRSTNAME Debtor first name AN15 O Jack

PREFIXSURNAME Prefix of the debtor last name AN15 O Van

Mandate address information

CITY City of the consumer address AN40 O Amsterdam

Ingenico document - Reproduction or disclosure prohibited without written authorization

282
STREET Street of the consumer address AN50 O Polarisavenue

HOUSENUMBER House number of the consumer address AN15 O 1

ADDITIONALADDRESSINFO Additional information about the consumer address AN50 O A

ZIP ZIP code of the consumer address AN10 O 1000 AA

STATE State of the consumer address AN35 O Noord-Holland

STATECODE State code AN9 O NH

Mandate signature information

MANDATEPLACE City in which the consumer signed the mandate AN40 O Hoofddorp

MANDATEDATE Date of mandate signature N8 O 20131018

Key Definition Type Req Example

Format: YYYYMMDD

MANDATESIGNED l 0=Mandate is not signed N1 O 1

l 1=Mandate is signed

Mandate pre-notification information

Consumer email address

EMAIL Required when PRENOTIFICATION=1 AN70 C [email protected]

Preference for type of email

l 0=Plain text (ASCII)

EMAILTYPEINDICATOR l 1=HTML N1 C 1

Required when PRENOTIFICATION=1

l 0=Do not send a pre-notification email to the consumer

l 1=Send a pre-notification email to the

consumer on the first collection

PRENOTIFICATION The email is sent from the merchant email address AN1 O 1

ENDMANDATE Marker (no key) – –

ENDPARAMS Marker (no key) – –

Return keys

Key Definition Type Example

Result of the action

RESULT l OK AN3 OK

l NOK

PROFILETOKEN Token for the next payment;. only if OK AN40 {323529-235795d-232957- 9823759}

ERROR Marker (no key); only if NOK – Refer to the WebCollect error codes guide

CODE Error or event code N10 400220

TYPE Type of error AN1 Y

MESSAGE Message for error or event AN4000 DOPAYMENT_ORDER_NOT_FOUND

ENDERROR Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

283
VALIDATE_PROFILE
This API call informs Ingenico ePayments that you received a mandate. The validate profile structure is

REQUEST ACTION META PARAMS

PROFILE MANDATE

Input keys

Key Definition Type Req Example

ACTION VALIDATE_PROFILE AN R VALIDATE_PROFILE

META Marker (no key) – R –

MERCHANTID ID of merchant N10 R 1

VERSION Version of interface AN10 R 1.0

ENDMETA Marker (no key) – R –

PARAMS Marker (no key) – R –

PROFILE Marker (no key) – R –

PROFILETOKEN Token for the next payment; only if OK AN40 R af16af70-2bf5-44e9-a087- 68c87f67e3a1

ENDPROFILE Marker (no key) – R –

MANDATE Marker (no key) – R –

MANDATEPLACE City in which the consumer signed the mandate AN40 R Hoofddorp

Date of mandate signature

MANDATEDATE Format: YYYYMMDD N8 R 20131018

MANDATESIGNED l 0=Mandate is not signed N1 R 1

l 1=Mandate is signed

ENDMANDATE Marker (no key) – R –

ENDPARAMS Marker (no key) – R –

Return keys

Key Definition Type Example

RESPONSE Marker (no key) – –

Result of the action

RESULT l OK AN3 OK

l NOK

PROFILETOKEN Token for the next payment; only if OK AN40 af16af70-2bf5-44e9-a087-68c87f67e3a1

ERROR Marker (no key); only if NOK – See the WebCollect error codes guide

CODE Error or event code N10 400220

TYPE Type of error AN1 Y

MESSAGE Message for error or event AN4000 DOPAYMENT_ORDER_NOT_FOUND

ENDERROR Marker (no key) – –

ENDRESPONSE Marker (no key) – –

Ingenico document - Reproduction or disclosure prohibited without written authorization

284
Appendix A - ISO country codes
These country codes conform to ISO 3166-1.

The exception is

Netherlands Antilles (Curaçao and Sint Maarten)—AN

The Netherlands Antilles do not have a country code listed in ISO 3166-1

Curaçao and Sint Maarten have ISO 3166-1 country codes of their own, which are included here, too

A–F

Country Code Country Code Country Code Country Code

Afghanistan AF Belgium BE Central African Republic CF Dominican Republic DO

Åland Islands AX Belize BZ Chad TD Ecuador EC

Albania AL Benin BJ Chile CL Egypt EG

Algeria DZ Bermuda BM China CN El Salvador SV

American Samoa AS Bhutan BT Christmas Island CX Equatorial Guinea GQ

Andorra AD Bolivia, Plurinational State of BO Cocos (Keeling) Island CC Eritrea ER

WebCollect technical guide 2013 Q4Angola AO Bonaire, Sint Eustatius, and Saba BQ Colombia CO Estonia EE

Anguilla AI Bosnia and Herzegovina BA Comoros KM Ethiopia ET

Falkland Islands (Malvinas)

Antarctica AQ Botswana BW Congo CG FK

Antigua & Barbuda AG Bouvet Island BV Congo, the Democratic Republic of the CD Faroe Islands FO

Argentina AR Brazil BR Cook Islands CK Fiji FJ

Armenia AM British Indian Ocean Territory IO Costa Rica CR Finland FI

Country Code Country Code Country Code Country Code

Aruba AW Brunei Darussalam BN Cote d’Ivoire CI France FR

Australia AU Bulgaria BG Croatia HR French Guiana GF

Austria AT Burkina Faso BF Cuba CU French Polynesia PF

Curaçao (with Sint Maarten, Netherlands Antilles—AN) French Southern Territories

Azerbaijan AZ Burundi BI CW TF

Bahamas BS Cambodia KH Cyprus CY

Bahrain BH Cameroon CM Czech Republic CZ

Bangladesh BD Canada CA Denmark DK

Barbados BB Cape Verde CV Djibouti DJ

Belarus BY Cayman Islands KY Dominica DM

G–L

Country Code Country Code Country Code Country Code

Gabon GA Guinea-Bissau GW Isle of Man IM Lao People's Democratic Republic LA

Gambia GM Guyana GY Israel IL Latvia LV

Georgia GE Haiti HT Italy IT Lebanon LB

Germany DE Heard Island and McDonald Islands HM Jamaica JM Lesotho LS

Ghana GH Holy See (Vatican City State) VA Japan JP Liberia LR

Gibraltar GI Honduras HN Jersey JE Libya LY

Greece GR Hong Kong HK Jordan JO Liechtenstein LI

Greenland GL Hungary HU Kazakhstan KZ Lithuania LT

Grenada GD Iceland IS Kenya KE Luxembourg LU

Guadeloupe GP India IN Kiribati KI

Ingenico document - Reproduction or disclosure prohibited without written authorization

285
Guam GU Indonesia ID Korea, Democratic People's Republic of KP

Guatemala GT Iran, Islamic Republic of IR Korea, Republic of KR

Guernsey GG Iraq IQ Kuwait KW

Guinea GN Ireland IE Kyrgyzstan KG

M–R

Country Code Country Code Country Code Country Code

Macao MO Micronesia, Federated States of FM New Caledonia NC Papua New Guinea PG

Macedonia, the former Yugoslav republic of MK Moldova, Republic of MD New Zealand NZ Paraguay PY

Country Code Country Code Country Code Country Code

Madagascar MG Monaco MC Nicaragua NI Peru PE

Malawi MW Mongolia MN Niger NE Philippines PH

Malaysia MY Montenegro ME Nigeria NG Pitcairn PN

Maldives MV Montserrat MS Niue NU Poland PL

Mali ML Morocco MA Norfolk Island NF Portugal PT

Malta MT Mozambique MZ Northern Mariana Islands MP Puerto Rico PR

Marshall Islands MH Myanmar MM Norway NO Qatar QA

Martinique MQ Namibia NA Oman OM Réunion RE

Mauritania MR Nauru NR Pakistan PK Romania RO

Mauritius MU Nepal NP Palau PW Russian Federation RU

Mayotte YT Netherlands, The NL Palestinian Territory, Occupied PS Rwanda RW

Mexico MX Netherlands Antilles (Curaçao and Sint Maarten) AN Panama PA

S–Z

Country Code Country Code Country Code Country Code

Saint Barthélemy BL Solomon Islands SB Timor Leste TL United Kingdom GB

Saint Helena, Ascension and Tristan da SH Somalia SO Tokelau TK Viet Nam VN

Cunha

Virgin Islands,
British
Saint Kitts and Nevis KN South Africa ZA Tonga TO VG

Saint Lucia LC South Georgia and the South Sandwich GS Trinidad and Tobago TT Virgin Islands, US VI
Islands

Saint Martin MF Spain ES Tunisia TN Wallis and Futuna WF

Saint Pierre and Miquelon PM Sri Lanka LK Turkey TR Western Sahara EH

Saint Vincent and the Grenadines VC Sudan SD Turkmenistan TM Yemen YE

Samoa WS Suriname SR Turks and Caicos Islands TC Zambia ZM

San Marino SM Svalbard and Jan Mayen SJ Tuvalu TV Zimbabwe ZW

Sao Tome and Principe ST Swaziland SZ Uganda UG

Saudi Arabia SA Sweden SE Ukraine UA

Senegal SN Switzerland CH United Arab Emirates AE

Serbia RS Syrian Arab Republic SY United States US

Seychelles SC Taiwan, Province of China TW United States Minor Outlying UM

Islands

Sierra Leone SL Tajikistan TJ Uruguay UY

Country Code Country Code Country Code Country Code

Singapore SG Tanzania, United Republic of TZ Uzbekistan UZ

Sint Maarten (with Curaçao, Netherlands Antilles—AN) SX Thailand TH Vanuatu VU

Ingenico document - Reproduction or disclosure prohibited without written authorization

286
Slovakia SK Timor-Leste (East Timor) TL Vatican City State (Holy See) VA

Slovenia SI Togo TG Venezuela, Bolivarian Republic of VE

Ingenico document - Reproduction or disclosure prohibited without written authorization

287
Appendix B - ISO language codes
These language codes conform to ISO 639.

Exceptions are
Chinese, simplified—sc l Chinese, traditional—tc l Czech (legacy)—cz
Polish (legacy)—po

The language codes are in lowercase

A–L

Language Code Language Code Language Code Language Code

Arabic ar Danish da French fr Italian it

Chinese, simplified sc Dutch nl German de Japanese ja

Chinese, traditional tc English en Hebrew he Korean ko

Czech cs Farsi (Persian) fa Hindi hi

Czech (legacy) cz Finnish fi Hungarian hu

M–Z

Language Code Language Code Language Code Language Code

Norwegian no Romanian ro Swahili sw Urdu ur

Polish pl Russian ru Swedish sv Vietnamese vi

Polish (legacy) po Slovenian sl Thai th

Portuguese pt Spanish es Turkish tr

Ingenico document - Reproduction or disclosure prohibited without written authorization

288
Appendix C - ISO currency codes

These currency codes conform to ISO 4217.

A–F

Co Currency Countries using this currency

AED United Arab Emirates dirham United Arab Emirates

AFN Afghan afghani Afghanistan

ALL Albanian lek Albania

AMD Armenian dram Armenia

ANG Netherlands Antillean guilder Curaçao and Sint Maarten (Netherlands Antilles)

AOA Angolan kwanza Angola

ARS Argentine peso Argentina

Australia, Australian Antarctic Territory, Christmas Island, Cocos (Keeling) Islands, Heard and McDonald
Islands, Kiribati, Nauru, Norfolk Island, Tuvalu
AUD Australian dollar

A Aruban florin Aruba

AZN Azerbaijani manat Azerbaijan

BAM Bosnia and Herzegovina Bosnia and Herzegovina

convertible mark

BBD Barbados dollar Barbados

BDT Bangladeshi taka Bangladesh

BGN Bulgarian lev Bulgaria

BHD Bahraini dinar Bahrain

BIF Burundian franc Burundi

BMD Bermudian dollar Bermuda

BND Brunei dollar Brunei, Singapore

BOB Boliviano Bolivia

BRL Brazilian real Brazil

BSD Bahamian dollar Bahamas

BTN Bhutanese ngultrum Bhutan

B Botswana pula Botswana

BYR Belarusian ruble Belarus

C Currency Countries using this currency

o
de

B Belize Belize
ZD dollar

C Canadian Canada
AD dollar

C Congolese Democratic Republic of Congo

DF franc

Ingenico document - Reproduction or disclosure prohibited without written authorization

289
C Swiss Switzerland, Liechtenstein
HF franc

C Chilean Chile
LP peso

C Chinese China (mainland)

NY yuan
(renminbi)

C Colombian Colombia
OP peso

C Costa Costa Rica

RC Rican
colon

C Cuban Cuba
UC convertible
peso

C Cuban Cuba
UP peso

C Cape Cape Verde

VE Verde
escudo

C Czech Czech Republic

ZK koruna

D Djiboutian Djibouti
JF franc

D Danish Denmark, Faroe Islands, Greenland

KK krone

D Dominican Dominican Republic

OP peso

D Algerian Algeria
ZD dinar

E Egyptian Egypt
GP pound

E Eritrean Eritrea
RN nakfa

E Ethiopian Ethiopia
TB birr

European Union countries (Austria, Belgium, Cyprus, Estonia, Finland, France, Germany, Greece, Ireland, Italy, Luxembourg,
Malta, the Netherlands, Portugal, Slovakia, Slovenia, Spain), Andorra, Kosovo, Monaco, Montenegro, San Marino, Vatican City
(Holy See)

E Euro
UR

F Fiji dollar Fiji

F Falkland Falkland Islands

KP Islands
pound

G–L

C Curren Countries using this currency

o cy
de

Ingenico document - Reproduction or disclosure prohibited without written authorization

290
United Kingdom, Crown Dependencies (the Isle of Man and the Channel Islands), certain British Overseas Territories (South
Georgia and the South Sandwich Islands, British Antarctic Territory and British Indian Ocean Territory)

G Pound
BP sterling

G Georgia Georgia
EL n lari

G Ghanai Ghana
HS an cedi

G Gibralta Gibraltar
IP r pound

G Gambia Gambia
MD n dalasi

G Guinea Guinea
NF n franc

Code Currency Countries using this currency

GTQ Guatemalan quetzal Guatemala

GYD Guyanese dollar Guyana

HKD Hong Kong dollar Hong Kong (Special Administrative Region), Macau (Special Administrative Region)

HNL Honduran lempira Honduras

HRK Croatian kuna Croatia

HTG Haitian gourde Haiti

HUF Hungarian forint Hungary

IDR Indonesian rupiah Indonesia

ILS Israeli new sheqel Israel, Palestinian territories

INR Indian rupee Bhutan, India

IQD Iraqi dinar Iraq

IRR Iranian rial Iran

ISK Icelandic króna Iceland

JMD Jamaican dinar Jamaica

JOD Jordanian dollar Jordan

JPY Japanese yen Japan

KES Kenyan shilling Kenya

KGS Kyrgyzstani som Kyrgyzstan

KHR Cambodian riel Cambodia

KMF Comoro franc Comoros

KPW North Korean won North Korean

KRW South Korean won South Korea

KWD Kuwaiti dinar Kuwait

KYD Cayman Islands dollar Cayman Islands

KZT Kazakhstani tenge Kazakhstan

LAK Lao kip Laos

LBP Lebanese pound Lebanon

LKR Sri Lankan rupee Sri Lanka

Ingenico document - Reproduction or disclosure prohibited without written authorization

291
LRD Liberian dollar Liberia

LSL Lesotho loti Lesotho

LTL Lithuanian litas Lithuania

LVL Latvian lats Latvia

LYD Libyan dinar Libya

M–R

Code Currency Countries using this currency

MAD Moroccan dirham Morocco, Western Sahara

MDL Moldovan leu Moldova (except Transnistria)

MGA Malagasy ariary Madagascar

MKD Macedonian denar Republic of Macedonia

Code Currency Countries using this currency

MMK Myanmar kyat Myanmar

MNT Mongolian tugrik Mongolia

MOP Macanese pataca Macau (Special Administrative Region)

MRO Mauritanian ouguiya Mauritania

MUR Mauritian rupee Mauritius

MVR Maldivian rufiyaa Maldives

MWK Malawian kwacha Malawi

MXN Mexican peso Mexico

MYR Malaysian ringgit Malaysia

MZN Mozambican metical Mozambique

NAD Namibian dollar Namibia

NGN Nigerian naira Nigeria

NIO Nicaraguan córdoba Nicaragua

NOK Norwegian krone Norway, Svalbard, Jan Mayen, Bouvet Island, Queen Maud Land, Peter I Island

NPR Nepalese rupee Nepal

NZD New Zealand dollar Cook Islands, New Zealand, Niue, Pitcairn, Tokelau

OMR Omani rial Oman

PAB Panamanian balboa Panama

PEN Peruvian nuevo sol Peru

PGK Papua New Guinean kina Papua New Guinea

PHP Philippine peso Philippines

PKR Pakistani rupee Pakistan

PLN Polish zoty Poland

PYG Paraguayan guaraní Paraguay

QAR Qatari rial Qatar

Ingenico document - Reproduction or disclosure prohibited without written authorization

292
RON Romanian new leu Romania

RSD Serbian dinar Serbia

RUB Russian rouble Russia, Abkhazia, South Ossetia

RWF Rwandan franc Rwanda

S–Z

Code Currency Countries using this currency

SAR Saudi riyal Saudi Arabia

SBD Solomon Islands dollar Solomon Islands

SCR Seychelles rupee Seychelles

SDG Sudanese pound Sudan

SEK Swedish krona Sweden

SGD Singapore dollar Singapore, Brunei

SHP Saint Helena pound Saint Helena

SLL Sierra Leonean leone Sierra Leone

C Currency Countries using this currency

o
de

S Somali shilling Somalia (except Somaliland)

S Surinamese dollar Suriname

S South Sudanese pound South Sudan

S São Tomé and Príncipe São Tomé and Príncipe

TD dobra

S Syrian pound Syria

S Swazi lilangeni Swaziland

T Thai baht Thailand

T Tajikistani somoni Tajikistan

T Turkmenistani manat Turkmenistan

T Tunisian dinar Tunisia

T Tongan pa’anga Tonga

T Turkish lira Turkey, Turkish Republic of Northern Cyrpus

T Trinidad and Tobago Trinidad and Tobago

TD dollar

T New Taiwan dollar Taiwan

Ingenico document - Reproduction or disclosure prohibited without written authorization

293
T Tanzanian shilling Tanzania
ZS

U Ukrainian hryvnia Ukraine

U Ugandan shilling Uganda

American Samoa, British Indian Ocean Territory, Caribbean Netherlands, Ecuador, El Salvador, Guam, Haiti,
Marshall Islands, Micronesia, Northern Mariana Islands, Palau, Panama, Puerto Rico, Timor-Leste, Turks and
Caicos Islands, United States of America, US Virgin Islands, Barbados (as well as Barbados Dollar), Bermuda (as
well as Bermudian Dollar), Zimbabwe

U United States dollar

U Uruguayan peso Uruguay

U Uzbekistan som Uzbekistan

V Venezuelan bolívar Venezuela

EF fuerte

V Vietnamese ông Vietnam

V Vanuatu vatu Vanuatu

W Samoan tala Samoa

X Central African CFA Cameroon, Central African Republic, Republic of the Congo, Chad, Equatorial Guinea, Gabon
AF Franc BEAC (Banque
des États de l'Afrique
Centrale)

Anguilla, Antigua and Barbuda, Dominica, Grenada, Montserrat, Saint Kitts and Nevis, Saint Lucia, Saint Vincent
and the Grenadines
X East Caribbean dollar
CD

X West African CFA franc Benin, Burkina Faso, Côte d'Ivoire, Guinea- Bissau, Mali, Niger, Senegal, Togo
OF BCEAO (Banque
Centrale des États de
l'Afrique de l'Ouest)

X CFP franc (Comptoirs French Polynesia, New Caledonia, Wallis and Futuna
PF Français du Pacifique)

Y Yemeni rial Yemen

Z South African rand South Africa

Z Zambian kwacha Zambia

Z Zimbabwe dollar Zimbabwe

Ingenico document - Reproduction or disclosure prohibited without written authorization

294
Appendix D WebCollect status codes
Possible payment status IDs

Stat Status Description

us ID

0 CREATED The payment attempt was created

20 PENDING AT MERCHANT The HostedMerchantLink transaction is waiting for the consumer to be redirected by the merchant to
WebCollect

25 PENDING AT Ingenico The HostedMerchantLink transaction is waiting for the consumer to enter missing data on the payment
ePayments pages of Ingenico ePayments

PENDING AT Ingenico The Hosted Merchant Link transaction is waiting for WebCollect to redirect the consumer to the bank
ePayments payment pages (optionally, after the consumer enters missing data)
30

PENDING AT BANK The payment request and consumer have been forwarded to the payment pages of the bank

50 (Real-time Bank Transfer)

50 ENROLLED (Credit Card The payment request and consumer have been forwarded to the authentication pages of the card issuer
Online)

PENDING AT CONSUMER The consumer received all payment details to initiate the transaction

55 The consumer must go to the (bank) office to initiate the payment

60 NOT ENROLLED The consumer is not enrolled for 3D Secure authentications

PENDING PAYMENT The consumer is at an office to initiate a transaction

(CONSUMER AT BANK)
65 The status is used when the supplier polls the WebCollect database to verify if a payment on an order is
(still) possible

70 BANK IS IN DOUBT The status of the payment is in doubt at the bank

100 REJECTED WebCollect rejected the payment instruction

120 REJECTED BY BANK The bank rejected the payment

125 CANCELLED AT BANK The consumer cancelled the payment while on the bank payment page

130 FAILED The payment has failed

The payment was not completed within the given set time limit by the consumer and is expired

140 EXPIRED AT BANK The payment has failed

150 TIMED OUT AT BANK WebCollect did not receive information regarding the outcome of the payment at the bank

Status ID Status Description

160 DENIED The transaction had been rejected for reasons of suspected fraud

170 AUTHORISATION EXPIRED The authorization is expired because no explicit settlement request was received in time

AUTHENTICATION_ ENROLLMENT_
EXPIRED
172 The enrolment period was pending for too long

AUTHENTICATION_ VALIDATION_
EXPIRED
175 The validation period was pending for too long

180 INVALED PARES OR NOT COMPLETED The cardholder authentication response from the bank was invalid or not completed

The settlement is rejected

190 SETTLEMENT REJECTED Used in a captured by Ingenico ePayments credit card online transaction, specifically
ATOS

200 CARDHOLDER AUTHENTICATED The cardholder was successfully authenticated

220 COULD NOT AUTHENTICATE The authentication service was out of order; the cardholder could not be authenticated

230 CARDHOLDER NOT PARTICIPATING The cardholder is not participating in the 3D Secure authentication program

Ingenico document - Reproduction or disclosure prohibited without written authorization

295
INVALED PARES OR NOT COMPLETED The cardholder authentication response from the bank was invalid or not completed

280 Authorization is not possible

AUTHORISATION TESTED Authorization tested

300 This payment will be re-authorized and settled offline

The consumer is not enrolled for 3D Secure authentication

310 NOT ENROLLED Authorization is not possible

COULD NOT AUTHENTICATE The authentication service was out of order; the cardholder could not be authenticated

320 Authorization is not possible

CARDHOLDER NOT PARTICIPATING The cardholder is not participating in the 3D Secure authentication program

330 Authorization is not possible

CARDHOLDER AUTHENTICATED The cardholder was successfully authenticated

350 Authorization is not possible

400 REVISED The consumer or WebCollect has revised the payment (with another payment product)

Payment was unsuccessful

500 FINAL This is the final status update for this transaction

The payment was challenged by your fraud rule set and is pending

525 CHALLENGED Use the Process Challenged API or the Web Payment Console if you choose to
process further

The payment was referred

550 REFERRED A manual authorization attempt will be made shortly

600 PENDING The payment instruction is waiting for one of these

Status ID Status Description

Mandate (direct debit) Settlement (credit card online)

Acceptance (recurring orders)

625 AUTHORIZED AND PENDING The transaction is authorized and waiting for the second message (captured) from the
provider

The real-time bank payment is pending verification by the batch process

650 PENDING VERIFICATION If followed by 50 PENDING AT BANK, the verification could not be carried out successfully

680 PENDING Similar to 600 but only applies to Pre Authorization

Ingenico ePayments accepted the payment instruction

Credit card online—The payment is authorized, but not yet settled

800 READY Real-time bank transfer—The return message from the bank indicates that the payment was
successful

Temporary status

900 SENT The payment instruction was accepted and is being processed further

900 PROCESSED The refund was processed

950 INVOICE_SENT The invoice was printed and sent

935 SETTLEMENT PENDING The capture has been sent but not yet confirmed by the acquirer
CONFIRMATION

975 SETTLEMENT IN PROGRESS The settlement file was sent for processing at the financial institution

1000 PAID The payment was paid

1010 ACCOUNT DEBITED Ingenico ePayments debited the consumer account

1020 CORRECTED Ingenico ePayments corrected the payment information that was given

1030 WITHDRAWN CHARGEBACK The chargeback has been withdrawn

1050 COLLECTED The funds have been made available for remittance to the merchant

Ingenico document - Reproduction or disclosure prohibited without written authorization

296
1100 REJECTED BY Ingenico ePayments rejected the payment attempt

Ingenico ePayments

1110 REFUSED BY ACCEPTING BANK The acquiring bank rejected the direct debit

1120 REFUSED SETTLEMENT Refused settlement before payment by Ingenico ePayments (credit card)

1150 REFUSED SETTLEMENT Refused settlement after payment from Acquirer (credit card)

1210 REFUSED BY CONSUMER BANK The bank of the consumer rejected the direct debit

1250 BOUNCED The payment bounced

1400 NOC RECEIVED Notification of chargeback has been received for the payment

1500 CHARGED BACK BY CONSUMER The payment was charged back by the consumer

1510 REVERSAL BY CONSUMER The consumer reversed the direct debit payment

1520 REVERSED The payment was reversed

1800 REFUNDED The payment was refunded

1810 CORRECTED Ingenico ePayments corrected the refund information given

Status ID Status Description

REFUND

1850 REFUSED REFUND Refund is refused by the Acquirer

2000 ACCOUNT CREDITED Ingenico ePayments credited the consumer account

2030 WITHDRAWN REVERSED PAYOUT The reversed payout was withdrawn

2100 REJECTED BY Ingenico ePayments rejected the payout attempt

Ingenico ePayments

2110 REJECTED BY BANK Bank rejected the payout attempt

2120 REFUSED BY ACCEPTING BANK The acquiring bank rejected the payout attempt

2130 REFUSED BY CONSUMER BANK The consumer bank rejected the payout attempt

2210 REVERSAL BY CONSUMER The consumer reversed the payout

2220 REVERSED The payout was reversed

99999 CANCELLED The payment, refund, or payout attempt was cancelled by the merchant

Possible order status IDs

Status ID Status Description

0 ORDER CREATED Order is created

5 REFUND CREATED A non-WebCollect order for a refund is created

10 ORDER WITH ATTEMPT A (failed) payment attempt has been made on this order

15 REFUND FAILED A failed refund attempt has been made on a non-WebCollect order

20 ORDER WITH SUCCESFUL ATTEMPT A successful payment attempt has been made on this order

40 ORDER SUCCESFUL The non recurring order was successful

45 REFUND SUCCESFUL The order created for a refund was successful

60 ORDER OPEN The variable amount recurring order is open for new payments

90 ENDED BY MERCHANT The recurring order has been ended on request of the merchant

91 ENDED AUTOMATICALLY The recurring order has been ended automatically

98 REJECTED BY MERCHANT The merchant has rejected the order

99 CANCELLED BY MERCHANT The merchant has cancelled the order

Ingenico document - Reproduction or disclosure prohibited without written authorization

297
Appendix E Payment Products

These payment products include refunds and payouts. For Credit Cards, whenever the product is local, we add the country or region of use

Payment method ID Payment product ID Payment product name

Credit card online

1 1 Visa

1 2 American Express

1 3 MasterCard

1 56 UnionPay International (no authentication)

1 111 Visa Delta

1 114 Visa Debit

1 117 Maestro

1 119 MasterCard Debit

1 120 UATP

1 122 Visa Electron

1 125 JCB

1 128 Discover

1 130 Carte Bancaire

1 132 Diners Club

1 134 American Express Prepaid

1 135 Cabal

1 136 Naranja (Argentina)

1 137 Nevada (Argentina)

1 139 Italcred (Argentina)

1 140 Argencard (Argentina)

1 141 Consumax (Argentina)

1 142 Mas (Argentina)

1 144 Pyme Nacion (Argentina)

1 145 Nativa (Argentina)

1 146 Aura (Brazil)

1 147 ELO (Brazil)

1 148 Hipercard (Brazil)

1 149 Tarjeta Shopping (Argentina)

1 150 Credencial (Argentina)

1 151 Lider (Argentina)

1 152 Kadicard (Argentina)

1 153 Credimas (Argentina)

1 154 Nexo (Argentina)

1 155 Coopeplus (Argentina)

1 156 Favacard (Argentina)

1 157 Club La Nacion (Argentina)

1 158 Club Personal (Argentina)

1 159 Club Arnet (Argentina)

Ingenico document - Reproduction or disclosure prohibited without written authorization

298
1 160 Club Speedy (Argentina)

1 161 Club La Voz (Argentina)

1 162 Clarin 365 (Argentina)

1 163 Hiper (Brazil)

1 164 MIR (Russia)

Payment method ID Payment product ID Payment product name

8 430 UnionPay International

This is a UPOP re- direct

Direct debit

3 705 United Kingdom

3 715 Recurring United Kingdom

3 730 ACH

3 770 SEPA direct debit

Online bank transfer

4 500 BPay

Invoice

6 201 Invoice

Bank transfer

7 11 Bank Transfer

7 51 Depósito Identificado (Bank Transfer Brazil)

7 53 Bank Transfer Argentina

Real-time bank transfer

8 402 e-Przelewy (Poland)

8 801 ING Home’Pay (Belgium)

8 802 Nordea E-maksu (Finland)

8 805 Nordea e- Betalning (Sweden)

8 806 Trustly (Various countries)

8 809 iDEAL (Netherlands)

8 810 eNets (Singapore)

8 816 GiroPay (Germany)

8 818 Sampo (Finland)

8 819 Aktia (Finland)

8 836 Sofort (Various countries)

Payment method ID Payment product ID Payment product name

eWallet

8 840 PayPal

8 841 WebMoney

8 843 Moneybookers

8 849 Yandex

8 861 Alipay

Pre-paid method

Ingenico document - Reproduction or disclosure prohibited without written authorization

299
8 830 PaySafeCard

Cash

15 1501 Western Union

15 1503 Boleto Bancário (Brazil)

15 1504 Konbini (Japan)

15 1506 Pago Fácil (Argentina)

Bank refund

10 1001 Bank refund (non- country-specific)

10 1002 Bank refund Australia

10 1027 Bank refund Brazil

10 1035 Bank refund Canada

10 1028 Bank refund China

10 1019 Bank refund Czech

10 1005 Bank refund Denmark

10 1030 Bank refund Hong Kong

10 1021 Bank refund Hungary

10 1036 Bank refund Indonesia-IDR

10 1037 Bank refund Indonesia-USD

10 1016 Bank refund Japan

10 1018 Bank refund Korea

10 1038 Bank refund Malaysia

10 1011 Bank refund Norway

10 1039 Bank refund Philippines

10 1024 Bank refund Poland

10 1042 Bank refund Romania-EUR

10 1043 Bank refund Romania-RON

10 1034 Bank refund Singapore

10 1032 Bank refund Slovakia

10 1026 Bank refund South Africa

10 1013 Bank refund Sweden

10 1014 Bank refund Switzerland

10 1031 Bank refund Taiwan

10 1041 Bank refund Thailand

10 1015 Bank refund United Kingdom

10 1040 eWallet refund

10 1070 SEPA bank refund

Payment method ID Payment product ID Payment product name

Bank payout

12 1270 SEPA payout

Ingenico document - Reproduction or disclosure prohibited without written authorization

300
Appendix F Recurring orders

Variable recurring orders

Creating a variable recurring billing order
To create a variable recurring billing order, include this information in either your API: INSERT_ORDER or your API:
INSERT_ORDERWITHPAYMENT

ORDERTYPE=4—Variable recurring billing

EFFORTID=1—Indicates the first payment attempt against the order
One or more EFFORTIDs can be associated with each ORDERID
Each EFFORTID is a new request for authorization or settlement against the card number associated with the order
Each EFFORTID contains one or more ATTEMPTIDs
Each ATTEMPTID is the actual authorization attempt against the card for that EFFORTID
CVV CODE—Supplied with the initial order only

If the initial authorization of a card fails, the rest of the recurring payments cannot be made against the order.

Variable recurring billing order structure

Processing a variable recurring billing order

To process a variable recurring billing order, create a new order and include this information in either your API: INSERT_ ORDER or your API:
INSERT_ORDERWITHPAYMENT

ORDERTYPE=4—Variable recurring billing

STEPMONTH=Some value—Required to create the order successfully; you could populate it with a default value such as 120
EFFORTID=1—Indicates the first payment attempt against the order

If the initial authorization of a card fails, the rest of the recurring payments cannot be made against the order.

Creating additional payments

Use your API: DO_PAYMENT to make additional payments against an order that was created as a variable recurring billing order.

The first time your API: DO_PAYMENT is called for an order, the EFFORTID=2.

EFFORTID=1 occurs with the initial transaction created when you use your API: INSERT_ORDER or INSERT_ ORDERWITHPAYMENT.

For each subsequent API: DO_PAYMENT against the same order, the EFFORTID increases by 1.

When using your API: DO_PAYMENT, these keys are important

ORDERID—The ORDERID of the original order

EFFORTID—The new EFFORTID
When you use your API: DO_PAYMENT, the EFFORTID increases by 1 if the previous EFFORTID is authorized successfully
If the authorization is unsuccessful, the same EFFORTID is used

Ingenico document - Reproduction or disclosure prohibited without written authorization

301
For each authorization request against an EFFORTID, the ATTEMPTID increases by 1 automatically
After five consecutive failed ATTEMPTIDs against one EFFORTID, the order is closed and cannot be used for additional
transactions
CURRENCYCODE—The currency in which the consumer is charged
AMOUNT—The amount to charge the consumer

The response to your API: DO_PAYMENT indicates whether the authorization on the card is successful.

Delayed settlement—Direct debits

When using direct debits for recurring payments, use your API: SET_PAYMENT to process the order.

If an account is configured for delayed settlement and a transaction has been successfully authorized, submit your API: SET_PAYMENT to settle the
transaction.

These API: SET_PAYMENT keys are important

ORDERID—The order ID to be settled

PAYMENTPRODUCTID—The payment product used for the order
EFFORTID—The EffortID to be settled
AMOUNT—This key is optional if the amount of the settlement is not identical to the amount of the authorization

The amount can be equal to or less than the original authorization amount. The amount cannot be greater than the original
authorization amount.

The response to your API: SET_PAYMENT indicates whether the request for settlement is successful.

Changing card numbers and expired cards on recurring orders

Where API: DO_PAYMENT does not contain the card details, the default reverts to the data submitted with EFFORTID 1.

Recurring orders in Merchant Link

You manage the recurring aspect of the order and determine if the order is recurring. If yes, you must include order type=4 with your API:
INSERT_ORDER or INSERT_ORDERWITHPAYMENT. Here are some keys to include in your APIs for recurring orders.

For more information about the APIs, see INSERT_ORDER, SET_PAYMENT, and DO_PAYMENT.

Example—Initial order
<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

Ingenico document - Reproduction or disclosure prohibited without written authorization

302
<ORDERTYPE>4</ORDERTYPE>

<SURNAME>Cruijff</SURNAME>

<CITY>Amsterdam</CITY>

<FIRSTNAME>Johan</FIRSTNAME>

<STATE>Catalunie</STATE>

</ORDER>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Example—Subsequent recurring payments

<XML>

<ACTION>DO_PAYMENT</ACTION>

<META>

</META>

Ingenico document - Reproduction or disclosure prohibited without written authorization

303
<MERCHANTREFERENCE>RECR4TH403</MERCHANTREFERENCE>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

Ingenico document - Reproduction or disclosure prohibited without written authorization

304
Appendix G Adding a root certificate to PHP-cURL
This is how to add a root certificate authority to your PHP-cURL installation.

Software requirements
To set up a secure connection to Ingenico ePayments to post data, PHP must be compiled with cURL
To use the cURL functions you must install the cURL package
PHP requires that you use cURL 7.0.2-beta or later
PHP 4.2.3 requires cURL 7.9.0 or later
PHP 4.3.0 requires cURL 7.9.8 or later
PHP 5.0.0 requires cURL 7.10.5 or later

How to do it
If you do not install the cURL CA cert bundle or the Ingenico ePayments certificate signed by a CA that is not included in the bundle and to connect to
Ingenico ePayments, do one of these

Get a CA certificate that can verify the remote server and use the proper option to point out this CA cert for verification when connecting

For libcurl hackers: curl_easy_setopt(curl, CURLOPT_CAPATH, capath);

With the curl command tool: --cacert [file]
Add the CA cert for your server to the existing default CA cert bundle

The default path of the CA bundle installed with the curl package is: /usr/local/share/curl/curl-ca-bundle.crt

This can be changed by running configure --with-ca-bundle option pointing out the path of your choice

Sources
HTTPS://www.php.net/manual/en/ref.curl.php

HTTPS://curl.haxx.se/docs/sslcerts.html

Ingenico document - Reproduction or disclosure prohibited without written authorization

305
Appendix H Country-specific direct debit keys
Country-specific keys

Key Definition Type Product Req Remark

BANKCODE Sorting code N6 705 715 GB R

Branch Sort Code N6 707 717 CH R

BANKNAME Consumer Bank name AN 40 705 715 GB O

AN 40 707 717 CH O

ACCOUNTNUMBER Account Number AN 30 705 715 GB R

Account Number AN 30 707 717 CH R

ACCOUNTNAME Account Name AN 30 705 715 GB R

Account Name AN 30 707 717 CH O

DATECOLLECT Date collect D8 ALL R Format: YYYYMMDD

DIRECTDEBITTEXT Direct debit text AN 50 705 715 GB R

AN 50 707 717 CH R

AUTHORISATIONID Authorization ID AN 18 705 715 GB R

CUSTOMERBANKSTREET Bank Street AN 30 707 717 CH O

CUSTOMERBANKNUMBER Bank House Number N5 707 717 CH O

CUSTOMERBANKZIP Bank zip AN 10 707 717 CH O

CUSTOMERBANKCITY Bank city AN 35 707 717 CH O

IBAN IBAN AN 21 707 717 CH O

ADDRESSLINE1 Address line 1 AN 35 707 717 CH R

ADDRESSLINE2 Address line 2 AN 35 707 717 CH O

ADDRESSLINE3 Address line 3 AN 35 707 717 CH O

ADDRESSLINE4 Address line 4 AN 35 707 717 CH O

TRANSACTIONTYPE Transaction type AN 2 705 715 GB R Values: 01,17,18,19, ON, OC, O

Transaction type GB values

01=First payment direct debit
17=Direct debit (nth payment)
18=Re-presented direct debit (after failed attempt)
19=Final payment direct debit
0N=(zero N) New or reinstated direct debit Instruction
0C=(zero C) Cancellation of direct debit Instruction
0S=(zero S) Conversion of paper DDI to electronic DDI (only used once, when migrating from traditional DD to AUDDIS

If 0N, 0C or 0S is used the amount must be set to zero.

Ingenico document - Reproduction or disclosure prohibited without written authorization

306
Appendix I Additional information about real-time bank
transfers
Real-Time bank transfers
Real-time bank payment systems in various countries share these characteristics

Payment is immediate—As soon as the consumer completes the details and agrees to pay, the transfer of money is initiated and there is no
risk of insufficient funds
Payment is not reversible—The transfer is a regular bank transfer and cannot be reversed by the consumer
Payments are made using familiar online bank systems
The cost for a real-time bank transfer is usually fixed unlike the transaction fee that credit card companies use

Possible scenarios—Processing a real-time bank transfer

WebCollect can process real-time bank transfers in three ways

Using CustomerLink—All payment products are supported by CustomerLink

You do not need to make any changes to accept real-time bank transfers

The bank payment pages display in a pop-up dialog box. For consumers with an active popup blocker, a link is provided to launch the
dialog box manually.

Using MerchantLink—All payment products are supported by MerchantLink

You have to make changes to support the various payment products—You have to redirect the consumer and process responses
from different banks
Using HostedMerchantLink—All payment products are supported using HostedMerchantLink
You have to integrate once; new payment products can be added without you having to make any changes; you do not need to
make changes if there is a change in the interface by the bank—You have to redirect the consumer to Ingenico ePayments who
then redirects the consumer to the bank payment pages; the bank redirects the consumer back to Ingenico ePayments who then
redirects the consumer back to you

Real-time bank transfer payment process using MerchantLink

For real-time bank payment products, use your APIs: INSERT_ORDER and DO_PAYMENT or combine them by using your API:
INSERT_ORDERWITHPAYMENT.

In response, you redirect the consumer to the real-time bank payment pages. This is a redirection or a HTTPS POST of the values that are supplied
in response to the payment request.

The consumer completes the payment on the bank payment pages.

Consumer is making a payment to Ingenico ePayments

When the payment process is complete, the consumer is returned to your pre-defined return page. The bank does a HTTPS POST or a HTTPS GET
to the return page containing the details of the payment.

If WebCollect is unable to determine the status of the payment within two hours of the initial INSERT ORDER WITH PAYMENT or DO
PAYMENT, the payment attempt is revised (status 400 REVISED) and a new payment attempt is created with a different payment
product 11 - Off-line Bank Transfer. If WebCollect determines the status using a batch-job, the payment attempt is revised if the status
of the payment is open (not successful, rejected, cancelled or failed) for more than two hours.

Ingenico ePayments treats all real-time bank payments as regular bank transfers. The payments are matched against the details on a regular bank
statement and reported using the regular reporting methods (WebCollect Payment Console, daily report files, and so on).

The verification process differs from bank to bank. In some cases, verification is performed on the bank system. In other cases, the validity of the
return message is verified only. For example, in the case of a real-time bank transfer in Germany, the payment verification is done on the bank
system to ensure that the payment actually took place. In the case of iDEAL in the Netherlands, the payment is guaranteed only if the final status of
the payment is verified at the bank.

An overview of the real-time bank transfer process

Ingenico document - Reproduction or disclosure prohibited without written authorization

307
For a real-time bank transfer in Germany, you must redirect the consumer to a web page with a Java applet. This applet can be displayed in a
window, a Frame, or an iFrame on your website. In the redirection to the Java applet and the return after the payment, a regular HTTPS GET is used.

Methods for redirection to payment pages

Here are the different methods used for redirection of the consumer to the real-time bank payment pages and back to your site.

Payment product Payment product name Redirecting to the bank Response from bank Remarks
ID

801 ING Home’Pay (Belgium) HTTPS GET HTTPS GET

802 Nordea E-maksu (Finland) HTTPS POST HTTPS POST

803 Nordea E-betaling (Denmark) HTTPS POST HTTPS POST

805 Nordea e-Betalning (Sweden) HTTPS POST HTTPS POST

809 iDEAL (the Netherlands) HTTPS GET HTTPS GET

810 eNets (Singapore) HTTPS POST HTTPS POST

811 Dankse HTTPS POST or HTTPS HTTPS POST or HTTPS

GET GET

816 GiroPay (Germany) HTTPS GET HTTPS GET

818 Sampo HTTPS POST HTTPS POST

819 Aktia HTTPS POST HTTPS POST

830 PaySafeCard (multiple HTTPS GET HTTPS GET

countries)

836 Sofortüberweisung HTTPS POST HTTPS POST

840 PayPal (multiple countries) HTTPS GET HTTPS GET PayPal payment page should display in a pop-up
window

841 Webmoney (multiple HTTPS POST HTTPS POST

countries)

Implementing iDEAL(Netherlands)
If you provide products based on the iDEAL standard, you must use the iDEAL logo in the product presentation to the consumer.

In addition, you are primarily responsible for initiating the payment and communicating the order status to the consumer.

Use iDEAL as a payment method

If you accept the iDEAL payment method, you must include it in the list of payment methods in your order process. The iDEAL payment method must
receive the same amount of attention as other payment methods.

Bank selection

Ingenico document - Reproduction or disclosure prohibited without written authorization

308
The consumer selects the iDEAL payment method, then selects one bank (issuer) from where the transaction is to be processed. Use your API:
GET_DIRECTORY to fetch the list of issuers.

Here are the parameters for the issuer list

The list is a drop-down list

The starting value is ‘Kies uw bank...’ or ‘Choose your bank...’ depending on the language you use
Issuers are presented with the value (option) Issuer.issuerName

For option values in the drop-down list applies: option value=Issuer.issuerID

Issuers are divided into a short-list and a long-list, based on Issuer.issuerList
The shortlist contains the iDEAL issuers with the largest market share of personal accounts (based on information from Interpay)
The lists are separated by the value ‘---Overige banken---’ or ‘---Other banks---’ depending on the language used by you
Banks are listed in alphabetical order in both lists
Consumer selection of ‘Kies uw bank...’ or ‘---Overige banken--’ generates a message stating that the selection of a bank is mandatory.

An iDEAL transaction can start only if the iDEAL payment method and an issuing bank have been selected by the consumer

Pay button
The consumer is aware of how and when the iDEAL transaction is initiated by a Pay button, generally situated on the order-summary page. The
consumer must click the iDEAL Pay button (with the iDEAL logo) to start the transaction.

Ingenico ePayments can provide you with the iDEAL Pay button on request.

Implementing PayPal
If you provide products based on the PayPal standard, you must use the PayPal logo in the product presentation to the consumer.

In addition, you are primarily responsible for initiating the payment and communicating the order status to the consumer.

Use PayPal as a payment method

If you accept the PayPal payment method, you must include it in the list of payment methods in your order process. The PayPal payment method
must receive the same amount of attention as other payment methods.

Redirection
The consumer selects the PayPal payment method, and then is redirected to the PayPal site to log in to his or her personal account to authorize the
payment. The consumer must confirm the payment on the PayPal site to complete the order. When the payment is confirmed, the consumer is
redirected back to your site.

Testing real-time bank transfer payment products

There are too many real-time banks to accommodate easy interface testing; you must have access to a local bank account with the necessary
requirements.

Real-time bank staging environments

Ingenico document - Reproduction or disclosure prohibited without written authorization

309
Payment pro Payment product Staging
duct ID name environment
Remarks

To perform end-to-end tests, you must have an account in one of the online banks listed in the offer—The
banks do not provide staging environments for merchants

Each test transaction must be executed with real, non-refundable money

402 eCard (Poland) No

801 ING Home’Pay No Testing is possible only on the bank production environment using real transactions
(Belgium)

Payment pages are available in Finnish only

802 Nordea E-maksu Yes The test payment pages are not identical to the production payment pages The test payment pages provide a
(Finland) way to test some of the different flows only

Payment pages are available in Danish only

803 Nordea E-betaling Yes The test payment pages are not identical to the production payment pages The test payment pages provide a
(Denmark) way to test some of the different flows only

Nordea e- Payment pages are available in Swedish only

Betalning (Sweden)
805 Yes The test payment pages are not identical to the production payment pages The test payment pages provide a
way to test some of the different flows only

Special test cases are available

809 iDEAL (the Yes The test payment pages are not identical to the production payment pages The test payment pages provide a
Netherlands) way to test some of the different flows only

Special test account details are not necessary

810 eNets Yes The test payment pages are identical to the production payment pages

Only DBS provides a valid test link, the other test links are frequently down

Payment pro Payment produ Staging

duct ID ct name environment
Remarks

811 Dankse No Testing is possible only on the bank production environment using real transactions

The test page is available in German only

Special test account details can be used for testing

816 GiroPay Yes The test payment pages are not identical to the production payment pages The test payment pages provide a
(Germany) way to test some of the different flows only

To perform end-to-end tests, you must have an account with Sampo

818 Sampo Yes Live account details are used, but test settings put in place by Ingenico ePayments allow tests to be made
with no actual transfer of funds

819 Aktia Yes Payment pages are available in Finnish only

Special test details can be used for testing

830 PaySafeCard Yes The test payment pages are identical to the production payment pages

You can test Sofortuberweisung by using bank code 88888888 (eight 8s) for Germany or 00000 (five 0s) for
Austria
836 Sofortüberweisu Yes
ng If you use another bank code, a transaction is processed normally

Special test accounts can be used for testing on staging

840 PayPal Yes The test payment pages are identical to the production payment pages

841 Webmoney Yes The test payment pages are identical to the production payment pages

Test account for GiroPay (Germany)

IBAN BIC Username Password

<you set this value>

DE46940594210000012345 44448888 sepatest1

Test cases for iDEAL (Netherlands)

Ingenico document - Reproduction or disclosure prohibited without written authorization

310
Case IssuerID Amount (in cents) Result

Success ABNANL2A or INGBNL2A 100 Simulate a successful iDEAL transaction

Cancelled ABNANL2A or INGBNL2A 200 Simulate a cancelled iDEAL transaction

Expired ABNANL2A or INGBNL2A 300 Simulate an expired iDEAL transaction

Open ABNANL2A or INGBNL2A 400 Simulate an open/pending iDEAL transaction

Failure ABNANL2A or INGBNL2A 500 Simulate a failed iDEAL transaction

Error ABNANL2A or INGBNL2A 700 Simulate an iDEAL transaction which returns an error

Test details for PaySafeCard

PIN Password Initial value (in cents) Currency Card type

0000000009900828 <empty> 1000000000 EUR Classic

1000000000000828 <empty> 10000 EUR <18

Because of tests carried out by you or other merchants, these test cards may be empty. Contact Ingenico ePayments to reset the test
cards to their initial value.

Ingenico document - Reproduction or disclosure prohibited without written authorization

311
Appendix J 3D Secure authentication—Verified by Visa
and Secure Code
3DS V1
3DS V2

Ingenico document - Reproduction or disclosure prohibited without written authorization

312
3DS V1

Payer authentication
Contact your Ingenico ePayments implementation manager to make sure that your account is configured to support payer
authentication.

When you request an authorization using a Visa or MasterCard credit card and a supported processor, you can include payer authentication data in
any of the following APIs: INSERT_ORDERWITHPAYMENT, DO_ CHECKENROLLMENT and DO_PAYMENT.

Data returned from the issuing banks can be verified using your API: DO_VALIDATE. If you choose not to have authenticated cards authorized
immediately, then you can use your API: DO_FINISHPAYMENT to authorize the transaction.

Credit card online 3D Secure—Authentication only

The first API: DO_PAYMENT, should always be preceded by the API: INSERT_ORDER. These two functions can be combined using the API:
INSERT_ORDERWITHPAYMENT. You can use your API: DO_CHECKENROLLMENT to combine the functions of APIs: INSERT_ORDER and
DO_PAYMENT for authentication of consumers or consumers with no automatic authorization.

Credit card online 3D Secure—Authenticate, automatic authorization

Credit card online 3D Secure—Authenticate, automatic authorization after validation

Ingenico document - Reproduction or disclosure prohibited without written authorization

313
Credit card online 3D Secure—Authenticate, no automatic authorization

Verified by Visa
Verified by Visa reduces the risk of unauthorized use of a cardholder account. Use it to verify the consumer identity with a password. Verified by Visa
provides results to you in real time during the checkout process.

For more information about signing up and using Verified by Visa, contact your Ingenico ePayments account manager.

Ingenico document - Reproduction or disclosure prohibited without written authorization

314
MasterCard SecureCode
MasterCard® SecureCode™ adds security to online transactions by authenticating SecureCode account holders for specific transactions.
SecureCode generates a unique 32-character transaction token called the Account Authentication Value (AAV). This token is generated each time a
SecureCode-enabled account holder makes an online purchase. The AAV binds the account holder to a specific transaction. SecureCode
transactions use standard Universal Cardholder Authentication Field (UCAF™) to collect and pass AAV data.

For more information about signing up and using SecureCode or UCAF, contact your Ingenico ePayments account manager or visit HTTPS://www.
mastercardintl.com.

3D Secure flow

Ingenico document - Reproduction or disclosure prohibited without written authorization

315
Ingenico document - Reproduction or disclosure prohibited without written authorization
316
3DS V2

Payer authentication
Contact your Ingenico ePayments implementation manager to make sure that your account is configured to support payer
authentication.

The first API: DO_PAYMENT, should always be preceded by the API: INSERT_ORDER. These two functions can be combined using the API:
INSERT_ORDERWITHPAYMENT. You can use your API: DO_AUTHENTICATE to combine the functions of APIs: INSERT_ORDER and
DO_PAYMENT for authentication of consumers or consumers with no automatic authorization.

Authentication with automatic Authorization (AuthenticationFailedIndicator

= 0)

Authentication with no automatic Authorization

Hosted Merchant Link - Authentication with automatic Authorization

3D v2 Flow

Ingenico document - Reproduction or disclosure prohibited without written authorization

317
Ingenico document - Reproduction or disclosure prohibited without written authorization
318
Appendix K Bank validation errors and warnings

Andorra
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank code format is incorrect

70 Branch supporting direct debit warning This branch will not support direct debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting direct debit warning This account will not support direct debit transactions

110 Branch supporting direct credit warning This branch will not support direct credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected closed bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting direct credit warning This account will not support direct credit transactions

310 Branch code format error Branch code format is incorrect

340 Allocate branch code error Branch code not submitted

620 Allocate bank code error Bank code not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Australia
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

Ingenico document - Reproduction or disclosure prohibited without written authorization

319
210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank code format error Bank Code format is incorrect

500 Bank Branch Code format error Bank/Branch Code format is incorrect

520 Bank code allocation error Bank code not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Austria
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

10 Account number or bankleitzahl incorrect error Modulus check failed

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank code format is incorrect

70 Branch supporting direct debit warning This branch will not support direct debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting direct debit warning This account will not support direct debit transactions

110 Branch supporting direct credit warning This branch will not support direct credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected closed bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting direct credit warning This account will not support direct credit transactions

340 Allocate branch code error Branch code not submitted

500 Bank code format error Bank code format is incorrect

620 Allocate bank code error Bank code not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

800 Branch in use error The supplied IBAN is an invalid format

810 Branch merged error The validation of the IBAN has failed (not in Db)

Belgium
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

Ingenico document - Reproduction or disclosure prohibited without written authorization

320
50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

330 Check digit format error Check Digit format is incorrect

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Bosnia and Herzegovina

Code Description Error or warning Meaning

50 Account number format error Account number format incorrect

60 Bank code format error Bank Code format is incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

310 Branch code format error Branch Code format is incorrect

330 Check digit format error Check Digit format is incorrect

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

640 Modulus check Account Number error Account number failed modulus check

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

Ingenico document - Reproduction or disclosure prohibited without written authorization

321
750 Validation BIC error The validation of the BIC has failed (not in Db)

Bulgaria
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Canada
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank Code format is incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank/branch code format error Bank/Branch code format is incorrect

635 Modulus check present warning Modulus check present but not performed

Ingenico document - Reproduction or disclosure prohibited without written authorization

322
700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Croatia
Code Description Error or warning Meaning

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

630 Modulus check Bank Code error Bank code failed modulus check

635 Modulus check present warning Modulus check present but not performed

640 Modulus check Account Number error Account number failed modulus check

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Cyprus
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank Code format is incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

Ingenico document - Reproduction or disclosure prohibited without written authorization

323
140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

310 Branch code format error Branch Code format is incorrect

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Czech Republic
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

Ingenico document - Reproduction or disclosure prohibited without written authorization

324
145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Estonia
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Finland
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

Ingenico document - Reproduction or disclosure prohibited without written authorization

325
110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

France
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Standard form account details warning Account details are not in standard form and were transposed

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

300 Bank code format error Bank Code format is incorrect

310 Branch code format error Branch Code format is incorrect

330 Check digit format error Check Digit format is incorrect

330 Check digit format error Check Digit format is inco

340 Allocate bank code/branch code error Bank/Branch code not submitted

360 Allocate bank code error Bank code not submitted

635 Modulus check present warning Modulus check present but not performed

Ingenico document - Reproduction or disclosure prohibited without written authorization

326
700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Germany
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

500 Bank/branch code format error Bank/Branch code format is incorrect

520 Bank/branch code allocation error Bank code not submitted

530 Validation modulus check algorithm on account number warning Validation modulus check algorithm on account number

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

7000 Blacklist, repetition and limit checks warning Account is blacklisted

7001 Card invalid error Card invalid

Greece
These codes also apply to direct debits and bank refunds.

Ingenico document - Reproduction or disclosure prohibited without written authorization

327
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank Code format is incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

310 Branch code format error Branch Code format is incorrect

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Hong Kong
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank Code format is incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

310 Branch code format error Branch Code format is incorrect

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

Ingenico document - Reproduction or disclosure prohibited without written authorization

328
740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Hungary

Code Description Error or warning Meaning

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

330 Check digit format error Check Digit format is incorrect

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

620 Allocate bank code error Bank code not submitted

630 Modulus check Bank Code error Bank code failed modulus check

635 Modulus check present warning Modulus check present but not performed

640 Modulus check Account Number error Account number failed modulus check

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Iceland
Code Description Error or warning Meaning

30 Modulus checking Error Modulus check failed

50 Account number format error Account number format incorrect

55 Identification format error Fiscal Number format incorrect

65 Account type format error Account type format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

Ingenico document - Reproduction or disclosure prohibited without written authorization

329
135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Indonesia
Code Description Error or warning Meaning

30 Modulus checking Error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

310 Branch code format error Branch code format is incorrect

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

Ireland
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

Ingenico document - Reproduction or disclosure prohibited without written authorization

330
135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Italy
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank Code format is incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

310 Branch code format error Branch Code format is incorrect

330 Check digit format error Check Digit format is incorrect

340 Allocate Branch Code error Branchcode not submitted

620 Allocate bank code error Bank code not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Latvia
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

Ingenico document - Reproduction or disclosure prohibited without written authorization

331
50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Liechtenstein
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Lithuania

Ingenico document - Reproduction or disclosure prohibited without written authorization

332
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Luxembourg
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Ingenico document - Reproduction or disclosure prohibited without written authorization

333
Malta
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

620 Allocate bank code error Bank code not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Mexico
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

Ingenico document - Reproduction or disclosure prohibited without written authorization

334
Monaco
Monaco uses the same codes as France.

Netherlands
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

0030 Modulus checking error Modulus check failed

0050 Account number format error Account number format incorrect (non-Postbank)

0051 Postgiro format error Account number format incorrect (Postbank)

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branch code not submitted

500 Bank branch code format error Bank / branch code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

0030 Modulus checking Error Modulus check failed

0050 Account number format Error Account number format incorrect (non-Postbank)

0051 Postgiro format Error Account number format incorrect (Postbank)

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

New Zealand
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

Ingenico document - Reproduction or disclosure prohibited without written authorization

335
80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Norway
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Ingenico document - Reproduction or disclosure prohibited without written authorization

336
Poland
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Portugal
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank Code format is incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

310 Branch code format error Branch Code format is incorrect

330 Check digit format error Check Digit format is incorrect

340 Allocate Branch Code error Branchcode not submitted

Ingenico document - Reproduction or disclosure prohibited without written authorization

337
635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Romania
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank Code format is incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

San Marino
San Marino uses the same codes as Italy.

Singapore
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank Code format is incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

Ingenico document - Reproduction or disclosure prohibited without written authorization

338
110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

310 Branch code format error Branch Code format is incorrect

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Slovakia
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Slovenia

Ingenico document - Reproduction or disclosure prohibited without written authorization

339
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

South Africa
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

Ingenico document - Reproduction or disclosure prohibited without written authorization

340
740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Spain
These codes also apply to direct debits and bank refunds.

Code Description Error or warning Meaning

50 Account number format Error Account number format incorrect

130 Closed branch error This branch has closed

135 Closed bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected closed bank error This bank has closed

300 Bank code format Error Bank code format is incorrect

310 Branch code format Error Branch code format is incorrect

330 Check digit format Error Check digit format is incorrect

340 Allocate branch code Branch code not submitted

630 Modulus check bank code has failed Error Modulus check bank code has failed

640 Modulus check account number has failed Error Modulus check account number has failed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Sweden
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

Ingenico document - Reproduction or disclosure prohibited without written authorization

341
145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Switzerland
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branch code not submitted

500 Bank / branch code format error Bank / branch code format is incorrect

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Thailand
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank Code format is incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

Ingenico document - Reproduction or disclosure prohibited without written authorization

342
120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

310 Branch code format error Branch Code format is incorrect

340 Allocate Branch Code error Branchcode not submitted

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Tunisia
Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank Code format is incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

United Kingdom
Code Description Error or warning Meaning

10 Modulus checking applied to account details warning Modulus checking cannot be applied to these account details

20 Sort Code allocated error Sort Code not allocated to any bank branch

30 Modulus checking error Modulus check failed

40 Local currency warning Account is a foreign currency account

50 Account number format error Account number format incorrect

60 Sort Code format error Sort Code format incorrect

70 Branch supporting direct debit warning This branch will not support direct debit transactions

Ingenico document - Reproduction or disclosure prohibited without written authorization

343
80 Standard form account details warning Account details are not in standard form and were transposed

81 Modulus check available warning No modulus checking available

90 Account supporting direct debit warning This account will not support direct debit transactions

100 Reference / roll account number requirement warning Reference / roll account number required

110 Branch supporting direct credit warning This branch will not support direct credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

160 Branch supporting claims for unpaid check transactions warning This branch will not support claims for unpaid check transactions

170 Branch supporting life assurance premiums transactions warning This branch will not support life assurance premium transactions

180 Branch supporting building society credit transactions warning This branch will not support building society credit transactions

190 Branch supporting dividend interest payment transactions warning This branch will not support dividend interest payment transactions

200 Branch supporting AUDDIS warning This branch will not support AUDDIS transactions

210 Account supporting direct credit warning This account will not support direct credit transactions

220 Account supporting claims for unpaid check transactions warning This account will not support claims for unpaid check transactions

230 Account supporting life assurance premiums transactions warning This account will not support life assurance premium transactions

240 Account supporting building society credit transactions warning This account will not support building society credit transactions

260 Account supporting AUDDIS warning This account will not support AUDDIS transactions

635 Modulus check present warning Modulus check present but not performed

700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

United States of America

Code Description Error or warning Meaning

30 Modulus checking error Modulus check failed

50 Account number format error Account number format incorrect

60 Bank code format error Bank Code format is incorrect

70 Branch supporting Direct Debit warning This branch will not support Direct Debit transactions

80 Account Details warning Account details missing

81 Modulus check available warning No modulus checking available

90 Account supporting Direct Debit warning This account will not support Direct Debit transactions

110 Branch supporting Direct Credit warning This branch will not support Direct Credit transactions

120 Due closure branch warning This branch is due to close

130 Closed branch error This branch has closed

135 Closed Bank error This bank was closed

140 Redirected closed branch error This branch has closed

145 Redirected Closed Bank error This bank has closed

150 Redirected due closure branch warning This branch is due to close

210 Account supporting Direct Credit warning This account will not support Direct Credit transactions

340 Allocate Branch Code error Branchcode not submitted

500 Bank Branch Code format error Bank/Branch Code format is incorrect

635 Modulus check present warning Modulus check present but not performed

Ingenico document - Reproduction or disclosure prohibited without written authorization

344
700 IBAN format error The supplied IBAN is an invalid format

710 Validation IBAN error The validation of the IBAN has failed (not in Db)

720 Modulus check IBAN error Modulus check on the IBAN failed

740 BIC format error Invalid BIC format supplied

750 Validation BIC error The validation of the BIC has failed (not in Db)

Vatican
The Vatican uses the same codes as Italy.

Ingenico document - Reproduction or disclosure prohibited without written authorization

345
Ingenico document - Reproduction or disclosure prohibited without written authorization
346
Appendix L IBAN structure
An International Bank Account Number (IBAN) identifies an account held by a financial institution and facilitates the automated processing of cross-
border transactions.

The IBAN is implemented without modification to the Basic Bank Account Number (BBAN), being the domestic account number. This is done by
adding a prefix to the domestic account number. In some countries, an additional bank identifier is added.

The banking industry of each individual country specifies the country-specific length and the composition of the IBAN.

How an IBAN is structured

Example: 1212 1234 1234 5678 90

The length of an IBAN is fixed for each country. It is

The ISO country code—Part d

A check digit—Part e
For some countries, an extra bank identifier, for IBAN purposes only—Part f
The basic bank account number (BBAN)—Parts a, b, and c

Identifying Length Start position

d 12 ISO country code 2A 1

e 12 Check digits (IBAN) 2N 3

f 1234 Bank identifier 4A 5

b Bank - branch code

a 1234567890 Account number 10N 9

c Check digits

Total 18AN

Summary of European and non-European IBAN implementations

The position of the Bank/Branch identifier is interpreted from the first digit mentioned up to and including the last digit.

Country Length Position of bank/branch identifier Issuing start date Examples of paper representation

Andorra 24AN 5–12 Q1 2003 AD12 0001 2030 2003 5910 0100

Austria 20AN 5–9 Q2 1999 AT61 1904 3002 3457 3201

Belgium 16AN 5–7 06-2000 BE68 5390 0754 7034

Bosnia and Herzegovina 20AN 5–10 To be determined BA39 1290 0794 0102 8494

Bulgaria 22AN 5–12 2006 BG80 BNBG 9661 1020 3456 78

Croatia 21AN 5–11 2004 HR12 1001 0051 8630 0016 0

Cyprus 28AN 5–12 12-2003 to 4-2004 CY17 0020 0128 0000 0012 0052 7600

Czech Republic 24AN 5–8 2003 CZ65 0800 0000 1920 0014 5399

Denmark 18AN 5–8 07-2000 DK50 0040 0440 1162 43

Estonia 20AN 5–8 01-2004 EE38 2200 2210 2014 5685

Finland 18AN 5–10 Autumn 2001 FI21 1234 5600 0007 85

France 27AN 5–14 01-1997 FR14 2004 1010 0505 0001 3M02 606

Germany 22AN 5–12 02-1998 DE89 3704 0044 0532 0130 00

Gibraltar 23AN 5–8 07-2003 GI75 NWBK 0000 0000 7099 453

Greece 27AN 5–11 01-2002 GR16 0110 1250 0000 0001 2300 695

Hungary 28AN 5–11 01-2002 HU42 1177 3016 1111 1018 0000 0000

Iceland 26AN 5–8 To be supplied IS14 0159 2600 7654 5510 7303 39

Ireland 22AN 5–14 Q4 2001 IE29 AIBK 9311 5212 3456 78

Italy 27AN 6–15 01-2000 IT60 X054 2811 1010 0000 0123 456

Latvia 21AN 5–8 01-2004 LV80 BANK 0000 4351 9500 1

Liechtenstein 21AN 5–9 01-2004 LI21 0881 0000 2324 013A A

Ingenico document - Reproduction or disclosure prohibited without written authorization

347
Lithuania 20AN 5–9 01-2004 LT12 1000 0111 0100 1000

Luxembourg 20AN 5–7 01-1999 LU28 0019 4006 4475 0000

Macedonia, Former Yugoslav Republic of 19AN 5–7 07-2005 MK07 3000 0000 0042 425

Malta 31AN 5–13 01-2004 MT84 MALT 0110 0001 2345 MTLC AST0 01S

Mauritius-Non-European country 30AN 5–12 04-2006 MU17 BOMM 0101 1010 3030 0200 000M UR

Netherlands 18AN 5–8 08-1999 NL91 ABNA 0417 1643 00

Norway 15AN 5–8 11-1999 NO93 8601 1117 947

Poland 28AN 5–12 05-2004 PL27 1140 2004 0000 3002 0135 5387

Portugal 25AN 5–12 10-2000 PT50 0002 0123 1234 5678 9015 4

Romania 24AN 5–8 2004 RO49 AAAA 1B31 0075 9384 0000

Serbia and Montenegro 22AN 5–7 01-2005 CS73 2600 0560 1001 6113 79

Slovak Republic 24AN 5–8 05-2004 SK31 1200 0000 1987 4263 7541

Slovenia 19AN 5–9 01-2000 SI56 1910 0000 0123 438

Spain 24AN 5–12 06-2000 ES91 2100 0418 4502 0005 1332

Sweden 24AN 5–7 04-2001 SE35 5000 0000 0549 1000 0003

Switzerland 21AN 5–9 01-2000 CH93 0076 2011 6238 5295 7

Tunisia 24AN1 5–9 04-2004 TN59 1420 7207 1007 0712 9648

Turkey 26AN 5–9 09-2005 TR33 0006 1005 1978 6457 8413 26

United Kingdom 22AN 5–14 04-2001 GB29 NWBK 6016 1331 9268 19

Source of information about IBANs

European Committee for Banking Standards - Register of European Account Numbers TR201 V3.21—NOVEMBER 2006 (HTTPS://www.ecbs.org/)

Ingenico document - Reproduction or disclosure prohibited without written authorization

348
Appendix M Fraud screening
Fraud results and fraud codes
When a fraud check is performed on a transaction, WebCollect returns a fraud result and a fraud code
The fraud code provides additional information about the fraud result
In addition, you can receive a fraud neural value (a raw neural score) and a fraud RCF value
The fraud neural and fraud RCF values represent sets of fraud rules returned during the evaluation of the transaction
Each rule category flag (RCF) is customized and client-configurable, and is set up as part of the fraud service installation process

Fraud results

Fraud result Description

N No fraud requested

C Challenged

A Accept

D Denied/Fraudulent

E Error while checking

Fraud codes

Fra Description
ud
code

0000 No Score—A transaction is submitted to ebitGuard™ for data warehousing and modeling purposes only

A risk assessment is not performed on this transaction

0100 Accept

0150 Always Accept—An attribute associated with an order matched a pre-configured Always Accept rule

0200 Authorization Decline—The card number appears in a bank- or card-association negative file database

0250 Always Deny—An attribute associated with an order matched a pre-configured Always Deny rule

0300 Suspicious Usage—A combination of customized rules and neural-based fraud assessments has determined the card usage is suspicious
and possibly fraudulent

A Deny recommendation is returned

0330 Rule Challenge—Criteria is met for a client-specific customized rule designed to return a Challenge response

0400 Suspicious Usage—A combination of customized rules and neural-based fraud assessments has determined that the card usage is
suspicious and possibly fraudulent and the card number appeared in a Retail Decisions (ReD) card database

A Deny recommendation is returned

0500 Questionable Usage—A combination of customized rules and neural-based fraud assessments has determined that the card usage is
questionable and possible fraudulent—The overall ebitGuard™ assessment has fallen within a gray area, as defined by ReD and the
merchant during service installation

A Challenge recommendation is returned

0600 Questionable Usage—The card number associated with the order is found in a ReD card database A Challenge recommendation is returned

or
0610

0700 Velocity or Rules Threshold Violation—An attribute associated with an order exceeded a pre-configured rules threshold

0800 Tumbling or Swapping Pattern Detected—The ebitGuard™ tumbling and swapping engine detected an unusual usage pattern in the card
number, expiration date, or consumer email address associated with a transaction

901 Internal Error—An internal ebitGuard™ error has occurred

Contact Ingenico ePayments

902 Validation Error—The format of a particular key is invalid or a required input key is missing

Contact Ingenico ePayments

1000 Screening Service Always Accept—An attribute associated with an order matched a pre-configured Always Accept screening entry in the
ReD proprietary screening database service

Ingenico document - Reproduction or disclosure prohibited without written authorization

349
1300 Screening Challenge—An attribute associated with an order matched a pre-configured Challenge screening entry in the ReD proprietary
screening database service

1700 Screening Service Always Challenge—An attribute associated with an order matched a pre-configured Always Challenge screening entry in
the ReD proprietary screening database service

1800 Screening Service Challenge—An attribute associated with an order matched a pre-configured Challenge screening entry in the ReD
proprietary screening database service

2000 Screening Service Deny—An attribute associated with an order matched a negative entry in the ReD proprietary screening database service

For the first collections from a Postgiro account (called "onzuivere posten"), the account number is checked against the account name
and city by Postbank. This takes an additional processing day.

Intercard fraud codes

Return code Description Commercial offering promoted by Intercard

0 Successful

56 Card Invalid Verification of account check digits and bank identification code (algorithms)

62 Card Checking of blacklist

Blocked
Velocity check within one merchant—A follow-up transaction check of several purchases for a particular period of
time

Fraud screening service

The fraud screening service requires additional information about the consumer, and the order and payment.

The more information you send using your API, the better your fraud screening quality is.

Credit card online scenarios

* For easy reference, here are the keys for Insert Order with Payment (IOWP). Because the fraud screening service applies to credit
cards only, the keys for credit card payments are listed. For more information about the API, see INSERT_ORDERWITHPAYMENT.

Fraud screening service keys with specific key lengths

The third-party fraud screening service uses different key lengths than those used by WebCollect
The data submitted in the Payment section leads for the fraud screening service; it always overrules the order data

Ingenico document - Reproduction or disclosure prohibited without written authorization

350
Key Type R Remark
eq

META R

MERCHANTID N10 R Ingenico ePayments concatenates MERCHANTID (N10) and ATTEMPTID (N5) to use as a reference for the fraud
screening

IPADDRESS AN R This key is only used if you use the CustomerLink interface
32

ENDMETA R

PARAMS R

ORDER R

ORDERID N10 R Ingenico ePayments concatenates ORDERID (N10) and EFFORTID (N5) to create a unique ID for each fraud screening

IPADDRESSCUSTOMER AN R This key is used only if the consumer uses the MerchantLink interface and the PAYMENT—CUSTOMERIPADDRESS is
32 empty

CUSTOMERID AN O
15

FIRSTNAME AN O The value in this field is used when the same-name parameter is empty in the payment part of the request
15

PREFIXSURNAME AN O The value in this field is used when the same-name parameter is empty in the payment part of the request
15

SURNAME AN O The value in this field is used when the same-name parameter is empty in the payment part of the request
30
Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
INSERT_ ORDERWITHPAYMENT

STREET AN O The value in this field is used when the same-name parameter is empty in the payment part of the request
30
Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
INSERT_ ORDERWITHPAYMENT

HOUSENUMBER AN O The value in this field is used when the same-name parameter is empty in the payment part of the request
15

ADDITIONALADDRESSINFO AN O The value in this field is used when the same-name parameter is empty in the payment part of the request
30
Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
INSERT_ ORDERWITHPAYMENT

CITY AN O The value in this field is used when the same-name parameter is empty in the payment part of the request
20
Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
INSERT_ ORDERWITHPAYMENT

STATE AN2 O The value in this field is used when the same-name parameter is empty in the payment part of the request

Use the state abbreviation, for example, NY=New York

SHIPPINGFIRSTNAME AN O
15

SHIPPINGPREFIXSURNAME AN O
15

SHIPPINGSURNAME AN O Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
30 INSERT_ ORDERWITHPAYMENT

SHIPPINGSTREET AN O Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
30 INSERT_ ORDERWITHPAYMENT

SHIPPINGHOUSENUMBER AN O
15

SHIPPINGADDITIONALADD AN O Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
RESSINFO 30 INSERT_ORDERWITHPAYMENT

SHIPPINGZIP AN9 R A different key length is used for fraud screening

SHIPPINGCITY AN O A different key length is used for fraud screening

20
Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
INSERT_ ORDERWITHPAYMENT

SHIPPINGSTATE AN2 O Use the state abbreviation, for example, NY=New York

SHIPPINGCOUNTRYCODE AN2 O

EMAIL AN O Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
45 INSERT_ ORDERWITHPAYMENT

PHONENUMBER AN O A different key length is used for fraud screening

12
Ingenico ePayments removes all non-numeric elements

BIRTHDATE N8 O

ENDORDER R

PAYMENT R

Ingenico document - Reproduction or disclosure prohibited without written authorization

351
AMOUNT N7 R Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
INSERT_ ORDERWITHPAYMENT

CURRENCYCODE AN3 R

COUNTRYCODE AN2 R

EXPIRYDATE N4 R

CREDITCARDNUMBER N19 R

ISSUENUMBER N2 O Relevant for certain Switch cards

CVV N3 O
/N4

CVVINDICATOR N1 O

FIRSTNAME AN O If this key is left empty, the relevant key from the ORDER part of the request is used instead
15

PREFIXSURNAME AN O If this key is left empty, the relevant key from the ORDER part of the request is used instead
15

SURNAME AN O If this key is left empty, the relevant key from the ORDER part of the request is used instead
30
Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
INSERT_ ORDERWITHPAYMENT

STREET AN O If this key is left empty, the relevant key from the ORDER part of the request is used instead
30
Ingenico ePayment scuts off the value if it exceeds the needed length but is still within the regular limits of the API:
INSERT_ ORDERWITHPAYMENT

HOUSENUMBER AN O If this key is left empty, the relevant key from the ORDER part of the request is used instead
15

ADDITIONALADDRESSINFO AN O If this key is left empty, the relevant key from the ORDER part of the request is used instead
30
Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
INSERT_ ORDERWITHPAYMENT

ZIP AN9 R A different key length is used for fraud screening

If this key is left empty, the relevant key from the ORDER part of the request is used instead

CITY AN O If this key is left empty, the relevant key from the ORDER part of the request is used instead
20
Ingenico ePayments cuts off the value if it exceeds the needed length but is still within the regular limits of the API:
INSERT_ ORDERWITHPAYMENT

STATE AN2 O If this key is left empty, the relevant key from the ORDER part of the request is used instead

Use the state abbreviation, for example, NY=New York

CUSTOMERIPADDRESS AN O If this key is empty and you are using the MerchantLink interface, the ORDER.IPADDRESSCUSTOMER is used instead
32

PHONENUMBER AN O A different key length is used for fraud screening

12
If this key is left empty, the relevant key from the ORDER part of the request is used instead

Ingenico ePayments removes all non-numeric elements

EMAIL AN O If this key is left empty, the relevant key from the ORDER part of the request is used instead
45
Ingenico ePayments truncates the value in cases where it exceeds the desired length but is still within the regular limits
of the Insert Order With Payment request

BIRTHDATE N8 O If this key is left empty, the relevant key from the ORDER part of the request is used instead

ENDPAYMENT R

PARAMS R

Mapping FRAUDFIELDS to Customer service interface (CSI) fields

Key Definition Type CSI tool field

FRAUDFIELDS Marker (no key) – –

EBT_USER_DATA1 AN256 User Data01

EBT_USER_DATA2 AN256 User Data02

EBT_USER_DATA3 AN256 User Data03

EBT_USER_DATA4 AN256 User Data04

EBT_USER_DATA5 AN256 User Data05

EBT_USER_DATA6 AN256 User Data06

EBT_USER_DATA7 AN256 User Data07

Ingenico document - Reproduction or disclosure prohibited without written authorization

352
EBT_USER_DATA8 AN256 User Data08

EBT_USER_DATA9 AN256 User Data09

EBT_USER_DATA10 AN256 User Data10

EBT_USER_DATA11 AN256 User Data11

EBT_USER_DATA12 AN256 User Data12

EBT_USER_DATA13 AN256 User Data13

EBT_USER_DATA14 AN256 User Data14

EBT_USER_DATA15 AN256 User Data15

EBT_USER_DATA16 AN256 User Data16

Specifies if the consumer enters a password to gain access to an account registered with the merchant

These values only

EBT_PASSWORD Y=Yes AN1 password

N=No

Specifies if the consumer has a history of online shopping with the merchant

These values only

EBT_PREVCUST Y=Yes AN1 Previous Customer

N=No

Gift card type These values only AN1 Gift Card Type

EBGIFTCARDTYPE 1=Celebrate Fall

2=Grandparent's Day l 4=Independence Day l A=Anniversary
B=Birthday
C=Congratulations l D=April Fool's Day l E=Easter
F=Father's Day
G=Graduation
H=Holiday
I=Season's Greetings
J=Passover
K=Kwanzaa
L=Halloween
M=Mother's Day
N=New Year's Day
O=Bosses' Day
P=St. Patrick's DayQ=Sweetest Day
R=Christmas
S=Baby Shower l T=Thanksgiving l U=Other
V=Valentine's Day
W=Wedding
X=Secretary's Day
Y=Chinese New Year
Z=Hanukkah

Example for API: DO_RISKASSESSMENT

<XML>

<ACTION>DO_RISKASSESSMENT</ACTION>

<META>

</META>

<ORDER>

Ingenico document - Reproduction or disclosure prohibited without written authorization

353
<COUNTRYCODE>DE</COUNTRYCODE>

<EMAIL>[email protected]</EMAIL>

<SURNAME>Cruijff</SURNAME>

<FIRSTNAME>Jopie</FIRSTNAME>

<CITY>Barcelona</CITY>

<STATE>Catalunia</STATE>

</ORDER>

<EBT_USER_DATA1>Data 1</EBT_USER_DATA1>

<EBT_USER_DATA2>Data 2</EBT_USER_DATA2>

<EBT_USER_DATA3>Data 3</EBT_USER_DATA3>

<EBT_USER_DATA4>Data 4</EBT_USER_DATA4>

<EBT_USER_DATA5>Data 5</EBT_USER_DATA5>

<EBT_USER_DATA6>Data 6</EBT_USER_DATA6>

<EBT_USER_DATA7>Data 7</EBT_USER_DATA7>

<EBT_USER_DATA8>Data 8</EBT_USER_DATA8>

<EBT_USER_DATA9>Data 9</EBT_USER_DATA9>

<EBT_USER_DATA10>Data 10</EBT_USER_DATA10>

<EBT_USER_DATA11>Data 11</EBT_USER_DATA11>

<EBT_USER_DATA12>Data 12</EBT_USER_DATA12>

<EBT_USER_DATA13>Data 13</EBT_USER_DATA13>

<EBT_USER_DATA14>Data 14</EBT_USER_DATA14>

<EBT_USER_DATA15>Data 15</EBT_USER_DATA15>

<EBT_USER_DATA16>Data 16</EBT_USER_DATA16>

<EBT_PASSWORD>Y</EBT_PASSWORD>

<EBT_PREVCUST>Y</EBT_PREVCUST>

<EBGIFTMESSAGE>Test message</EBGIFTMESSAGE>

<EBSHIPCOMMENTS>Test comments</EBSHIPCOMMENTS>

<EBWEBSITE>www.yourTESTwebsite.com</EBWEBSITE>

</FRAUDFIELDS>

Ingenico document - Reproduction or disclosure prohibited without written authorization

354
<COUNTRYCODE>DE</COUNTRYCODE>

</PAYMENT>

</RISKASSESSMENT>

</PARAMS>

</REQUEST>

</XML>

CSI tool screen for API: DO_RISKASSESSMENT:

Example for API: INSERT_ORDERWITHPAYMENT

<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

</ORDER>

Ingenico document - Reproduction or disclosure prohibited without written authorization

355
<EBT_USER_DATA1>Data 1</EBT_USER_DATA1>

<EBT_USER_DATA2>Data 2</EBT_USER_DATA2>

<EBT_USER_DATA3>Data 3</EBT_USER_DATA3>

<EBT_USER_DATA4>Data 4</EBT_USER_DATA4>

<EBT_USER_DATA5>Data 5</EBT_USER_DATA5>

<EBT_USER_DATA6>Data 6</EBT_USER_DATA6>

<EBT_USER_DATA7>Data 7</EBT_USER_DATA7>

<EBT_USER_DATA8>Data 8</EBT_USER_DATA8>

<EBT_USER_DATA9>Data 9</EBT_USER_DATA9>

<EBT_USER_DATA10>Data 10</EBT_USER_DATA10>

<EBT_USER_DATA11>Data 11</EBT_USER_DATA11>

<EBT_USER_DATA12>Data 12</EBT_USER_DATA12>

<EBT_USER_DATA13>Data 13</EBT_USER_DATA13>

<EBT_USER_DATA14>Data 14</EBT_USER_DATA14>

<EBT_USER_DATA15>Data 15</EBT_USER_DATA15>

<EBT_USER_DATA16>Data 16</EBT_USER_DATA16>

<EBT_PASSWORD>N</EBT_PASSWORD>

<EBT_PREVCUST>N</EBT_PREVCUST>

<EBGIFTMESSAGE>Gift message</EBGIFTMESSAGE>

<EBSHIPCOMMENTS>Shipping comments</EBSHIPCOMMENTS>

<EBWEBSITE>www.yourwebsite.com</EBWEBSITE>

</FRAUDFIELDS>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

CSI tool screen for API: INSERT_ORDERWITHPAYMENT:

Ingenico document - Reproduction or disclosure prohibited without written authorization

356
Customer service interface (CSI) mapping of additional details fields to
airline data and FRAUDFIELDS
For airlines, any data submitted in these fraud user fields overwrites the data coming from the airline fields. The airline has the flexibility to control the
data used for fraud screening separate from the airline fields used towards the acquirers.

CSI field Airline field FRAUDFIELD

Carrier

ORIGINAIRPORT

Gift Message ARRIVALAIRPORT EBGIFTMESSAGE

Handling

Customer Email

password EBT_PASSWORD

Previous Customer EBT_PREVCUST

Return Allowed

Service

Comments POSCITYCODE EBSHIPCOMMENTS

Ship Method

Sub Total

Tax

Total

Website

Currency

IP Address

Wrapped

User Data01 EBT_USER_DATA1

User Data02 EBT_USER_DATA2

User Data02 EBT_USER_DATA3

User Data03 CLASS EBT_USER_DATA4

User Data05 EBT_USER_DATA5

Ingenico document - Reproduction or disclosure prohibited without written authorization

357
Gift Card Type EBGIFTCARDTYPE

Customer Gender

Driver Licence

192 Service

User Data06 ISTHIRDPARTY EBT_USER_DATA6

User Data07 CUSTOMERID EBT_USER_DATA7

User Data08 ISREGISTEREDCUSTOMER EBT_USER_DATA8

User Data09 EBT_USER_DATA9

User Data10 CLASS EBT_USER_DATA10

User Data11 PASSENGERNAME EBT_USER_DATA11

User Data12 EBT_USER_DATA12

User Data13 TICKETNUMBER EBT_USER_DATA13

User Data14 EBT_USER_DATA14

User Data15 EBT_USER_DATA15

User Data16 EBT_USER_DATA16

User Data17

User Data18

User Data19

User Data20

User Data21

User Data22

User Data23

User Data24

User Data25

Example when airline data is submitted only

Airline data is remarked.

<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

</ORDER>

Ingenico document - Reproduction or disclosure prohibited without written authorization

358
<AIRLINENAME>Air France KLM</AIRLINENAME>

<POINTOFSALE>IATA point of sale name</POINTOFSALE>

<PLACEOFISSUE>PLACEOFISSUE</PLACEOFISSUE>

<PASSENGERNAME>Cruijff</PASSENGERNAME>

<FAREBASIS>INTERNET</FAREBASIS>

</FLIGHTLEG>

<FAREBASIS>INTERNET</FAREBASIS>

</FLIGHTLEG>

</FLIGHTLEGS>

</AIRLINEDATA>

Ingenico document - Reproduction or disclosure prohibited without written authorization

359
<EXPIRYDATE>0513</EXPIRYDATE>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

CSI tool screen when only airline data is submitted:

Example when airline data and FRAUDFIELDS are submitted

The data that displays in the CSI tool is remarked.

<XML>

<ACTION>INSERT_ORDERWITHPAYMENT</ACTION>

<META>

</META>

<ORDER>

</ORDER>

<AIRLINENAME>Air France KLM</AIRLINENAME>

Ingenico document - Reproduction or disclosure prohibited without written authorization

360
<AGENTNUMBERICCODE>123321</AGENTNUMBERICCODE>

<POINTOFSALE>IATA point of sale name</POINTOFSALE>

<PLACEOFISSUE>PLACEOFISSUE</PLACEOFISSUE>

<PASSENGERNAME>Cruijff</PASSENGERNAME>

<FAREBASIS>INTERNET</FAREBASIS>

</FLIGHTLEG>

<FAREBASIS>INTERNET</FAREBASIS>

</FLIGHTLEG>

</FLIGHTLEGS>

</AIRLINEDATA>

<EBT_USER_DATA1>Data1</EBT_USER_DATA1>

<EBT_USER_DATA2>Data2</EBT_USER_DATA2>

<EBT_USER_DATA3>Data3</EBT_USER_DATA3>

<EBT_USER_DATA4>Data4</EBT_USER_DATA4>

<EBT_USER_DATA5>Data5</EBT_USER_DATA5>

<EBT_USER_DATA6>Data6</EBT_USER_DATA6>

<EBT_USER_DATA7>Data7</EBT_USER_DATA7>

Ingenico document - Reproduction or disclosure prohibited without written authorization

361
<EBT_USER_DATA8>Data8</EBT_USER_DATA8>

<EBT_USER_DATA9>Data9</EBT_USER_DATA9>

<EBT_USER_DATA10>Data10</EBT_USER_DATA10>

<EBT_USER_DATA11>Data11</EBT_USER_DATA11>

<EBT_USER_DATA12>Data12</EBT_USER_DATA12>

<EBT_USER_DATA13>Data13</EBT_USER_DATA13>

<EBT_USER_DATA14>Data14</EBT_USER_DATA14>

<EBT_USER_DATA15>Data15</EBT_USER_DATA15>

<EBT_USER_DATA16>Data16</EBT_USER_DATA16>

</PAYMENT>

</PARAMS>

</REQUEST>

</XML>

CSI tool screen when airline data and FRAUDFIELDS are submitted

Ingenico document - Reproduction or disclosure prohibited without written authorization

362
Appendix N Address Verification Service (AVS)
descrioptions
When using Address Verification Service (AVS) verification, here are the result codes that Ingenico ePayments can report.

AVS result codes that Ingenico ePayments can report

Code Description

A Address (Street) matches, Zip does not

B Street address match for international transactions—Postal code not verified due to incompatible formats

C Street address and postal code not verified for international transaction due to incompatible formats

D Street address and postal code match for international transaction, cardholder name is incorrect

E AVS error

F Address does match and five digit ZIP code does match (UK only)

G Address information is unavailable—International transaction—Non-AVS participant

H Billing address and postal code match, cardholder name is incorrect

For AMEX

I Address information not verified for international transaction

K Cardholder name matches

For AMEX

L Cardholder name and postal code match

For AMEX

M Cardholder name, street address, and postal code match for international transaction

N No Match on Address (Street) or Zip

O Cardholder name and address match

For AMEX

P Postal codes match for international transaction—Street address not verified due to incompatible formats

Q Billing address matches, cardholder is incorrect

For AMEX

R Retry, System unavailable or Timed out

S Service not supported by issuer

U Address information is unavailable

W 9 digit Zip matches, Address (Street) does not

X Exact AVS Match

Y Address (Street) and 5 digit Zip match

Z 5 digit Zip matches, Address (Street) does not

0 No service available

Ingenico document - Reproduction or disclosure prohibited without written authorization

363
Appendix O Card Verification Value (CVV) descriptions

When using Card Verification Value (CVV) verification, here are the result codes that Ingenico ePayments can report.

CVV result codes that Ingenico ePayments can report

Code Description

M CVV check performed and valid value

N CVV checked and no match

P CVV check not performed, not requested

S Cardholder claims no CVV code on card, issuer states CVV-code should be on card

U Issuer not certified for CVV2

Y Server provider did not respond

0 No service available

Ingenico document - Reproduction or disclosure prohibited without written authorization

364
Appendix P Lunch Check
What is Luhn algorithm
The Luhn or mod10 algorithm is a simple checksum formula used to validate credit card numbers. Ingenico ePayments merchants can apply this
check in advance to reduce the number of failed orders with the error message “Does not pass Luhn check”.

How is a credit card number generated

To verify that a credit card number is valid, you need to know how a credit card number is generated.

First 6 digits—The issuer identifier number

Middle 9 digits—The account number
Last digit—The check digit, which is generated to satisfy the Luhn check

Most credit cards have a 16-digit card number.

AMEX cards have a 15-digit number. For AMEX, the account number is 8 digits long

Sample Luhn check calculation

For a 16-digit credit card number, the Luhn check is

1. Set up a credit card number as your first row.

Example: 4408 0412 3456 7890

4 4 0 8 0 4 1 2 3 4 5 6 7 8 9 0
2. Multiply by two the value of each alternate digit from right to left beginning with the penultimate digit.
This leaves the check digit unchanged.
In this example, begin with the penultimate number, which is a 9.

4 4 0 8 0 4 1 2 3 4 5 6 7 8 9 0

4x2=8 4 0x2=0 8 0x2=0 4 1x2=2 2 3x2=6 4 5x2=10 6 7x2=14 8 9x2=18 0

3. Your results must have a value less than 10.

If you have a result greater than 10, subtract 9 from it.

4 4 0 8 0 4 1 2 3 4 5 6 7 8 9 0

4x2=8 4 0x2=0 8 0x2=0 4 1x2=2 2 3x2=6 4 5x2=10 6 7x2=14 8 9x2=18 0

8 4 0 8 0 4 2 2 6 4 10-9=1 6 14-9=5 8 18-9=9 0

4. All your digits now have a value less than 10 and are set up in the fourth row.

4 4 0 8 0 4 1 2 3 4 5 6 7 8 9 0

4x2=8 4 0x2=0 8 0x2=0 4 1x2=2 2 3x2=6 4 5x2=10 6 7x2=14 8 9x2=18 0

8 4 0 8 0 4 2 2 6 4 10-9=1 6 14-9=5 8 18-9=9 0

8 4 0 8 0 4 2 2 6 4 1 6 5 8 9 0
5. Add all the digits in the fourth row together.
The sum of all the digits for a valid card is always a multiple of 10. If this is not the case, the card number is invalid.
In this example, the sum of all the digits for the card number is 67, which is not a multiple of 10. The card number used in the example is
invalid.

Ingenico document - Reproduction or disclosure prohibited without written authorization

365
Appendix Q SEPA direct debit processing

Scenario
You can create a new SEPA direct debit recurring order with more than one collection. Accept the mandate from the consumer and later, invalidate
the mandate. You collect the paper mandates that are required during the process.

Process flow for a one-off transaction via MerchantLink

1. You use the API call: CREATE_PROFILE to create a SEPA direct debit mandate. In the CREATE_PROFILE return, you receive a
PROFILETOKEN. This token identifies the mandate to Ingenico ePayments. In the API call, you must provide.
All the consumer information for the mandate
The consumer International Bank Account Number (IBAN)
The consumer Bank Identifier Code (BIC).

2. You use the PROFILETOKEN in the API call: GET_PROFILE to retrieve the content of the mandate. In the return, you receive the
information that is required to prepare a mandate for signature.

3. Prepare the mandate and request that your consumer sign it. From the GET_PROFILE return, you must include the
Ingenico ePayments creditor information
MANDATEID—A unique mandate reference (UMR) generated by Ingenico ePayments

4. You retrieve the mandate from your consumer and use the API call: VALIDATE_PROFILE to communicate the mandate details to Ingenico
ePayments. This determines the status of the mandate. In the VALIDATE_PROFILE return, you receive the PROFILETOKEN and a
confirmation of the update. In the API call, you must include the
PROFILETOKEN
Consumer location
Mandate-signed date
Signature-present indicator

Every time you change the mandate, you must use the API calls: UPDATE_PROFILE to update the profile and then
VALIDATE_PROFILE to validate the mandate. If you do not validate the mandate before the collection date, the
collection is rescheduled for later. If you do not validate the mandate in a timely manner, the collection is canceled
and is not collected.
5. You use the API call: INSERT_ORDERWITHPAYMENT to create a SEPA direct debit collection. You provide the information related to the c
ollection with the validated PROFILETOKEN. In the INSERT_ ORDERWITHPAYMENT return, you receive the transaction status

You can use the API call: INSERT_ORDERWITHPAYMENT to create new collections before you
execute the API call: VALIDATE_PROFILE for the PROFILETOKEN. However, this puts the
transactions in a pending state and they are not sent to the bank until the mandate is
validated. You can verify the collection of booked transactions in your daily report.
6. In our daily report, you receive infromation about your successful and unsuccessful SEPA direct debit bank collections.

If you require a validate process before confirming the collection (inventory or stock
validation), you can use the API call: SET_PAYMENT to release the collections.

Ingenico document - Reproduction or disclosure prohibited without written authorization

366
Process flow for recurring transactions via MerchantLink
1. Subsequent recurring transactions via MerchantLink are processed beginning with steps 5 and 6 of the process flow for a one-off transaction
via MerchantLink.

2. Every time you change the mandate, you must use the API call: UPDATE_PROFILE to update the profile and communicate the change to
Ingenico ePayments. In the UPDATE_PROFILE return, you receive the PROFILETOKEN and a confirmation of the update. In the API call,
you must
refer to the old mandate using the appropriate PROFILETOKEN
include any consumer infromation that has been modified

If payment details change and you use the API call: UPDATE_PROFILE, the mandate is in an intermediate state until
Ingenico ePayments receives the API call: VALIDATE_PROFILE. In the meantime, Ingenico ePayments uses the
existing mandate information. This means that until the mandate is validated, all the transactions are sent to the bank
with the existing mandate information.
3. If a new paper signature is required, use the PROFILETOKEN in the API call: GET_PROFILE to retrieve the content of the mandate. See the
SEPA direct debit mandate amendment rules for information about when this is required. In the GET_PROFILE return, you receive the
information that is required to complete an empty mandate.

4. Prepare the mandate and request that your consumer sign it. From the GET_PROFILE return, you must include the
Ingenico ePayments creditor information
MANDATEID—A unique mandate reference (UMR) generated by Ingenico ePayments
5. You retrieve the mandate from your consumer and report the mandate details to Ingenico ePayments using the API call:
VALIDATE_PROFILE. This determines the status of the mandate. In the VALIDATE_PROFILE return, you receive the PROFILETOKEN and
a confirmation of the update. In the API call, you must include the

PROFILETOKEN
Consumer location
Mandate-signed date
Signature-present indicator

Ingenico document - Reproduction or disclosure prohibited without written authorization

367
6. When you receive a cancellation request from your consumer, you use the API call: INVALIDATE_PROFILE with the PROFILETOKEN
associated with the SEPA direct debit order to communicate the cancellation to Ingenico ePayments.

If you execute the API call: INVALIDATE_PROFILE before the initial INSERT_ORDERWITHPAYMENT API call, Ingenico
ePayments rejects any further INSERT_ORDERWITHPAYMENT API calls that refer to the canceled PROFILETOKEN. In
addition, if you execute the API call: INVALIDATE_PROFILE before the payment has been sent to the bank, Ingenico
ePayments cancels the associated payments.
7. In the return, you receive the status of the canceled mandate

Process flow for a one-off transaction via HostedMerchantLink

1. You use the API call INSERT_ORDERWITHPAYMENT making sure that TRANSACTIONTYPE=S. Ingenico ePayments validates the
request and provides a confirmation.

TRANSACTIONTYPE=S determine a recurring payment when using HostedMerchantLink.

2. You redirect your consumer to the Ingenico ePayments hosted page. The consumer enters his or her payment details and Ingenico
ePayments displays the mandate. The consumer can then print the mandate and be redirected to your return URL.
3. You use the API call: GET_ORDERSTATUS to retrieve the payment status
4. You retrieve the mandate from your consumer and use the API call: VALIDATE_PROFILE to communicate the mandate details to Ingenico
ePayments.
5. You must send the pre-notification-of-payment message to your consumer at least 14 calendar days before the payment due date (unless
you agree otherwise with your consumer). You can either do this using PRENOTIFICATION in the API calls: CREATE_PROFILE,
UPDATE_PROFILE, and INSERT_ORDERWITHPAYMENT, or you can make arrangements for this in your own system.
6. You use the API call: SET_PAYMENT to settle the transaction.
7. In your daily report, you receive information about your successful and unsuccessful SEPA direct debit bank collections.

Process flow for recurring transactions via HostedMerchantLink

1. You use the API call INSERT_ORDERWITHPAYMENT making sure that TRANSACTIONTYPE=F and ORDERTYPE=4. Ingenico
ePaymentsvalidates the request and provides a confirmation.

TRANSACTIONTYPE=F and ORDERTYPE=4 determine a recurring payment when using HostedMerchantLink.

2. You redirect your consumer to the Ingenico ePayments hosted page. The consumer enters his or her payment details and Ingenico
ePayments displays the mandate. The consumer can then print the mandate and be redirected to your return URL.
3. You can use API call: GET_ORDERSTATUS to retrieve the payment status.
4. You retrieve the mandate from your consumer and use the API call: VALIDATE_PROFILE to communicate the mandate details to Ingenico
ePayments.
5. You must send the pre-notification-of-payment message to your consumer at least 14 calendar days before the payment due date (unless
you agree otherwise with your consumer). You can either do this using PRENOTIFICATION in the API calls: CREATE_PROFILE,
UPDATE_PROFILE, and INSERT_ORDERWITHPAYMENT, or you can make arrangements for this in your own system.
6. You use the API call: SET_PAYMENT to settle the transaction.

Ingenico document - Reproduction or disclosure prohibited without written authorization

368
7. In your daily report, you receive information about your successful and unsuccessful SEPA direct debit bank collections.

Ingenico document - Reproduction or disclosure prohibited without written authorization

369
Appendix R SEPA directdebitmandate amendmentrules

Here you can see when you are required to use API calls, and which API calls to use, to comply with SEPA direct debit regulations.

Mandate field Must update mandate? (use UPDATE_PROFI Must collect paper mandate? (use VALIDATE_PROFI
LE) LE)

General mandate information

MANDATEID Yes No

CUSTOMERCONTRACTIDENTIFI Yes No
ER

TRANSACTIONTYPE Not applicable Not applicable

IBAN Yes Yes

BIC Yes Yes

Mandate name information

SURNAME Yes Yes

FIRSTNAME Yes No

PREFIXSURNAME Yes No

Mandate address information

CITY Yes No

STREET Yes No

HOUSENUMBER Yes No

ADDITIONALADDRESSINFO Yes No

ZIP Yes No

STATE Yes No

STATECODE Yes No

COUNTRYCODE Yes No

Mandate signature information

MANDATEPLACE Not applicable Not applicable

MANDATEDATE Not applicable Not applicable

MANDATESIGNED Not applicable Not applicable

Mandate pre-notification information

EMAIL Yes No

EMAILTYPEINDICATOR Yes Not applicable

PRENOTIFICATION Yes Not applicable

Ingenico document - Reproduction or disclosure prohibited without written authorization

370
Appendix S IP addresses
These IP addresses must be whitelisted. Do not remove these IP addresses unless you are asked to do so by Ingenico ePayments.

If you have questions about IP addresses, contact merchant services at Ingenico ePayments.

Public IP addresses for the Amsterdam data center

The Amsterdam data center IP addresses are used for all of these environments:

Staging
Production
Disaster Recovery Center

Be sure to whitelist all of these IP addresses.

Payment platform connectivity— API calls from you to Payment status communicator (PSC) connectivity— PSC messaging
Ingenico ePayments from Ingenico ePayments

Merchants (HTTPS) Merchants (HTTPS)

IP network: 46.16.248.0/25

ps.gcsip.com: 46.16.248.17

eu.gcsip.com: 46.16.248.18

ca.gcsip.com: 46.16.248.19 IP range: 46.16.251.192/26

wpc.gcsip.com:46.16.248.20

bl.gcsip.com: 46.16.248.28

ams.gcsip.com:46.16.248.24

ams-ca.gcsip.com:46.16.248.26

Public IP addresses for the Miami data center

Be sure to whitelist all of these IP addresses.

Payment status communicator (PSC) connectivity— PSC

messaging from Ingenico ePayments

Merchants (HTTPS)
Payment platform connectivity— API calls from you to Ingenico
ePayments Merchants (HTTPS)

IP range: 46.16.252.0/27

ps.gcsip.com: 46.16.252.17

na.gcsip.com: 46.16.252.18

ca.gcsip.com: 46.16.252.19

wpc.gcsip.com:46.16.252.20

bl.gcsip.com: 46.16.252.21 IP network: 46.16.252.32/29

mia.gcsip.com: 46.16.252.22

mia-ca.gcsip.com:46.16.252.23

Ingenico document - Reproduction or disclosure prohibited without written authorization

371

Offer Letter
100% (1)
Offer Letter
2 pages
Deposit Products
No ratings yet
Deposit Products
14 pages
Ethical Hacking and Penetration Testing Lecture 1
100% (1)
Ethical Hacking and Penetration Testing Lecture 1
19 pages
Research Methods Notes
No ratings yet
Research Methods Notes
14 pages
EGR Handouts
100% (1)
EGR Handouts
13 pages
State Bank Collect PPT For Educational Institutions
100% (1)
State Bank Collect PPT For Educational Institutions
17 pages
AML Fraud in 2025 What To Know
0% (1)
AML Fraud in 2025 What To Know
12 pages
The United State Social Security Administration Update
No ratings yet
The United State Social Security Administration Update
40 pages
Pdfdownload 03
No ratings yet
Pdfdownload 03
248 pages
Don't Miss Out On Your Chance To Recover Your Stolen Crypto Funds - Contact Digital Hack Recovery Today
No ratings yet
Don't Miss Out On Your Chance To Recover Your Stolen Crypto Funds - Contact Digital Hack Recovery Today
28 pages
Boa 2025
No ratings yet
Boa 2025
6 pages
How To Get Started With Hyperfund
No ratings yet
How To Get Started With Hyperfund
20 pages
List of Banks, EMI's, Payment Processors and BTC To FIAT Institutions. - Page 3 - OffshoreCorpTalk
No ratings yet
List of Banks, EMI's, Payment Processors and BTC To FIAT Institutions. - Page 3 - OffshoreCorpTalk
10 pages
Bkash Parameter - Requirement-9-10-2019
No ratings yet
Bkash Parameter - Requirement-9-10-2019
4 pages
English A SBA
100% (1)
English A SBA
17 pages
Money Laundering Report - Final
0% (1)
Money Laundering Report - Final
49 pages
MCQ BS
100% (5)
MCQ BS
4 pages
Dcu Branch Cash Out@baddestupdate
No ratings yet
Dcu Branch Cash Out@baddestupdate
7 pages
The Fbi Recommendations For It Admins To Prevent Bec Attacks On Office 365 Users
No ratings yet
The Fbi Recommendations For It Admins To Prevent Bec Attacks On Office 365 Users
8 pages
Cash Bank
No ratings yet
Cash Bank
45 pages
Detection & Analysis of Dridex With Cybershield and For It
100% (1)
Detection & Analysis of Dridex With Cybershield and For It
9 pages
Resentation ON Online Payment Gateway System
No ratings yet
Resentation ON Online Payment Gateway System
25 pages
Hanmi Bank Loan - Lucifer
No ratings yet
Hanmi Bank Loan - Lucifer
22 pages
Collect API
No ratings yet
Collect API
20 pages
How To Install macOS High Sierra On VirtualBox PC
No ratings yet
How To Install macOS High Sierra On VirtualBox PC
16 pages
Digital Banking Guide PDF
No ratings yet
Digital Banking Guide PDF
14 pages
PERFIN M2 CH5 - Managing Credit - Credit Card and Consumer Loans
No ratings yet
PERFIN M2 CH5 - Managing Credit - Credit Card and Consumer Loans
50 pages
Managing Money With Mint
No ratings yet
Managing Money With Mint
15 pages
First National Credit Union
No ratings yet
First National Credit Union
1 page
Digital Empowerment Presentation 2
No ratings yet
Digital Empowerment Presentation 2
13 pages
TransferWise Guide
No ratings yet
TransferWise Guide
9 pages
Expat Manual ABN AMRO 3 - tcm18-145135
No ratings yet
Expat Manual ABN AMRO 3 - tcm18-145135
11 pages
Skype Login Test Case
No ratings yet
Skype Login Test Case
5 pages
PayHere+eWallet Form PDF
100% (1)
PayHere+eWallet Form PDF
3 pages
One Tso Setup
No ratings yet
One Tso Setup
5 pages
Mobile Banking - User Manual
No ratings yet
Mobile Banking - User Manual
23 pages
TR - IoT ICT Standards For Smart Cities
No ratings yet
TR - IoT ICT Standards For Smart Cities
146 pages
Fake AP
No ratings yet
Fake AP
6 pages
MBanking FAQs-English
No ratings yet
MBanking FAQs-English
21 pages
Introduction To Javacc: Cheng-Chia Chen
No ratings yet
Introduction To Javacc: Cheng-Chia Chen
87 pages
NFC Blue Ocean
No ratings yet
NFC Blue Ocean
27 pages
H&RBLOCK
100% (1)
H&RBLOCK
13 pages
JP - Bank EBS Requiuirement Sheet Config
No ratings yet
JP - Bank EBS Requiuirement Sheet Config
37 pages
UPI For Businesses Brochure
No ratings yet
UPI For Businesses Brochure
8 pages
Owner #1 Owner #1 Photo Id: Schedule of Ownership Form
No ratings yet
Owner #1 Owner #1 Photo Id: Schedule of Ownership Form
5 pages
BB&T and SunTrust
No ratings yet
BB&T and SunTrust
38 pages
Interview Questions and Answers
No ratings yet
Interview Questions and Answers
3 pages
Final SRS
No ratings yet
Final SRS
25 pages
Submitted To Suhal Ahmed: Module Name: Shipping & Banking Module Code: AMM-4323
No ratings yet
Submitted To Suhal Ahmed: Module Name: Shipping & Banking Module Code: AMM-4323
9 pages
B.A. (Prog.) Political Science 2nd Semester-2023
No ratings yet
B.A. (Prog.) Political Science 2nd Semester-2023
8 pages
Online Banking Software
No ratings yet
Online Banking Software
16 pages
R12 Bank
No ratings yet
R12 Bank
13 pages
Project On Bank Management: Rajan Agrawal Bhabani Nayak Abhijeet Oddu
No ratings yet
Project On Bank Management: Rajan Agrawal Bhabani Nayak Abhijeet Oddu
14 pages
State Bank Collect
No ratings yet
State Bank Collect
3 pages
Dice Recruiters-HowToGetBusiness Part2
No ratings yet
Dice Recruiters-HowToGetBusiness Part2
5 pages
Module 2 Ver 3.1
100% (1)
Module 2 Ver 3.1
81 pages
A Proposal For A Restaurant
No ratings yet
A Proposal For A Restaurant
2 pages
Mad City Money
No ratings yet
Mad City Money
7 pages
How To Get Published
No ratings yet
How To Get Published
5 pages
Britannica - Islamic Thought
No ratings yet
Britannica - Islamic Thought
54 pages
Operations Management Cashier's Check Process
No ratings yet
Operations Management Cashier's Check Process
1 page
How To Get Sponsors
No ratings yet
How To Get Sponsors
1 page
Know About Swiss Bank Account
No ratings yet
Know About Swiss Bank Account
3 pages
Scope-Airlines Reservation System
No ratings yet
Scope-Airlines Reservation System
4 pages
Digital Citizenship Lesson 3
No ratings yet
Digital Citizenship Lesson 3
7 pages
PayPal As The Most Loved Payment System Among Merchants and Buyers in Online Transactions
No ratings yet
PayPal As The Most Loved Payment System Among Merchants and Buyers in Online Transactions
5 pages
SIGNED-SIGNED - Cargo Ship Safety Radio Certificate (Harmonized) - 2141709 - 05102311550855
No ratings yet
SIGNED-SIGNED - Cargo Ship Safety Radio Certificate (Harmonized) - 2141709 - 05102311550855
3 pages
Earthquake Recording Instrumentation Guideline
No ratings yet
Earthquake Recording Instrumentation Guideline
4 pages
Gothic Architecture
100% (1)
Gothic Architecture
28 pages
Fifth Sunday of Easter - Eucharist
No ratings yet
Fifth Sunday of Easter - Eucharist
12 pages
How To Downgrade Apps On AppStore With Itunes and Charles Proxy
100% (1)
How To Downgrade Apps On AppStore With Itunes and Charles Proxy
1 page
APP Guidance
No ratings yet
APP Guidance
17 pages
Snyder 2004 PDF
No ratings yet
Snyder 2004 PDF
12 pages
Fédération Aéronautique Internationale-Official History
No ratings yet
Fédération Aéronautique Internationale-Official History
2 pages
Analysis of Donations Received by Major Political Parties of Delhi FY 2013 14 and 2014 15
100% (1)
Analysis of Donations Received by Major Political Parties of Delhi FY 2013 14 and 2014 15
17 pages
机经 231121 阅读P2 The Sound Revolution in American Film
No ratings yet
机经 231121 阅读P2 The Sound Revolution in American Film
3 pages
Keps 2 Ps
No ratings yet
Keps 2 Ps
14 pages
Aman Vibha Project.4
No ratings yet
Aman Vibha Project.4
7 pages
BM - 2025 Summer TT 01-06-25
No ratings yet
BM - 2025 Summer TT 01-06-25
9 pages
Regular
No ratings yet
Regular
11 pages
GC 2024 05 28
No ratings yet
GC 2024 05 28
13 pages
Hybrid Democracy in Pakistan: A Case Study of The PDM Government
No ratings yet
Hybrid Democracy in Pakistan: A Case Study of The PDM Government
11 pages
CV (Technical) Experienced 2
No ratings yet
CV (Technical) Experienced 2
3 pages
CBI Case Status Dated 14.10.2024
No ratings yet
CBI Case Status Dated 14.10.2024
7 pages
Campus Notes: Senior Associate Editor
No ratings yet
Campus Notes: Senior Associate Editor
3 pages
Kvs Application Form
No ratings yet
Kvs Application Form
2 pages
MYTICKET - PDF 0018a00001w47MKAAY2024-01-18 15-08-49
No ratings yet
MYTICKET - PDF 0018a00001w47MKAAY2024-01-18 15-08-49
1 page
Leaflet For The Social Problem Novels of Frances Trollope
No ratings yet
Leaflet For The Social Problem Novels of Frances Trollope
2 pages
Wealth Without Wallet
From Everand
Wealth Without Wallet
Bienvenu Mambote
No ratings yet
Fraud Detection The Ultimate Step-By-Step Guide
From Everand
Fraud Detection The Ultimate Step-By-Step Guide
Gerardus Blokdyk
No ratings yet