Simulator (Testing connector)

The Simulator is an adapter for integration & testing purposes only. No real transaction will be performed at any payment provider.

Test data

Credit cards

Additionally you can simulate a SCA Soft-Decline error code by sending amount 65.00 (any currency)

Extended 3D-Secure Testing

If extended 3D-Secure Testing is enabled on the Simulator, you can use the following card numbers (resp. card holder names for 3DS version 1) to simulate the given results:

3DS 2.x Simulation

3DS 1.x Simulation

Direct Debit IBANs

You can use any IBAN you like.

The last four digits will control the result:

Example: AT00 0000 0000 0000 1111 => Successful transaction

Simulate pending status change

You may simulate a transaction status change by adding the extraData pendingOutcome. Do note that this simulation may only be evoked by submitting an IBAN with outcome pending (ending with 2222) via the simulator payment page.

The status will change in approx. 5 minutes after submission.

2C2P

Payment Methods

Mandatory Parameters

Additional parameters

Due the number of payment channels 2C2P provides per payment channel an extra parameter is required to determine which channel should be used. The full list of supported channels can be found here: List of Payment Channels

To use the desired Channel the "Channel Code" has to be submitted via the "sub-method" extra data field.

AdvCash

Payment Methods

Account Verification

The register transaction type (server-to-server) allows for verifying an AdvCash account. Send either customer.email or extraData.walletId for identifying an AdvCash wallet. Additionally, customer.firstName and customer.lastName are required. AdvCash returns a percentage of how much first and last name are matching, respectively. Additionally, a boolean flag is provided if the account is verified by AdvCash.

Note: the register transaction won't fail, if first and/or last name don't match, or if the wallet account is unverified. It will only fail, if the wallet account doesn't exist.

Adyen

Payment Methods

Additional parameters

Creditcard

Blik

Afterpay

Afterpay supports the following currencies: AUD, NZD, USD and CAD. The used currency must also match the currency of the Afterpay merchant account.

Payment Methods

Mandatory Parameters

Additional Parameters

Item Parameters

If items are given with the transaction data, the following parameters can or must be given:

Options Request

Get Configured Min Max Purchase Amount

In order to get the configured Min and Max purchase amount range an Options Request is required.

Please use minMaxPrice as an identifier e.g. POST /options/{apiKey}/minMaxPrice.

You can find more information about the options request here: Options Request

AlipayPlus

The current Alipay+ integration only supports the Alipay+ CashierPayment Flow!

Payment Methods

Connector Config

Debit Parameters

Debit Customer Parameters

Debit Item Parameters

If items are provided with the transaction data, the following parameters can or must be given:

ConsultPayment Request

In order to retrieve the available payment methods and active promotions details, the consultPayment options request has to be issued.

Please use consultPayment as an optionname e.g. POST /options/{apiKey}/consultPayment.

ConsultPayment Parameters

Request body

Request body example

{
  "parameters": {
    "type": "CASHIER",
    "currency": "USD",
    "amount": 100,
    "settlementCurrency": "JPY",
    "terminalType": "WEB"
  }
}

Response

Example responses

success

{
  "success": true,
  "options": {
    "paymentOptions": [
        {
            "brandName": "Alipay+",
            "enabled": "true",
            "logos": [
                {
                    "logoHeight": "190",
                    "logoName": "Alipay+",
                    "logoPattern": "default",
                    "logoUrl": "https:\/\/cdn.marmot-cloud.com\/storage\/aplus-checkout-prod\/icon\/prod\/CONNECT_WALLET_TEST.png",
                    "logoWidth": "810"
                }
            ],
            "paymentMethodType": "CONNECT_WALLET",
            "promoNames": [
                "{\"en_US\":\"A+ Cashier Promotion Test\",\"fil_PH\":\"A+ Cashier Promotion Test\"}"
            ]
        }
    ]
  }
}

error

{
  "success": false,
  "errorMessage": "Given identifier 'someIdentifier' is invalid."
}

You can find more information about the options request here: Options Request

AmazonPayments

Payment Methods

Integration guide

AmazonPayments require you to display the Amazon Widget on your Checkout page. This is handled by the payment.js integration.

​1. Embed the payment.min.js in your page

<script data-main="payment-js" src="https://gateway.ixopay.com/js/integrated/payment.min.js"></script>

​2. Provide DIV elements on your page for the various Amazon widgets

