Gateway Integration Guide Connect
Gateway Integration Guide Connect
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Contents
1.0 Introduction 4
2.0 Payment Process Options 4
2.1 Checkout Option ‘Classic’ 4
2.2 Checkout Option ‘Combinedpage’ 5
3.0 Getting Started 5
3.1 Checklist 5
3.2 ASP Example 5
3.3 PHP Example 6
3.4 Amounts for Test Transactions 7
4.0 Mandatory Fields 7
5.0 Optional Form Fields 8
6.0 Using Your Own Forms to Capture The Data 12
6.1 Payonly Mode 13
6.2 Payplus Mode 14
6.3 Fullpay Mode 14
6.4 Validity Checks 15
7.0 Additional Custom Fields 15
8.0 3D Secure 16
8.1 3DSecure Split Authentication 18
8.2 Dynamic 3D Secure Based on The Card Issuer’s Country 19
9.0 MCC 6012 Mandate in UK 20
10.0 Data Vault 20
11.0 Solvency Information from Bürgel 21
12.0 Recurring Payments 22
13.0 Global Choice™ and Dynamic Pricing 22
14.0 Purchasing Cards 24
15.0 Transaction Response 25
15.1 Response to your Success/Failure URLs 25
15.2 Server-to-Server Notification 29
Appendix I – How to Generate a Hash 30
Appendix II – ipg-util.asp 31
Appendix III – ipg-util.php 32
Appendix IV – Currency Code List 33
Appendix V – Payment Method List 35
Appendix VI – PayPal 38
Appendix VIII – MasterPass 39
Appendix IX – Fraud Detect 41
Appendix X – Local Payments™ 42
Appendix XI – UnionPay SecurePlus 47
Appendix XII – China Domestic 48
Appendix XIV – Korea Domestic 50
Appendix XV - Debit Disbursement 51
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Getting Support
There are different manuals available for the digital solutions provided by Fiserv. This Integration Guide will
be the most helpful for integrating hosted payment forms or a Direct Post.
For information about settings, customization, reports and how to process transactions manually (by keying
in the information) please refer to the User Guide Virtual Terminal.
If you have read the documentation and cannot find the answer to your question, please contact your local
support team.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
1.0 Introduction
The Connect solution provides a quick and easy way to add payment capabilities to your website.
Connect manages the customer redirections that are required in the checkout process of many payment
methods or authentication mechanisms and gives you the option to use secure hosted payment pages
which can reduce the burden of compliance with the Data Security Standard of the Payment Card Industry
(PCI DSS).
This document describes how to integrate your website using Connect and provides step by step
instructions on how to quickly start accepting payments from your webshop.
When making decisions on your way of integration, please consider that we do not recommend to
use the hosted payment forms inside an iFrame since some Internet browsers do not allow cookies
to be sent to the third-party hosts, moreover some features (for example: 3D Secure authentications)
and some Alternative Payment methods that involve redirections to the third party services
(for example, iDEAL or PayPal) do not allow displaying their screens within an iFrame.
Depending on your business processes, it can also make sense to additionally integrate our Web Service
API solution (see Web Service API Integration Guide).
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
The hosted pages can be customized with your own logo, colors, and font types in order to make them fit to
the look and feel of your webshop. Please refer to the User Guide Virtual Terminal to learn about how to
make such customizations.
3.1 Checklist
In order to integrate with the payment gateway, you must have the following items:
Store Name
Shared Secret
<html>
<head><title>IPG Connect Sample for ASP</title></head>
<body>
<p><h1>Order Form</h1></p>
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
<input type="hidden" name="txntype" value="sale">
<input type="hidden" name="timezone" value="Europe/Berlin"/>
<input type="hidden" name="txndatetime" value="<% getDateTime() %>"/>
<input type=”hidden” name=”hash_algorithm” value=”HMACSHA256”/>
<input type="hidden" name="hashExtended" value="<% call
createExtendedHash( "13.00","978" ) %>"/>
<input type="hidden" name="storename" value="10123456789" />
<input type="hidden" name="mode" value="payonly"/>
<input type="hidden" name="paymentMethod" value="M"/>
<input type="text" name="chargetotal" value="13.00" />
<input type="hidden" name="currency" value="978"/>
<input type="submit" value="Submit">
</form>
</body>
</html>
The code presented in Appendix II represents the included file ipg-util.asp. It includes code for generating a
hash as is required by Fiserv. The provision of a hash in the example ensures that this merchant is the only
merchant that can send in transactions for this store.
Note, the POST URL used is for integration testing only. When you are ready to go into production, please
contact Fiserv and you will be provided with the live production URL.
Note, the included file, ipg-util.asp uses a server side JavaScript file to build the hash. This file can be
provided on request. To prevent fraudulent transactions, it is recommended that the hash is calculated within
your server and JavaScript is not used like shown in the samples mentioned.
<html>
<head><title>IPG Connect Sample for PHP</title></head>
<body>
<p><h1>Order Form</h1>
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Note that the POST URL used in this example is for integration testing only. When you are ready to go into
production, please contact Fiserv and you will be provided with the live production URL.
The code presented in Appendix III represents the included file ipg-util.php. It includes code for generating a
hash as is required by Fiserv. The provision of a hash in the example ensures that this merchant is the only
merchant that can send in transactions for this store.
PayerAuth**
transaction
PostAuth*
PreAuth*
Void
Field Name
Description, Possible Values and Sale
Format
txndatetime YYYY:MM:DD-hh:mm:ss X X X X X
(exact time of the transaction)
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
order of the parameter names.
When you are using Direct Post, there is also
an option where you do not need to know the
card details (PAN, CVV and Expiry Date) for
the hash calculation. This will be managed
with a specific setting performed on your
store. Please contact your local support team
if you want to enable this feature.
An example of how to generate a hash is
given in Appendix I.
* The transaction types ‘preauth’ and ‘postauth’ only apply to the payment methods credit card, PayPal.
** The transaction type ‘payer_auth’ is only required if you want to split the 3D Secure authentication
process from the payment transaction (authorization) process. See more information in the 3D Secure
section of this guide.
Please see a list of currencies and their ISO codes in Appendix IV.
checkoutoption This field allows you to set the checkout option to:
‘classic’ for a payment process that is split into multiple pages,
‘combinedpage’ for a payment process where the payment method choice
and the typical next step (for example, entry of card details or selection of
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
bank) in consolidated in a single page.
customerid This field allows you to transmit any value, for example, your ID for the
customer.
Please note that for:
Direct Debit transactions, the Customer ID can be submitted to the bank,
depending on the length of the Order ID. The maximum amount of
characters that can be submitted to the bank is 78. Please note that this is
not applicable when processing Direct Debit through the Fiserv Local
Payments offering.
iDEAL transactions, the Customer ID can be submitted in your request filled
in with any relevant data which can be populated in a field in the iDEAL
TransactionRequest to be displayed on your consumers’ bank account
statements. Please note that this is not applicable when processing iDEAL
through the Fiserv Local Payments offering.
dccInquiryId Inquiry ID for a Dynamic Pricing request. Used to send the Inquiry ID you have
obtained through a Web Service API call
(RequestMerchantRateForDynamicPricing). This value will be used to retrieve
the currency conversion information (exchange rate, converted amount) for this
transaction.
dccSkipOffer If the cardholder declines the currency conversion offer within your environment,
the request parameter ‘dccSkipOffer’ can be set to ‘true’ so that the hosted
consumer dialogue will automatically be skipped.
dynamicMerchantName The name of the merchant to be displayed on the cardholder’s statement. The
length of this field should not exceed 25 characters. If you want to use this field,
please contact your local support team to verify if this feature is supported in
your country.
idealIssuerID This parameter can be used to submit the iDEAL issuing bank in case you let
Not Available in Australia your customers select the issuer within your shop environment. If you do not
pass this value for an iDEAL transaction, a hosted selection form will be
displayed to your customer. Please note that this is not applicable when
processing iDEAL through the Fiserv Local Payments offering.
ING INGBNL2A
Knab KNABNL2H
Rabobank RABONL2U
RegioBank RBRBNL21
Bunq BUNQNL2A
Handelsbanken HANDNL2A
Moneyou MOYONL21
invoicenumber This field allows you to transmit any value, for example, an invoice number or
class of goods. Please note that the maximum length for this parameter is 48
characters.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
item1 up to item999 Line items are regular Connect integration key-value parameters
(URL-encoded), where:
the name is a combination of the keyword item and a number, where the
number indicates the list position for example: item1
the value is represented by a semicolon-separated list of values, where the
position indicates the meaning of the list item property for example,
<1>;<2>;<3>;<4>;<5>;<6>;<7>
The ‘item1’ to ‘item999’ parameters allow you to send basket information in the
following format:
id;description;quantity;item_total_price;sub_total;vat_tax;shipping
‘shipping’ always has to be set to ‘0’ for single line item. If you want to include a
shipping fee for an order, please use the predefined id IPG_SHIPPING.
For other fees that you may want to add to the total order, you can use the
predefined id IPG_HANDLING.
When you want to apply a discount, you should include an item with a negative
amount and change accordingly the total amount of the order. Do not forget to
regard the ‘quantity’ when calculating the values for example: subtotal and VAT
since they are fixed by items.
Examples:
A;Product A;1;5;3;2;0
B;Product B;5;10;7;3;0
C;Product C;2;12;10;2;0
D;Product D;1;-1.0;-0.9;-0.1;0
IPG_SHIPPING;Shipping costs;1;6;5;1;0
IPG_HANDLING;Transaction fee;1;6.0;6.0;0;0
language This parameter can be used to override the default payment page language
configured for your merchant store.
The following values are currently possible:
Language Value
Czech cs_CZ
Danish da_DK
Dutch nl_NL
Finnish fi_FI
French fr_FR
German de_DE
Greek el_GR
Hungarian hu_HU
Italian it_IT
Japanese ja_JP
Polish pl_PL
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Portuguese (Brazil) pt_BR
Slovak sk_SK
Spanish es_ES
Swedish sv_SE
mandateDate This field allows you to reference to the date of the original mandate when
Not Available in Australia performing recurring Direct Debit transactions. The date needs to be submitted
in format YYYYMMDD.
Please note that this is a mandatory field for recurring Direct Debit
transactions.
mandateReference This field allows you to transmit a Mandate Reference for Direct Debit payments.
Not Available in Australia Please note the regulatory requisite to keep the Mandate Reference
unambiguous.
mandateType This field allows you to process Direct Debit transactions that are based on
Not Available in Australia mandates for recurring collections. The mandate type can be set to ‘single’ for
single (one-off) debit collections, to ‘firstCollection’ when submitting the initial
transaction related to a mandate for recurring Direct Debit collections, to
‘recurringCollection’ for subsequent recurring transactions or to ‘finalCollection’
for the last direct debit in a series of recurring direct debits. Transactions where
this parameter is not submitted by the merchant will be flagged as a single debit
collection.
Please note that it is mandatory to submit a mandateReference in case of
recurring collections.
mandateUrl When your store is enabled for SEPA Direct Debit as part of the Local Payments
Not Available in Australia offering, this field allows you to transmit a valid URL of SEPA Direct Debit
mandate to enable the Risk and Compliance department to access the details.
Please note that it is mandatory to submit a mandateReference and a
mandateDate together with a mandateUrl in case you manage SEPA Direct
Debit mandates on your side in the combination with the Local Payments
offering.
merchantTransactionId Allows you to assign a unique ID for the transaction. This ID can be used to
reference to this transactions in a PostAuth or Void request
(referencedMerchantTransactionId).
mobileMode If your customer uses a mobile device for shopping at your online store you can
submit this parameter with the value ‘true’, when using the ‘classic’ checkout
option. This will lead your customer to a payment page flow that has been
specifically designed for mobile devices.
numberOfInstallments This parameter allows you to set the number of instalments for a Sale
transaction if your customer pays the amount in several parts.
installmentsInterest This parameter allows you to choose, if instalment interest should be applied or
not, the values “true” or “false” are currently possible.
installmentDelayMonths This parameter allows you to delay the first instalment payment for several
months, values 2-99 are currently possible.
oid This field allows you to assign a unique ID for your order. If you choose not to
assign an order ID, the Fiserv system will automatically generate one for you.
Please note that for Direct Debit transactions, a maximum of 78 characters can
be submitted to the bank.
paymentMethod If you let the customer select the payment method (For example, Mastercard,
Visa, Direct Debit) in your shop environment or want to define the payment type
yourself, transmit the parameter ‘paymentMethod’ along with your Sale or
PreAuth transaction.
If you do not submit this parameter, the payment gateway will display a drop-
down menu to the customer to choose from the payment methods available for
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
your shop.
For valid payment method values please refer to Appendix V.
ponumber This field allows you to submit a Purchase Order Number with up to 50
characters.
refer This field describes who referred the customer to your store.
referencedSchemeTransactionId Credentials on file (COF) specific parameter. This field allows you to include in
your request ‘schemeTransactionId’ that has been returned in the response of
the initial transaction in order to provide a reference to the original transaction,
which stored the credentials for the first time.
responseFailURL The URL where you wish to direct customers after a declined or unsuccessful
transaction (your Sorry URL) – only needed if not setup in Virtual
Terminal/Customisation.
responseSuccessURL The URL where you wish to direct customers after a successful transaction (your
Thank You URL) – only needed if not setup in Virtual Terminal/Customisation.
reviewOrder MasterPass-specific parameter for scenarios where the final amount needs to be
Not Available in Australia confirmed by the customer after returning from the Wallet. Set the value for this
parameter to ‘true’ in order to indicate that the final transaction amount needs to
be reviewed by the cardholder.
reviewURL MasterPass-specific parameter for scenarios where the final amount needs to be
Not Available in Australia confirmed by the customer after returning from the MasterPass environment.
Use this parameter to indicate where the customer shall be redirected to in order
to review and complete the transaction after having clicked on “Finish shopping”
within the Wallet.
shipping This parameter can be used to submit the shipping fee, in the same format as
‘chargetotal’. If you submit ‘shipping’, the parameters ‘subtotal’ and ‘vattax’ have
to be submitted as well. Note that the ‘chargetotal’ has to be equal to ‘subtotal’
plus ‘shipping’ plus ‘vattax’.
trxOrigin This parameter allows you to use the secure and hosted payment form
capabilities within your own application. Possible values are:
‘MAIL’ (for transactions where the payment details are captured manually
and provided in written form the Card Code entry is not allowed)
‘PHONE’ (for transactions where you have received the order over the
phone and enter the payment details yourself the Card Code entry is
required)
‘ECI‘ (for standard usage in an eCommerce environment where your
customer enters the payment details).
unscheduledCredentialOnFileType Credentials on file (COF) specific parameter. This field allows you to flag
transactions as unscheduled credential on file type. Currently the valid values
are: FIRST, CARDHOLDER_INITIATED or MERCHANT_INITIATED to advise
the scenario if the credential is stored on your side.
vattax This field allows you to submit an amount for Value Added Tax or other taxes,
for example, GST in Australia. Please ensure the sub total amount plus shipping
plus tax equals the charge total.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Using Direct Post allows you to have full control over the look and feel of the form where your customers
enter their card details for payment while simultaneously avoiding the need to have sensitive card data
within your systems.
In addition, you should check if JavaScript is activated in your customer’s browser and if necessary, inform
your customer that JavaScript needs to be activated for the payment process.
Following Fields in grey are not available in Australia
UnionPay SecurePlus
Description, Possible Debit/Electron/Delta)
Field Name
Direct Debit
Credit Card
Bancontact
Values and Format
Maestro
(+ Visa
SEPA
For the Local Payments method specific (mandatory/optional) fields please refer to Appendix X.
For the China Domestic method specific (mandatory/optional) fields please refer to Appendix XII.
For the Korea Domestic method specific (mandatory/optional) fields please refer to Appendix XIV.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
6.2 Payplus Mode
Using payplus mode, it is possible to additionally transfer billing information to the payment gateway. The
following table describes the format of these additional fields:
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
spaces
full_bypass=true
In that case you get the result of the validity check back in the transaction response and can display your
own error page based on this.
Please note, if the transaction is eligible for DCC (your store is configured for DCC and the customer is
paying by credit card capable of DCC), your customer will be presented the DCC page despite having
full_bypass set to true. This is due to regulatory reasons. You can avoid displaying of DCC choice pages by
doing the DCC Inquiry yourself through our Web Service API (RequestMerchantRateForDynamicPricing).
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Up to ten custom fields can be submitted in a way that they will be stored within the gateway so that they
appear in the Virtual Terminal’s Order Detail View as well as in the response to Inquiry Actions that you send
through our Web Service API .
Example:<input type="hidden"
name="customParam_color" value="green"/>
8.0 3D Secure
The Connect solution includes the ability to authenticate transactions using Verified by Visa, Mastercard
SecureCode, American Express SafeKey, JCB J/Secure and Diners ProtectBuy to provide an additional
security layer for online card transactions.
If your store is enabled for 3D Secure, all Sale or preAuth transactions that you initiate by posting an HTML
form will by default go through the 3D Secure process without the need for you to do anything, That is
cardholders with an enrolled card will see a page from the card issuer to enter the password unless the card
issuer decides not to check it.
The generic fields to be considered:
threeDSRequestorChallengeIndicator Optional parameter for EMV 3D Secure (2.0) to be set to: 01,02,03,04 in
order to indicate the preferred type of authentication:
threeDSTransType The parameter for EMV 3D Secure (2.0) represents the type of purchased
item, mandatory for Visa and Brazilian market, otherwise optional. If no
specific value present in the transaction request, default value is used.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
scaExemptionIndicator1 Optional parameter to request an exemption from Strong Customer
Authentication (SCA) without the need to perform 3-D Secure
authentication. Currently available values:
Note this parameter is relevant only for the European merchants impacted
by the PSD2 requirements.
skipTRA This optional parameter allows you to use 3D Secure even if the transaction
has been evaluated as low risk and would be eligible for an exemption.
Currently available values:
true
false
When your store has been set up with Transaction Risk Analysis (TRA)
service, but you do want to force 3D Secure authentication for a certain
transaction, set ‘skipTRA’ to ‘true’.
Note this parameter is relevant only for the European merchants impacted
by the PSD2 requirements.
In principle, it may occur that 3D Secure authentications cannot be processed successfully for technical
reasons. If one of the systems involved in the authentication process is temporarily not responding, the
payment transaction will be processed as a “regular” eCommerce transaction (ECI 7). A liability shift to the
card issuer for possible chargebacks is not warranted in this case. If you prefer that such transactions
shall not be processed at all, our technical support team can block them for your Store on request.
Credit card transactions with 3D Secure hold in a pending status while cardholders search for their
password or need to activate their card for 3D Secure during their shopping experience. During this time
when the final transaction result of the transaction is not yet determined, the payment gateway sets the
Approval Code to „?:waiting 3dsecure“. If the session expires before the cardholder returns from the 3D
Secure dialogue with his bank, the transaction will be shown as “N:-5103:Cardholder did not return from
ACS”.
Please note that the technical process of 3D Secure transactions differs in some points compared to a
normal transaction flow. If you already have an existing shop integration and plan to activate 3D Secure
subsequently, we recommend performing some test transactions on our test environment.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
8.1 3DSecure Split Authentication
If your business or technical processes require the cardholder authentication to be separated from the
payment transaction (authorization), you can use the transaction type ‘payer_auth’. This transaction type
only performs the authentication (and stores the authentication results).
<html>
<head><title>IPG Connect Sample for ASP</title></head>
<body>
<p><h1>Order Form</h1></p>
{txndate_processed=17/04/20 17:17:32,
ccbin=542606,
timezone=Europe/Berlin,
oid=C-2101f68a-45e9-4f3c-a6da-1337d5574717,
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
cccountry=N/A,
expmonth=12,
hash_algorithm=HMACSHA256
currency=978,
chargetotal=13.00,
approval_code=Y:ECI2/5:Authenticated,
hiddenSharedsecret=sharedsecret,
hiddenTxndatetime=2020:04:17-17:32:41,
expyear=2024,
response_hash=LarWYFSNgEToq13HlvyslX6hywi2T/nMn8jMY+1kxkI=,
response_code_3dsecure=1,
hiddenStorename=10123456789,
transactionNotificationURL=https://test.ipg-
online.com/webshop/transactionNotification,
tdate=1491824253,
ignore_refreshTime=on,
ccbrand=MASTERCARD,
txntype=payer_auth,
paymentMethod=M,
txndatetime=2020:04:17-17:32:41,
cardnumber=(MASTERCARD) ... 4979,
ipgTransactionId=84120276797,
status=APPROVED}
In a second step, you need to submit a payment transaction (‘sale’ or ‘preauth’) through the IPG Web
Service API and reference it to the prior authentication. To review an example of a ‘sale’ transaction that
refers to a previous ‘payer_auth’ transaction, please review the 3DSecure Split Authentication section, in the
Web Service API integration guide.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
9.0 MCC 6012 Mandate in UK
Not Available in Australia
For U.K.-based Financial Institutions with Merchant Category Code 6012, Visa and Mastercard have
mandated additional information of the primary recipient of the loan to be included in the authorization
message.
If you are a UK 6012 merchant use the following parameters for your transaction request:
mcc6012AccountFirst6 First six digits of recipient PAN (where the primary recipient account is
a card)
mcc6012AccountLast4 Last four digits of recipient PAN (where the primary recipient account is a card)
mcc6012AccountNumber Recipient account number (where the primary recipient account is not a card)
mcc6012Surname Surname
If you are a UK 6051 and 7299 merchant, you can reuse the MCC 6012 parameters to send the optional
data to be included in the authorization message. However, please note that you have to either populate all
the parameters or none otherwise the transaction will be declined.
If you want to assign multiple IDs to the same payment information record, you can submit the
parameter ‘hosteddataid’ several times with different values in the same transaction.
If you prefer not to assign a token yourself but want to let the gateway do this for you, send the
parameter ‘assignToken’ and set it to ‘true’. The gateway will then assign a token and include it in the
transaction response as ‘hosteddataid’.
If you have use cases where you need some of the tokens for single transactions only (for example, for
consumers that check out as a “guest”, use the additional parameter ‘tokenType’ with the values
‘ONETIME’ (card details will only be stored for a short period of time) or ‘MULTIPAY’ (card details will be
stored for use in future transactions).
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Initiate payment transactions using stored data
If you stored cardholder information using the Data Vault option, you can perform transactions using the
‘hosteddataid’ without the need to pass the credit card or bank account data again.
Please note that it is not allowed to store the card code (in most cases on the back of the card) so that
for credit card transactions, the cardholder still needs to enter this value. If you use Fiserv’s hosted
payment forms, the cardholder will see the last four digits of the stored credit card number, the expiry
date and a field to enter the card code.
When using multiple Store IDs, it is possible to access stored card data records of a different Store ID
then the one that has been used when storing the record. In that way you can for example, use a shared
data pool for different distributive channels. To use this feature, submit the Store ID that has been used
when storing the record as the additional parameter ‘hosteddatastoreid’.
Avoid duplicate cardholder data for multiple records
To avoid customers using the same cardholder data for multiple user accounts, the additional
parameter ‘declineHostedDataDuplicates’ can be sent along with the request. The valid values for
this parameter are ‘true’/’false’. If the value for this parameter is set to ‘true’ and the cardholder data
in the request is already found to be associated with another ‘hosteddataid’, the transaction will be
declined.
See further possibilities with the Data Vault product in the Integration Guide for the Web Service API.
bfirstname, blastname, bname Customer name Yes, bfirstname and blastname or bname
baddr1 Customer address Yes, format must be street and house number
bcountry Customer country Yes, in the ISO alpha code format, for example, DE
If any of the mandatory address information is missing, the transaction request will be declined.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
12.0 Recurring Payments
For credit card and PayPal transactions, it is possible to install recurring payments using Connect. To use
this feature, the following additional parameters will have to be submitted in the request:
Note that the start date of the recurring payments will be the current date and will be automatically
calculated by the system.
The recurring payments installed using Connect can be modified or cancelled using the Virtual Terminal or
Web Service API.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Please note that for compliance reasons Fiserv’s Global Choice can only be offered on transactions that
take place in full at that time (for example, Sale, Refund) and not on any delayed settlement (for example,
pre/post auth, recurring) due to the fluctuation of the rate of exchange.
Another option for your foreign customers is to display all pricing within your online store in their home
currency using our Dynamic Pricing solution. This solution removes the need for your company to set pricing
in any other currency other than your home currency.
Please see the Integration Guide for our Web Service API for details on how to request the exchange rates.
If your Store has been activated for this product option and you want to submit the payment transaction
through our Connect solution, you need to send the DCC Inquiry ID that you have received along with the
exchange rate request in the parameter ‘dccInquiryId’.
You can also use the ‘dccInquiryId’ for cases where Global Choice is being offered and handled on your side
(for example, within a mobile app). If the cardholder declines the currency conversion offer within your
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
environment, the request parameter ‘dccSkipOffer’ can be set to ‘true’ so that the hosted consumer dialogue
will automatically be skipped.
pcSupplierInvoiceNumber Merchant-defined reference for the invoice, for example, invoice number.
pcSupplierVATRegistrationNumber The Identification number assigned by the taxing authorities to the merchant.
pcTotalDiscountAmount The total discount amount applied to a transaction (that is, total transaction
percentage discounts, fixed transaction amount reductions or summarization of
line item discounts).
pcVatShippingRate The total freight/shipping amount applied to the transaction. Merchants can
choose to deliver the contents of a single transaction in multiple shipments and
this field reflects the total cost of those deliveries.
pcVatShippingAmount The total freight/shipping amount applied to the transaction. Merchants can
choose to deliver the contents of a single transaction in multiple shipments and
this field reflects the total cost of those deliveries.
ProductCode A reference to a merchant product identifier, the Universal Product Code (UPC)
of purchased item.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
UnitOfMeasure Represents a unit of measure of purchased items.
VATAmountAndRate Represents a rate of the VAT amount, for example, 0.09 (means 9%).
DiscountAmountAndRate Represents a rate of the discount amount, for example, 0.09 (means 9%).
LineItemTotal This field is a calculation of the unit cost multiplied by the quantity and
less the discount per line item. The calculation is reflected as: [Unit Cost *
Quantity] – Discount per Line Item = Line Item Total.
“?” indicates that the transaction has been successfully initialized, but a final result
is not yet available since the transaction is now in a waiting status. The transaction
status will be updated at a later stage.
oid Order ID
ipgTransactionId Transaction identifier assigned by the gateway, for example, to be used for a Void
cccountry Three letter alphanumeric ISO code of the cardholder’s country (for example,
USA, DEU, ITA and so on)
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Filled with “N/A” if the cardholder’s country cannot be determined or the payment
type is not credit card
Please see note about blocking ECI 7 transactions in the 3D Secure section of this
document.
dcc_foreign_amount Converted amount in cardholder home currency. Decimal number with dot (.) as a
decimal separator
dcc_foreign_currency ISO numeric code of the cardholder home currency. This transaction is performed
in this currency String
dcc_margin_rate_percentage Percent of margin applied to the original amount. Decimal number with dot (.) as a
decimal separator
dcc_rate_source Name of the exchange rate source (for example, Reuters Wholesale Inter Bank)
String
dcc_rate Exchange rate. Decimal number with dot (.) as a decimal separator.
dcc_rate_source_timestamp Exchange rate origin time. Integer – Unix timestamp (seconds since 1.1.1970)
dcc_accepted Indicates if the card holder has accepted the conversion offer (response value
‘true’) or declined the offer (response value ‘false’)
accountOwnerName Name of the owner of the bank account that has been used for the iDEAL
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
transaction
iban IBAN of the bank account that has been used for the iDEAL transaction
bic BIC of the bank account that has been used for the iDEAL transaction
redirectURL When reviewOrder has been set to ‘true’, the response contains the URL that you
need to finalize the transaction
When your store is enabled for SEPA Direct Debit as part of the Local Payments offering:
mandateReference Mandate reference as returned for the first direct debit transaction
mandateDate Date of the initial direct debit transaction as returned for the first transaction
For merchants using the Fiserv Global Merchant Acquiring model only:
associationResponseCode The raw association value tells exactly how the issuer has responded to the
transaction without any mapping done either by the authorization platform or the
gateway. It will be returned only for Visa, Mastercard, Amex, and Discover
For merchants activated for the Mastercard real-time account updater service:
When your store is enabled for the Mastercard real-time account updater service on the gateway and you
have the payment information vaulted on your side then when applicable the updates are sent as part of the
gateway response and you have to react upon it accordingly That is: update the account number for a token
when you store PAN and a token on your side.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
this account owing to restrictions from
cardholder. Use an alternate method of
payment or contact customer to get one.
For merchants operating on the Fiserv Nashville and activated for the Visa or Mastercard real-time account
updater service:
When you are processing on the Fiserv Nashville end-point and your store is enabled for the Visa real-time
account updater service or for the MasterCard real-time account updater service on the gateway then you
can expect the updates to be sent as part of the gateway response. When you have the payment
information vaulted on your side then you have to react upon it accordingly That is: update the account
number and the parameter ‘hosteddataid’ for a token when you store PAN and a token on your side.
hosteddataid Returned when the updates have been applied. New (TransArmor) token has to
be used in place of the old/previous one. Note that the old/previous token will not
be deleted but will be honored by the gateway till the old payment information
(account number) will be honored by the scheme (Visa).
Additionally when using your own error page for negative validity checks (full_bypass=true):
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
In addition, your custom fields and billing/shipping fields will also be sent back to the specific URL.
Please consider when integrating that new response parameters may be added from time to time in
relation to product enhancements or new functionality.
The parameter ‘response_hash’ allows you to recheck if the received transaction response has really been
sent by Fiserv and can therefore protect you from fraudulent manipulations.
The value is created with a HMAC Hash using the following parameter string:
approval_code|chargetotal|currency|txndatetime|storename
Shared secret (‘sharedsecret’) will be used as a key in HMAC to calculating the hash with the above hash
string.
The hash algorithm is the same as the one that you have set in the transaction request.
Please note that you have to implement the response hash validation, when doing so remember to store the
‘txndatetime’ that you have submitted with the transaction request in order to be able to validate the
response hash. Furthermore, you must always use the https-connection (instead of http) to prevent
eavesdropping of transaction details.
chargetotal|currency|txndatetime|storename|approval_code
Shared secret (‘sharedsecret’) will be used as a key in HMAC to calculating the hash with the above hash
string.
Such notifications can also be set up for Recurring Payments that get automatically triggered by the
gateway. Please contact your local support team to get a Shared Secret agreed for these notifications. You
can configure your Recurring Transaction Notification URL in the Virtual Terminal (Customisation/ Store
URL Settings).
In case of the recurring transactions the hash parameter is calculated as follows:
chargetotal|currency|txndatetime|storename|approval_code
Shared secret (‘rcpSharedSecret’) will be used as a key in HMAC to calculating the hash with the above
hash string.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix I – How to Generate a Hash
Transaction request values used for the hash calculation:
chargetotal= 13.00
currency= 978
paymentMethod=M
responseFailURL=https://localhost:8643/webshop/response_failure.jsp
responseSuccessURL=https://localhost:8643/webshop/response_success.jsp
sharedsecret=sharedsecret
storename=10123456789
timezone= Europe/Berlin
transactionNotificationURL=https://localhost:8643/webshop/transactionNotification
txndatetime=2020:04:17-17:32:41
txntype=sale
Step 1. Extended hash needs to be calculated using all request parameters in ascending order of the
parameter names. Join the parameters’ values to one string with pipe separator (use only parameters’
values and not the parameters’ names).
stringToExtendedHash =
13.00|978|M|https://localhost:8643/webshop/response_failure.jsp|https://localhost:8643/webshop/response_
success.jsp|10123456789|Europe/Berlin|https://localhost:8643/webshop/transactionNotification|2020:04:17-
17:32:41|sale
Corresponding hash string does not include ‘sharedsecret’, which has to be used as the secret key for the
HMAC instead.
Step 2. Pass the created string to the HMACSHA256 algorithm and using shared secret as a key for
calculating the hash value.
HmacSHA256(stringToExtendedHash, sharedsecret)
Step 3. Use the value returned by the HMACSHA256 algorithm and submit it to our payment gateway in the
given form.
8CVD62a88mwr/Nfc+t+CWB+XG0g5cqmSrN8JhFlQJVM=
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix II – ipg-util.asp
<!-- google CryptoJS for HMAC -->
<script LANGUAGE=JScript RUNAT=Server src="script/cryptoJS/crypto-js.min.js"></script>
<script LANGUAGE=JScript RUNAT=Server src="script/cryptoJS/enc-base64.min.js"></script>
<script LANGUAGE=JScript RUNAT=Server>
var today = new Date();
var txndatetime = today.formatDate("Y:m:d-H:i:s");
/*
Function that calculates the hash of the following parameters:
- chargetotal
- currency
- paymentMethod
- responseFailURL
- responseSuccessURL
- sharedsecret
- storename
- timezone
- transactionNotificationURL
- txndatetime
- txntype
*/
Response.Write(extendedhash);
}
function getDateTime() {
Response.Write(txndatetime);
}
</script>
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix III – ipg-util.php
<?php
// Timezeone needs to be set
date_default_timezone_set('Europe/Berlin');
$dateTime = date("Y:m:d-H:i:s");
function getDateTime() {
global $dateTime;
return $dateTime;
}
/*
Function that calculates the hash of the following parameters:
- Store Id
- Date/Time(see $dateTime above)
- chargetotal
- currency (numeric ISO value)
- shared secret
*/
function createExtendedHash($chargetotal, $currency) {
// Please change the store Id to your individual Store ID
$storeId = "10123456789";
// NOTE: Please DO NOT hardcode the secret in that script. For example read
it from a database.
$sharedSecret = "sharedsecret";
$separator = "|";
return $hash;
}
?>
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix IV – Currency Code List
Multicurrency Processing will be available in Australia in July 2020. Please contact the support team to
express your interest.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Omani Rial OMR 512
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix V – Payment Method List
If you let your consumer select the payment method in your website or want to define the payment method
yourself, submit the parameter ‘paymentMethod’ in your transaction request. If you do not submit this
parameter, the gateway will display a hosted page to the consumer to choose from the payment methods
that are enabled for your store and supported for the combination of the consumer’s country and the
transaction currency.
American Express A
Bancontact BCMC
Cabal CA
Diners C
eps* eps
Giropay giropay
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
HiperCard (local Brazilian brand) hipercard
iDEAL ideal
JCB J
Maestro MA
Maestro UK maestroUK
Mastercard M
MasterPass masterpass
MyBank* mybank
PayPal paypal
Paysafecard* paySafeCard
POLi* poli
RuPay RU
SafetyPay* safetypay
Sorocred SO
Trustly* trustly
TrustPay* trustPay
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Tuya (local Argentinian brand) TUYA
UnionPay CUP
Visa (Credit/Debit/Electron/Delta) V
*Only supported in a collecting model through the Fiserv Local Payments offering.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix VI – PayPal
Not Available in Australia
Refer to the following information when integrating PayPal as a payment method.
Transaction types mapping
Connect
PayPal Operation
Transaction Type (txntype)
SetExpressCheckoutPayment
Sale (sets PaymentAction to Authorization in SetExpressCheckout and
DoExpressCheckoutPayment requests)
Preauth GetExpressCheckoutDetails
sale – with additional parameters for
DoExpressCheckoutPayment*
installing a Recurring Payment
Postauth DoCapture (,DoReauthorization)
Void DoVoid
Address Handling
If you pass a complete set of address values within your request to Connect (name, address1, zip, city and
country within billing and/or shipping address), these values will be forwarded to PayPal, setting the PayPal
parameter ‘addressOverride’ to ‘1’.
Please note that it is an eligibility requirement for PayPal’s Seller Protection that the shipping address will be
submitted to PayPal.
If you submit no or incomplete address data within the Connect request, no address data will be forwarded
to PayPal and the PayPal parameter ‘addressOverride’ will not be set.
Regardless of that logic, the payment gateway will always store the shipTo address fields received from
PayPal in the GetDetails request in the ShippingAddress fields, possibly overwriting values passed in the
request to Connect (such overwriting depends on the above logic).
* If you want to use PayPal’s Reference Transactions feature for recurring payments, please contact PayPal
upfront to verify if your PayPal account meets their requirements for this feature.
Recurring Payment Transaction
You have to submit a SALE transaction request with the corresponding parameters to install the recurring
payments. The first transaction is always conducted immediately along with the request.
The subsequent transactions are executed by the Gateway’s scheduler, through the API Web Service, as
defined during the initial SALE transaction with the installation.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix VIII – MasterPass
Not Available in Australia
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
When your Store is activated for 3D Secure, these settings will also apply to your MasterPass
transactions. In the specific case of MasterPass, the authentication process will however be handled by
Mastercard inside the wallet (MasterPass Advanced Checkout), where supported programmes are
limited to Mastercard SecureCode and Verified by Visa (no American Express SafeKey). However, the
parameter ‘authenticateTransaction’ can also be used to dynamically steer the behaviour for
MasterPass for example, depending on the purchase amount. If you submit the parameter
‘authenticateTransaction’ and set it to ‘false’, the MasterPass transaction will be initiated using the
MasterPass Basic Checkout which doesn't include 3D Secure authentication
Note that merchants requesting liability shift for MasterPass transactions should use the
MasterPass Advanced Checkout/3D Secure and must enable 3D Secure service such that it is
invoked within the MasterPass wallet
The Card Code (CVV2/CVC2/4DBC) is not required for MasterPass transactions unless otherwise
required in network rules. At the time when a customer adds a card to the wallet, the Card Code gets
entered and checked once. No further Card Code entry is required from your customers. Requesting a
CVC2/CVV/4DBC is allowed when required by network rules
Address Verification Service (AVS) is handled for MasterPass transactions in the same way as for
any other card transaction, however as the billing address is associated with a card and stored inside
the wallet, the AVS result is based on the address stored inside the wallet and not the billing address
provided by your customer in your web shop
MasterPass is not available for Betting/Casino Gambling merchants (MCC 7995)
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix IX – Fraud Detect
Not Available in Australia
Refer to the following information when you are signed up to Fiserv Fraud Detect product to have card
transactions reviewed for a fraud scoring.
You can submit a payment transaction to the gateway, which routes it to the appropriate authorization front-
end. The gateway receives the authorization response. If an approval is received, the gateway submits the
transaction to Fraud Detect including authorization response details (for example, AVS/Card Code match).
Fraud Detect returns a fraud score (between 1–1000) to the gateway and depending on how the risk
tolerance level is set for your store (default 500) the transaction is either approved or voided and declined.
Refer to the Virtual Terminal Guide to learn more about the way how to set the risk tolerance level for your
store.
In case you use the Fraud Detect product and want to pass mobile device details for the scoring, you need
to pass these with the following parameter naming:
customParam_deviceRiskId
customParam_deviceRiskAPIKey
customParam_deviceRiskHost
Example:
These fields are handled in the same way as other optional request parameters. The gateway stores these
parameters and passes them on to Fraud Detect. These parameters have no impact on the transaction
processing flow.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix X – Local Payments™
Refer to the following information when you have ordered this product option and your store is enabled for
the Local Payments offering.
The Local Payments solution offers a unique combination of global coverage, a single contracting and
integration experience, and a broad and expanding portfolio of local payment methods.
Local Payments, also often referred to as Alternative Payment Methods, are defined as payment
transactions where neither credit/debit cards or paper currencies are used as the form of payment. These
payment methods are primarily used in eCommerce and mCommerce transactions, although some solutions
are making a push for adoption at point of sale locations. In many markets, they are more commonly used
than credit/debit cards.
Local Payments differ from card/association processing in a number ways. They are generally designed to
meet local needs and used in one or a limited number of markets. Unlike traditional credit/debit card
processing, pricing across these payment methods is not uniform and retail pricing depend on local costs
and merchant industries (for example, high-risk vs. low-risk). Local Payments offerings and user
experiences also vary greatly, though most are quite different from debit/credit user experiences.
There are over 300 local payment methods in use across the globe. Most of these fall into various
categories: Online Banking, Direct Debits, Direct Carrier Billing, Cash on Delivery, Invoice/Installments,
eWallets /mWallets, Cash/Voucher Payments and Payouts.
Consumer demand and preference are driving the growth in new methods of payment across the globe. In
fact, local payment methods are growing more rapidly than major card schemes, and merchant demand for
non-card (credit/debit) methods of payment is on the rise. These new payment methods deliver many
benefits to both merchants and consumers.
Local Payments help you reach and securely process payments from a broader base of consumers in each
local market, reduce shopping cart abandonment/improve conversion and improve customer experiences.
They enable more consumers to easily and confidently shop online (That is provide easy access to secure
payment methods for those that are unbanked and/or without credit or debit cards), expand their ability to
access international merchants and enable them to ‘pay their way,’ all of which improve their shopping
experiences and overall satisfaction.
Initiating a Sale Transaction
A Sale transaction for most Local Payments requires a direct interaction with the consumer who needs to be
redirected to the payment method’s screens (for example, the login page of the consumer’s bank or a wallet
provider) and back to your website after all required steps are completed.
As we handle all the required redirections to the various stakeholders for you, all you need to do is to post a
form to a URL with the parameters and values required for the transaction.
URL for Test Transactions
https://test.ipg-online.com/connect/gateway/processing
You will get the production URL with your production account credentials.
When building a request, independently of the payment method, there are some mandatory fields that need
to be included in every request for a Sale transaction.
Example of a form with the minimum number of fields:
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
<input type=”hidden” name=”hash_algorithm” value=”HMACSHA256”/>
<input type="hidden" name="hashExtended" value="<% call createExtendedHash (
"13.00","840" ) %>"/>
<input type="hidden" name="storename" value="541234567" />
<input type="text" name="chargetotal" value="13.00" />
<input type="hidden" name="currency" value="840"/>
<input type="submit" value="Submit">
</form>
paymentMethod You can submit the parameter ‘paymentMethod’ in your transaction request relevant for a
selected local payment method, as defined in Appendix V.
If you do not submit this parameter, gateway will display a page to your consumer to choose
from the payment methods that are supported for the combination of the consumer’s country and
the transaction currency.
bname The consumer’s name, for example, Albert Einstein. This is required for all Local Payments
transactions.
If you do not submit this field, a hosted page will be displayed to the consumer to capture the
name.
bcountry The consumer’s country in Two Letter Country Code format, for example, U.S. for the
United States or DE for Germany. The country is required for many Local Payments methods so
we recommend to include it in every Sale transaction request.
If you do not submit this field and the payment method requires it, a hosted page will be
displayed with the country that we have identified based on IP address and the option to change
the country, if not appropriate.
Many of the payment methods are available for customers coming from a certain country. In the scenarios
where you use the hosted payment page for payment selection, the gateway can display to your consumers
a hosted page with only these payment methods that are set up for your store and supported for the
combination of the consumer’s country and the transaction currency. This validation is done either based on
the submitted billing country (‘bcountry’) or the customer’s IP address.
See below an example of a hosted payment page in the checkout option ‘combinedpage’, where the country
is pre-set to ‘Germany’ based on the customer’s IP address but still it can be changed through a dedicated
drop-down, where else the payment methods are limited based on the combination country/currency.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
When building a request for a specific payment method, a part from the mandatory fields required for Sale
transaction and some generic fields to be considered, you might also have to include some specific fields in
your transaction request.
The payment method specific fields to be considered:
(M)=Mandatory (O)=Optional
bic giropay (O) Consumer’s BIC – Business Identifier Code (eight or 11 digits)
SOFORT Banking (O)
iban SEPA Direct Debit (M) Consumer’s IBAN – International Bank Account Number (22 digits)
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
mobileMode Alipay (O) You can submit this parameter with the value ‘true’ to enable Alipay
for mobile web That is: the mobile enabled variant of Alipay.
language WeChat Pay (O) Locale identifier for the payment page
mandateUrl M To be populated with the valid URL of the SEPA mandate to enable the Risk and
Compliance department to access the details
When you do not want to manage the SEPA Direct Debit mandates on your side, you can instead use the
out-of-box solution offered by Fiserv. Upon receiving the valid transaction request, the gateway displays a
hosted page to your customer with the mandate text and assigned mandate reference. As part of the
gateway’s response, you receive the mandate reference and mandate date, which have to be used in case
of the subsequent payments under this mandate.
Single Payment or First Payment in Recurring Series
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
mandateType O Sequence type of Direct Debit, defaults to ‘single’
Values:
single – Direct Debit is executed once
firstCollection – First Direct Debit in a series of recurring
mandateDate M To be populated with the initial mandate signature date from the response
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix XI – UnionPay SecurePlus
Refer to the following information when your store is enabled for UnionPay SecurePlus.
SecurePlus is a part of the UnionPay Online Payments (UPOP) eCommerce payment solution designed by
UnionPay for merchants who want to reduce the risk of fraudulent transactions, similar to 3D Secure.
When enabling your store for UnionPay SecurePlus, you would have to provide the UPOP MID specific in
order request UnionPay to verify enrolment and to send a SMS code to your customers (as the card
holders). However, you can also decide to allow your consumers to skip authentication, if you are happy to
hold the responsibility of transactions without the security check.
bname You can submit the consumer’s name (cardholder’s name) in your transaction request. In some
cases, when integration the checkout option ‘combinedpage’, the consumer’s name might be
required as a mandatory parameter. If you do not submit this field, gateway will display a page to
your consumer to capture the name.
phone You can submit the consumer’s phone number in your transaction request only as digits limited
to: 4–15 digits and without the phone country code extension, which is set to +86 by default. If
you do not submit this field, a hosted page will be displayed to the consumer to capture the
phone and allow him to change the phone country code extension, when applicable.
The phone is mandatory when going through security check since it is the phone number that is
checked against the card number unless you are happy to hold the responsibility of transactions
without the security check and your store is configured accordingly to skip this authentication
then your customer would be able to perform a credit card transaction, where no phone number
would be needed.
You can also consider integrating UnionPay SecurePlus through the gateway’s Web Service API. See the
further information in the Integration Guide for the Web Service API.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix XII – China Domestic
Refer to the following information when your store is enabled for China Domestic processing.
The China Domestic solution includes: China UnionPay and Alipay with a redirection of the consumer to
pages in Chinese language providing your customers with a familiar shopping experience.
Initiating a Sale Transaction
A Sale transaction requires a direct interaction with the consumer who needs to be redirected to the
payment method’s screens and back to your website after all required steps are completed.
As the gateway handles all the required redirections, all you need to do is to post a form to a URL with the
parameters and values required for a Sale transaction.
When building a request for China Domestic a part from the mandatory fields you will also need to include
some specific fields in your transaction request.
The payment method specific fields to be considered:
(M)=Mandatory (O)=Optional
id;description;quantity;item_total_price
Productcatelog_3.3.
xlsx
1 id
2 description Product name
3 quantity Quantity of product(s)
4 item_total_price Product price
customerid CUP_domestic (M) Unique reference to identify the consumer
custom_domesticBankId CUP_domestic (M) Submit a bank identifier for reporting purpose in relation to
promotions with local Chinese banks. Max length eight.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
<input type="hidden" name="hashExtended" value="<% call createExtendedHash(
"13.00","978" ) %>"/>
<input type="hidden" name="storename" value="4799500011057" />
<input type="hidden" name="paymentMethod" value="aliPay_domestic"/>
<input type="text" name="chargetotal" value="13.00" />
<input type="hidden" name="currency" value="156"/>
<input type="hidden" name="item1" value="100018;The Hobbit;1;3.50" />
<input type="submit" value="Submit">
</form>
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix XIV – Korea Domestic
Refer to the following information when your store is enabled for Korea Domestic processing.
Initiating a Sale Transaction
As the gateway handles all the required redirections, all you need to do is to post a form to a URL with the
parameters and values required for a Sale transaction.
When building a request for Korea Domestic a part from the mandatory fields you will also need to include
some custom fields in your transaction request.
The payment method specific fields to be considered:
(M)=Mandatory (O)=Optional
Full or partial Returns can be done through the Virtual Terminal interface.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
Appendix XV – Debit Disbursement
Refer to the following information only when you are operating in U.S. and your store is enabled to allow
credit transaction processing.
Debit Disbursement (Visa OCT, Mastercard MoneySend) allows businesses to disburse funds in real-time,
directly to a debit card. Faster payouts can increase loyalty and satisfaction, reduce costs for businesses.
The Debit Disbursement solution is cheaper, faster, more convenient and more traceable than traditional
payment methods. It facilitates payments and transfers such as:
Fund disbursements by e-commerce marketplaces
Government disbursements (such as VAT refunds)
Forex and binary option trade payouts
Affiliate and contractor payouts
Expense reimbursements
Corporate and manufacturing rebates
Insurance claims
The functionality for disbursements can be used with Direct Post and hosted payment page integrations. It is
also available for REST API originated transactions.
The funding source may be a credit card, debit card, prepaid card or bank account, but the receiving
account must be a debit card. Note currently only Visa and Mastercard brand debit cards can be used as the
recipient for debit disbursements.
For person-to-person payments (P2P) and P2PBankInit – Person to Person Bank Initiated, the merchant
must perform the operation as two individual transactions, one for funding (Pull transaction to debit funds
from sender) and one for disbursement (Push transaction to receive funds by receiver).
Disbursement types supported:
P2P – Person to Person
P2PBankInit – Person to Person Bank Initiated
MerchDisb – Merchant Disbursement
FundsDisb – Funds Disbursement
Pay Roll Pension Disbursement
MerchInitMT – Money Transfer – Merch Initiate
Pull transactions for getting funds from the sender can be done using the transaction type ‘sale’, while Push
transactions for the disbursement to the receiver using the transaction type ‘credit’.
When building a request for Pull transaction a part from the mandatory fields required for Sale transaction,
you can also need to include some custom fields in your transaction request.
The payment method specific fields to be considered:
(M)=Mandatory (O)=Optional
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
sdrAccount O Account Number
sdrAddr O Address
sdrCity O City
sdrState O State
sdrCountry O Country
sdrZip O Zip
sdrPhone O Phone
sdrBirthDate O Birthdate
When building a request for Push transaction a part from the mandatory fields required for Credit
transaction, you will also need to include some fields in your transaction request. Note that the possibility to
send ‘credit’ using the Connect interface is restricted and needs to be enabled for your store.
Receiver Information
The transactions will be presented in the Virtual Terminal Reports as ‘sale’ for Pull transactions and as
‘return’ for Push transactions.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.
© 2020 Fiserv, Inc. or its affiliates. All rights reserved. Fiserv is a registered trademark of Fiserv, Inc. Other products
referenced in this material may be trademarks or registered trademarks of their respective companies.