<div id='loginButton'></div>
<div id='addressWidgetDiv'></div>
<div id='walletWidgetDiv'></div>
<div id='consentWidgetDiv'></div>

​3. Initialize the payment.js with the following parameters:

• publicIntegrationKey of the AmazonPayments connector
• IDs of the DIV elements
• Javascript function to handle AmazonPayments events
• Additional parameters (see below in example, refer to AmazonPayments Documentation for possible options)
• Javascript function to handle initialization completion

<script type="text/javascript">
    var payment = new PaymentJs("1.2");

    amazonEventHandler = function(eventName, data) {
        //handle events here
    }

    completeHandler = function(paymentJsInstance) {
        //you can do additional stuff in here, e.g. make the DIVs visible if they were hidden
    }

    var additionalParameters = {
        buttonType: "PwA", // Type of AmazonPayments Button
        buttonColor: "Gold", // Color of AmazonPayments Button
        buttonSize: "small", // Size of AmazonPayments Button
        loginPopup: true, // Use Pop-Up for logging customers in into their Amazon account
        autoShow: true, // automatically show AmazonPayments Login button once ready
        loginRedirectUrl: // if loginPopup is false, provide the URL to get back redirected after customer logged in to Amazon
    };

    payment.initAmazon(
        'public-integration-key',
        'loginButton', // mandatory
        'addressWidgetDiv', //optional
        'walletWidgetDiv', // mandatory
        'consentWidgetDiv', // optional, necessary for recurring transactions
        amazonEventHandler,
        additionalParameters,
        completeHandler
    );
</script>

​4. You can react on the various AmazonPayments events in your amazonEventHandler.

If you set autoShow to true, the various widget will be automatically shown to fulfill the payment flow.

If set to false, you have to take care about that on your own.

The following events will be fired:

• login.ready: ready to show login button
• login.shown: login button was shown
• login.error: failed to show login button, data will include code and message with Amazon error information
• login.complete: customer successfully logged in
• addressBook.error: failed to show addressBook widget, data will include code and message with Amazon error information
• addressBook.shown: addressBook widget was shown
• addressBook.selected: customer has chosen/changed the delivery address
• wallet.error: failed to show wallet widget, data will include code and message with Amazon error information
• wallet.selected: customer has chosen a wallet
• wallet.shown: wallet widget was shown
• consent.complete: consent was granted by customer
• consent.incomplete: consent is not yet granted by customer
• consent.error: failed to show consent widget, data will include code and message with Amazon error information

The individual widgets can be shown and hidden with payment.js methods.

<script type="text/javascript">
    // show/hide login button
    payment.amazon().login.show();
    payment.amazon().login.hide();

    // show/hide addressBook widget
    payment.amazon().addressBook.show();
    payment.amazon().addressBook.hide();

    // show/hide wallet widget
    payment.amazon().wallet.show();
    payment.amazon().wallet.hide();

    // show/hide consent widget
    payment.amazon().consent.show();
    payment.amazon().consent.hide();

</script>

​5. Once wallet.selected (or consent.complete to enable recurring transactions) was fired, and the customer confirms the order on your checkout page, you must call the tokenize method to obtain a payment token. This token is then to be used in the transactionToken element of the Debit call to the Transaction API.

<script type="text/javascript">
    payment.tokenize(
        {}, //optional additional data
        function(token) {
            //Submit token to your server and perform transaction through Transaction API

            //Example:
            $('#transaction_token').val(token); //store the transaction token
            $('#payment_form').get(0).submit(); //submit the form
        },
        function(errors) {
            //show/handle errors
        }
    );
</script>

Amazon Payment Services

Payment Methods

Mandatory Parameters

Additional Information

Be aware that we have a special converter for this adapter, which converts our Transaction Indicators to Amazon.

For Amazon Payment Services we can identify MADA/MEEZA cards depending on the BIN range to be used in the Hosted Payment Page

ApplePay

ApplePay is not an adapter itself, but a common type of payment supported by some of the listed adapters.

Prerequisites

For processing transactions with ApplePay tokens, the Gateway has to be configured with your Payment Processing certificate first. Please ask your Gateway administrator to do so.

Instruction on how to acquire this certificate can be found directly in the Apple documentation: https://developer.apple.com/documentation/apple_pay_on_the_web/setting_up_your_server

Transaction Processing

For ApplePay transactions acquire a Payment Token through your iOS App, or ApplePay on the Web. (Refer to https://developer.apple.com/documentation/passkit & https://developer.apple.com/documentation/apple_pay_on_the_web).

The resulting token must be submitted in the transactionToken element of the Debit/Preauthorize, prefixed with applepay:

Example:

<transactionToken>applepay:{"token":{"paymentData":{"version":"EC_v1","data":"...","signature":"...","publicKeyHash":"...","transactionId":"...."}},"paymentMethod":{"displayName":"Some card","network":"MasterCard","type":"debit"},"transactionIdentifier":"..."}}</transactionToken>

ATOM

Payment Methods

Additional parameters

Authorize.net

Payment Methods

Additional Parameters

none

Banca Intesa

Payment Methods

Additional Parameters

Beem

Payment Methods

Additional Information

• For all transactions of Type [Debit], Descriptionis a mandatory field.
• it's mandatory to add items to the Debit transactions where Item Name accepts one of these values [sku,tax,shipping, discount].
• Item Description and Item Price are mandatory as well.
• for "sku" items, these fields are mandatory too : Item Identifier, Item.extraData.disc_amount for discount amount, and Item.extraData.disc_description for discount description. While this field is optional: Item.extraData.uri.

BillPay

Payment Methods

Note: any Debit transaction automatically creates the authorization & the invoice on BillPay side.

Mandatory parameters

Bitpay

Payment Methods

Additional Parameters

Braintree CreditCard

Provider Test-Cards:

• Valid Card Numbers
• Card Numbers for Unsuccessful Verification
• Card Numbers with type Indicators
• Card Numbers with other Information

Payment Methods

Connector Config

Further Config Parameter Description

To be able to use sendDescriptionInCustomField or sendMerchantTransactionIdInCustomField, you will have to set up "Custom Fields" in the Braintree Merchant Portal (please checkout the offical Braintree Docu, see Custom Fields).

Add a new Custom Field and pass the "Api Name" of the representing field in the Connector Config. (e.g 'merchant_tx_id' for sendMerchantTransactionIdInCustomField)

Required parameters

• transaction.indicator: mandatory for card on file, card on file merchant initiated, recurring (see Recurring Transactions)

GooglePay & ApplePay

Further Information on how to process GooglePay & ApplePay Tokens.

Braintree PayPal

Payment Methods

Integration guide

Braintree requires you to display the PayPal Button on your Checkout page. This is handled by the payment.js integration.

​1. Embed the payment.min.js in your page

<script data-main="payment-js" src="https://gateway.ixopay.com/js/integrated/payment.min.js"></script>

​2. Provide a DIV element on your page for the PayPal button

<div id='paypalButtonDiv'></div>

​3. Initialize the payment.js with the following parameters:

• ID of the DIV element
• Boolean option to state whether device data should be gathered (needed for merchant initiated Card-On-File transactions)
• Javascript function to handle payment completion
• Javascript function to handle error events
• Javascript function to handle cancellation events
• PayPal options (see below in example, refer to Braintree Documentation for possible options. The 'flow' option is per default set to 'vault' if not otherwise specified, but may be overwritten, e.g. 'checkout'. Please refer to the Paypal Documentation for the different button options.

<script type="text/javascript">
    var payment = new PaymentJs("1.2");

    errorHandler = function(error) {
        //handle error events here
    }

    cancellationHandler = function(data) {
        //handle cancellation event here - called if user cancelled payment process
    }

    completeHandler = function(paymentNonce, deviceData) {
        //send the paymentNonce to the gateway via the transactionToken parameterop
        //send deviceData to Ixopay via the extraData.deviceData parameter if the parameter 'gatherDeviceData' was set to true
    }

    var buttonOptions = {
        style: { color: 'silver'},
        locale: 'en_US'
    };

    var paypalOptions = {
        amount: "9.99",
        currency: "EUR",
        button: buttonOptions,
        flow: "vault"
    };

    payment.initBraintreePaypal(
        'public-integration-key',
        'paypal-button-div',
        false, // gatherDeviceData, set true for merchant initiated card-on-file transactions
        completeHandler,
        errorHandler,
        cancellationHandler,
        paypalOptions
    );
</script>

​4. You can now call the Transaction API with the transaction token set to the paymentNonce returned to the completeHandler.

If you set gatherDeviceData to true, the completeHandler will receive a second parameter deviceData which can be sent via the Transaction API using the extraData.deviceData parameter.

If set to false, device data will not be gathered and the deviceData parameter will be null.

Collecting device data is only required for Card-On-File transactions.

Transaction API Additional Parameters

When sending the payment token received by the completeHandler to the Transaction API, the following extraData keys can be used:

Customer ExtraData Parameters:

Customer Identification Mandatory

The parameter customer.identification is mandatory in the following cases:

• When creating a new register transaction
• When creating a debit or preauthorize transaction with the flag withRegister
• When creating a merchant initiated Card-On-File transaction

CreditCard

Test Me

Cardeta

Payment Methods

Additional Mandatory Parameters

CashFlows

Payment Methods

Additional parameters

Certegy

Payment Methods

Mandatory parameters for Debit and Preauthorize

Mandatory parameters for Register

CheckoutCom

Payment Methods

Additional Parameters

iDeal Debit

Payout parameters

Platform 1

On behalf of another person or business:

For detailed information kindly refer to Requirements

Account Funding Transfer parameters

CKB

Payment Methods

Additional Parameters

Clearhaus

Payment Methods

Additional Parameters

none

CM

Payment Methods

Additional parameters

CoinGate

Payment Methods

Additional Parameters

none

Cybersource PCI

Payment Methods

Adapter Config

The following fields are mandatory depending on the used features:

General Transaction extraData:

The following extraData fields are required or optional for ALL transactions:

Capture Transactions:

The following extraData fields are required for capture transactions:

Recurring Transactions:

The following extraData fields are required for recurring transactions:

Debit/Authorization/Incremental Authorization Transactions:

The following extraData fields are optional for these transaction types:

Decision Manager:

The following extraData fields are necessary or optional for the Cybersource Decision Manager (Please refer to the Cybersource Documentation for the possible values and the requirements):

Dalenys

Payment Methods

Additional Parameters

• description (required)
• useragent (extra data, required):
  The browser's useragent (even for recurring transactions).
• descriptor (extra data, optional): needs to be enabled on Daleny's side too.
• identification (customer, required)
• email (customer, required)
• IP address (customer, required)
• Reference Transaction (maybe required):
  Depending on your MCC, it might be required to reference a 3DS authed transaction for payouts.

3D-Secure Verification parameters are supported, however MANDATORY will behave like OPTIONAL. That is, if the card is not enrolled for 3DS authentication, the transaction will pass unauthenticated.

Dimoco

Payment Methods

Additional Parameters

SMS-Pay

DCB (Direct Carrier Billing) & PSMS (Premium SMS)

Depending on the underlying country of the MSISDN (mobile subscriber integrated services digital network number), the final payment might be via DCB or PSMS.

Options Request

EPS

For EPS you can retrieve the bank list via the Options request identifier epsBankList. You can display this list to your customer in order to pre-select the desired bank.

The result contains a list of banks available for EPS, with BIC code as key and bank name as value. The chosen BIC code of the chosen bank should then be passed as bic element in the IbanCustomer element of the XML.

dLocal

Payment Methods

Additional Parameters

Credit card

Note: 3D-Secure behaviour is dependent on dLocal's configuration. For Mexico you may set 3dsecure explicitly to OPTIONAL.

APM & BankTransfer

Payouts

Depending on the country and receiving bank, a variety of additional parameter may be required (refer to dLocal's documentation).

Options Request

Debit - BankTransfer

For BankTransfer, you may retrieve a list of available banks in a country via the Options request identifier getBankList. You can display this list to your customer having him selecting his bank. The selected bank code should be submitted as bank_id in extra data.

EasyPay (ePay.bg)

Payment Methods

Additional Parameters

• invoice (optional):
  If missing, a random id will be generated. The invoice will always be returned in the response.
• success URL (required for redirect)
• cancel URL (required for redirect)

EBANX PCI

Payment Methods

Credit Card

Please refer to EBANX to see which customer data are necessary to process in certain countries.

Additional Parameters

You will have to use the following extraData keys:

EBANX

Payment Methods

Additional Parameters

Debit: APM & BankTransfer

Refund: APM & BankTransfer

Payout: BankTransfer

Options Request

You can find more information about the options request here: Options Request

Retrieving a list of available banks

EBANX supports 2 endpoints for retrieving a list of available banks for all supported countries. The results may be used for providing the correct parameters for the payout request.

They're available with the options request identifier getAvailableBanks and getBankDetails.

Ecommpay

Because of a restriction on Ecommpay side, you need to set the particular setting "Accept postbacks from other connectors (list GUIDs comma-separated)" inside the connector where you passed the notification URL to Ecommpay if you want to configure multiple connectors.

As value you need to pass the connector ID from all other Ecommpay connectors of the same account, example: "CO-8ce8-4ed7-e9d9-9261-715a-fad8,CO-02c7-62dd-d0e8-5918-6373-7e75". With this setting, all connectors will work with the same notification URL. This setting only needs to be set on the connector where you passed the notification URL to Ecommpay.

If you only have one connector per Ecommpay account, you don't need to configure this setting.

Payment Methods

*Payout/Refund doesn't require any customer interaction or redirection.

**For Alipay refunds you have to activate the 'merchant_refund_id' field on Ecommpay side. Please talk to your Ecommpay Account Manager for further information.

Additional parameters for BankTransfer Debit

Additional parameters for BankTransfer Payout

• To retrieve a list of bank identifiers you need to send an options request with the identifier debit-bank-list or payout-bank-list and as parameter the bank name (available: vietnam, malaysia, philippines, indonesia, thailand).

** To retrieve a list of region identifiers you need to send an options request with the identifier region-list and as parameter the bank name (available: vietnam, malaysia, philippines, indonesia, thailand).

You can find more information about the options request here: Options Request

Additional parameters for AliPay / DOKU Wallet / Nganluong Wallet Debit

Additional parameters for China Union Pay Payout

• To retrieve a list of bank identifiers you need to send an options request with the identifier debit-bank-list or payout-bank-list and as parameter the bank name (available: vietnam, malaysia, philippines, indonesia, thailand).

** To retrieve a list of region identifiers you need to send an options request with the identifier region-list and as parameter the bank name (available: vietnam, malaysia, philippines, indonesia, thailand).

You can find more information about the options request here: Options Request

Additional parameters for Alipay Refund

Additional parameters for Nganluong Wallet Payout

Additional parameters for DOKU Wallet Payout

EmerchantPay

Payment Methods

Additional Parameters

none

Emerchantpay Genesis

Payment Methods

Mandatory parameters for Debit, Debit with Register, Register

Mandatory parameters for Recurring Debit

Mandatory parameters for Refund

Mandatory parameters for Payout

Supported countries

AT, BE, CY, EE, FI, FR, DE, GR, IE, IT, LV, LT, LU, MT, MC,
NL, PT, SK, SM, SI, ES

ESR / SwissQR Bill

Payment Methods

Additional parameters

• additionalId1: mandatory - must contain the reference number for the bill.
• description: optional - description for the bill
• customer.firstName: optional
• customer.lastName: optional
• customer.billingAddress1: optional
• customer.billingPostcode: optional
• customer.billingCity: optional
• customer.billingCountry: optional

Return Values

In the response you will find the key qrCode within the extraData element. This contains the Base64-encoded Image for the QR Code.

EwlPISP

The APIs will allow the initiation of a payment from any payment account to another payment account in Europe, held by any reachable ASPSP provided the account holder has given his explicit consent as is stipulated by the Payment Services Directive

Payment Methods

Additional Parameters

Options Request

Get Bank List from Reach Directory

In order to get the bank list from reach directory an Options Request is required.

Please use getBankList as an identifier e.g. POST /options/{apiKey}/getBankList.

Request Body

{ "parameters": { "countryCode": "FR" } }

You can find more information about the options request here: Options Request

E-xact

Payment Methods

Additional Parameters

none

expressÜberweisung

Payment Methods

Additional parameters

FacilitaPay

Payment Methods

Parameters Register

Parameters Debit

Parameters Payout

Finance Wide

Payment Methods

Additional Parameters

3D-Secure Verification parameters are ignored entirely, however the underlying gateway manages and changes the behavior of 3D-Secure requirements on demand.

Finaro

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Finrax

Payment Methods

Additional Parameters

You can use the following extraData keys, which will be passed in the corresponding fields to Finrax:

FinTecSystems

Payment Methods

Additional parameters

Fortumo

Payment Methods

Additional Parameters

none

GatewayHub

Payment Methods

Additional Mandatory Parameters

GiroSolutions

Payment Methods

Additional Parameters

none

GoCardless

Payment Methods

Mandatory Parameters for Debit with Register

Additional Parameters for Debit, Register

Additional Parameters for Refund

GooglePay™

GooglePay is not an adapter itself, but a common type of payment supported by some of the listed adapters.

Only GooglePay protocol version 2 (ECv2) is supported.

Prerequisites

You can use GooglePay in your Android app or on your website.

To integrate GooglePay in your Android app please refer to the following links:

• Google Pay Android developer documentation
• Google Pay Android integration checklist
• Google Pay Android brand guidelines

To integrate GooglePay in your website please refer to the following links:

• Google Pay Web developer documentation
• Google Pay Web integration checklist
• Google Pay Web brand guidlines

Transaction Processing

For GooglePay transactions acquire a Payment Token through your Android app, or on your website.

Use the following parameters when sending a request to Google and replace YOUR_MERCHANT_ID with the GUID of your merchant: gateway = "YOUR_GATEWAY_PARAMETER" gatewayMerchantId = "YOUR_MERCHANT_ID"

If you are unsure about your gateway parameter, please contact your account manager.

The resulting token must be submitted in the transactionToken element of the Debit/Preauthorize, prefixed with googlepay:

Example XML
<transactionToken>googlepay:{"signature":"...","intermediateSigningKey":{"signedKey":"{\"keyValue\":\"...\",\"keyExpiration\":\"...\"}","signatures":["..."]},"protocolVersion":"ECv2","signedMessage":"{\"encryptedMessage\":\"...\",\"ephemeralPublicKey\":\"...\",\"tag\":\"...\"}"}</transactionToken>

Example JSON
[...]"transactionToken": "googlepay:{\"signature\":\"...\", ...}\"}",[...]

Card Parameters

A billing address is not required for processing transactions, therefore no billing address parameters need to be given with a card.

Supported Card Authentication Methods

• PAN_ONLY
• CRYPTOGRAM_3DS

Supported Card Networks

• AMEX
• DISCOVER
• INTERAC
• JCB
• MASTERCARD
• VISA

HNCB - Hua Nan Commercial Bank

Payment Methods

Connector Config

Important Information (HNCB QR + Bank Transfer)

HNCB requires a strict format for the OrderNumber (also known as NoticeNumber in case of the Bank Transfer Payment Method) that is sent to them. The structure of this Number looks like : 5 chars (EnterpriseCode_BankTransfer_QR is automatically taken from the Connector Config) + 11 chars. Ixopay requires you to set up a Terminal to your Connector, which will autogenerate an STAN and add it as part of the OrderNumber.

Humm

The required currency is AUD (Australian dollar) for Australia and NZD (New Zealand dollar) for New Zealand.

Payment Methods

Additional Parameters

HiPay

Payment Methods

Mandatory parameters for Debit and Preauthorize

Aditional parameters Debit and Preauthorize

Mandatory parameters for capture and refund

Item Parameters

If items are given with the transaction data, the following parameters can or must be given. For capture and refund only items that must be captured or refunded have to be sent.

Ingenico Connect

Payment Methods

Required parameters

• customer.billingCountry: mandatory
• customer.identification: mandatory for register, debit with register, authorization with register
• transaction.indicator: mandatory for card on file, card on file merchant initiated, recurring (see Recurring Transactions)

Webhooks

To use webhooks with Ingenico Connect you have to register the webhooks callback URL inside the Ingenico Connect Interface or talk with your account managerr on Ingenico side.

Testcards

3DS Test cards can be found here:

Ingenico Connect Test Cases

Ingenico Direct

Payment Methods

• Documentation regarding Google Pay and Apple Pay can be found here: Google Pay, Apple Pay

Required parameters

iDeal

• extraData.ideal_issuer

For the issuer you may do an Options Request using the identifier ideal-issuers. It will return a list of available issuer for iDeal.

Webhooks

To use webhooks with Ingenico Direct you have to register the webhooks callback URL inside the Ingenico Interface or talk with your account manager on Ingenico side.

Testcards

3DS Test cards can be found here:

Ingenico Direct Test Cases

iPayAfrica

Payment Methods

Additional Parameters

none

iSignThis

Payment Methods

Additional parameters

• customer.identification: mandatory
• customer.firstName: mandatory
• customer.lastName: mandatory
• customer.email: mandatory
• customer.ipAddress: mandatory

Kalixa

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Kassa Compleet

Payment Methods

Additional Parameters

none

Khipu

Payment Methods

Connector Config

Debit Parameters

Klarna Hpp

Payment Methods

Connector Config

Klarna Widget

Payment Methods

Connector Config

Integration Guide

To activate the Klarna Widget you will first have to include the payment-widget.js.

​1. Embed the payment-widget.min.js in your page

<script data-main="payment-widget-js" src="https://gateway.ixopay.com/js/integrated/payment-widget.min.js"></script>

​2. Provide Container for the Klarna Widget.

<div id="klarna-payments-container"></div>

​3. Retrieve a Widget-Token via a Prepare Call (Prepare-Debit or Prepare-Preauthorize). This Call is required to initialize a Klarna Session and provide it with all the checkout data.

• Endpoint: POST https://gateway.ixopay.com/api/v3/transaction/{apiKey}/prepare-(debit or preauthorize)

Prepare Transaction Parameters

​4. Initialize the Klarna Widget with the following parameters:

• The "Public Integration Key" of your Connector
• The "Widget-Token" that you received from the Prepare Call
• Javascript function to handle payment completion
• Javascript function to handle error events

<script type="text/javascript">
    var widget = new WidgetJs();

    errorHandler = function(error) {
        //handle error events here
    }

    completeHandler = function(initResult) {
        //Klarna init result
    }

    widget.initKlarna(
      'Public Integration Key',
      'Widget-Token', 
      'klarna-payments-container', 
      completeHandler, 
      errorHandler
    );

</script>

​4. Authorize / Finalize the Klarna Widget with the following parameters:

• The "Public Integration Key" of your Connector
• The "Widget-Token" that you received from the Prepare Call
• Javascript function to handle payment completion
• Javascript function to handle error events
• Auto-Finalize Option (only available for the Sofort 'pay_now' payment method - default = true), as described in the Klarna Documentation: finalize is a special call that is needed for the Pay Now payment method category in multi-step checkouts. In a multi-step checkout scenario the authorize() call can be triggered when the consumer selects the payment method and then presses the “continue” button to go to the next step of the checkout. With Pay Now as payment method category however transferring the funds should only happen once the consumer has pressed the “buy” button to finalize the purchase. To cater for such a scenario authorize() can still be called when the consumer has selected the payment method, but with the auto_finalize property set to false.
  

<script type="text/javascript">
    var widget = new WidgetJs();

    errorHandler = function(error) {
        //handle error events here
    }

    completeHandler = function(authToken) {
        //send the received authToken in the extraData for a debit or preauthorize call
    }

    widget.authKlarna(
      'Public Integration Key',
      'Widget-Token', 
      'klarna-payments-container', 
      completeHandler, 
      errorHandler,
      true/false(optional)
    );
    // Depending on Auto-Finalize Option from widget.authKlarna
    widget.finalizeKlarna(
          'Public Integration Key',
          'Widget-Token', 
          'klarna-payments-container', 
          completeHandler, 
          errorHandler
    );
</script>

​5. Send Debit / Preauthorize Request with the received Auth-Token from Step 4.

Send the authorization_token in the extraData object to place the order.

Transaction Request Debit, Preauthorize, Capture

Transaction Parameters

Recurring Transactions

Klarna supports recurring Orders. To create a recurring Order you will have to send your Debit or Preauthorize with the extra "withRegister" flag. For every following recurring Transaction you will have to provide the initial Transaction Uuid as "referenceUuid" and the "transactionIndicator" with "RECURRING".

Klarna Partial Capturing / Release remaining authorization

Klarna supports partial capturing of created orders. Therefore send a regular Capture call with the desired capture amount and the the corresponding reference Transaction ID. If you did not fully capture the original order amount, you can either send another Capture Request to actually capture the remaining amount or release it with an "Final Capture". This will "release" the remaining amount and add it to your Klarna Merchant contingent. To release a remaining order amount, you will have to send a Capture with an amount of 0.

Klarna Discounts

Klarna supports transmit of Discount Data, these Data can be send on either order level oder item level. For further information about this topic please visit the official Klarna Documentation. IXOPAY assumes to receive the correct Discount relevant Data and wont apply any validation to it. If your send that Data dont fit the Klarna convention you might be served with an Klarna provided Error.

On Order Level

To achieve an Order Level Discount, you will have to send an Item with the type 'discount'.

Item Level

If you like to send the discount information for a specific Item, you will have to send / add these on the corresponding Item Level.

Klarna

Payment Methods

Additional Parameters

none

Laybuy

The required currency is AUD (Australian dollar).

Payment Methods

Additional Parameters

Item