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

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.

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

none

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

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>

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>

Authorize.net

Payment Methods

Additional Parameters

none

Banca Intesa

Payment Methods

Additional Parameters

BillPay

Payment Methods

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

Mandatory parameters

Bitpay

Payment Methods

Additional Parameters

Braintree

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

Cardeta

Payment Methods

Additional Mandatory Parameters

CashFlows

Payment Methods

Additional parameters

CheckoutCom

Payment Methods

Additional Parameters

iDeal Debit

CKB

Payment Methods

Additional Parameters

Clearhaus

Payment Methods

Additional Parameters

none

CM

Payment Methods

Additional parameters

CoinGate

Payment Methods

Additional Parameters

none

Credorax

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

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 can 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.

| Field | Type | Mandatory | | --- | --- | | customer.firstName | string | conditional | | customer.lastName | string | conditional | | customer.billingCountry | string | conditional | | customer.nationalId | string | conditional | | customer.billingAddress | string | conditional |

Additional Parameters

You will have to use the following extraData keys:

Ebanx

Payment Methods

Additional Parameters

Debit: APM & BankTransfer

Refund: APM & BankTransfer

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

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

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.

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

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

Humm

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

Payment Methods

Additional Parameters

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

Klarna Hpp

Payment Methods

Additional Parameters

You will have to use the following extraData keys in the Connector Settings:

Klarna Widget

Payment Methods

Additional Parameters

You will have to use the following extraData keys:

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)

​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

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

Mastercard Payment Gateway Services

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

MasterPayment

Payment Methods

Additional Parameters

none

MocoPay

Payment Methods

Additional Parameters

none

Mollie

Payment Methods

Additional Parameters

none

MultiSafePay

Following features has to be enabled from your Multisafepay Account Manager

• 0 Cent Authorization if you want to use register without the pre-authorization / void workflow
• Flexible 3ds if you want to control when the user has to 3DS authenticate

Payment Methods

Additional Parameters

Neteller

To fully set up the Neteller Connector you will have to fulfill the following (mandatory) steps:

• Enter your Private Key Username & Private Key Password in the "Extra Data" Fields. (Merchants / User / Connectors / Neteller / Config / Extra Data).

  • You can retrieve your Private and Public keys via the NETELLER Merchant Dashboard (Developer / Apps; You might need to "Add application")
  • Copy the Username & Password from the Section "PRIVATE Key".

  
  

• Inform Paysafe ([email protected]) to set up your Webhook URL.

  • You can retrieve your Webhook URL via the Connector Settings (Merchants / User / Connectors / Neteller / Base Data / Notification Url).
  • Send them the given "Notification URL".

Payment Methods

Additional Parameters

NMI (Network Merchants Integrated)

Payment Methods

Additional Parameters

Direct Post API

• 3D-Secure Verification Parameters

Nuvei

Payment Methods

Mandatory Parameters

Ochapay

Payment Methods

Additional Parameters

none

Omipay

The required currency is AUD (Australian dollar).

Payment Methods

Additional Parameters

none

Openpay

The required currency is AUD (Australian dollar).

Payment Methods

Additional Parameters

Item

Options Request

Get Configured Min Max Purchase Price

In order to get the configured Min and Max purchase price 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

Pago46

Payment Methods

Additional Parameters

none

Options Request

Paying an Agent (sandbox only)

In order to mock the event on the sandbox that a customer has payed an agent an Options Request is required. Use payAgent as identifier and pass the adapter's transaction ID in the transaction parameter.

Payline

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Mandatory Parameters

Paymentwall PCI

Payment Methods

Recurring payments

The same customer identification must be used for all affected transactions (for the initial, as well as for subsequent transactions).

Additional Parameters

• 3D-Secure Verification Parameters

Required Parameters

• productId
• productName
• identification (Customer)
• email (Customer)
• ipAddress (Customer)
• firstName (Customer)
• lastName (Customer)

Paymentwall

Payment Methods

Additional Parameters

• email (Customer)
• productId
• productName
• successUrl
• errorUrl

PayOn

Payment Methods

Additional Parameters

none

Payoneer

In order to use the Payoneer Adapter, you will have to contact Payoneer to register a Backdirect Uri of the Gateway to your Payoneer Account. e.g.: https://gateway.ixopay.com/backdirect/custom/{CONNECTOR-ID}.

Payment Methods

Additional Parameters

PayPal

Payment Methods

PayPal Payment Types

PayPal supports different kind of payments:

• Sale: Will charge the user for the full amount of the transaction
• Authorization: Only authorizes the user's payment instrument. This needs afterwards to be captured with a Capture request
• Order: Only gets consent from user for this particular order. No funds will be authorized

A Debit will always use the Sale type. A Preauthorize will by default use the Authorization type.

You can control the behavior for Preauthorize by sending the paypalPaymentAction parameter (see below).

Additional Parameters

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

Items

If submitting items, the following fields are Mandatory:

Item ExtraData Parameters:

Paysafecard

Payment Methods

Additional Parameters

none

PerfectMoney

Payment Methods

Please note, that a register transaction only makes sense to be used with followed payout transactions and not for referencing debit transactions, as the latter require the customer to be redirected to PerfectMoney for re-authentication purposes on each follow up debit. That is different to all other Register -> Debit/Preauth flows on other adapters.

Mandatory Parameters

• amount
• currency
• description

Additional parameters on debit

Additional parameters on register

If you want to validate the PerfectMoney account data: accountName, accountFullName, accountPhonenumber, requireVerifiedAccount, your PerfectMoney account has be enabled to return those details. Please request that from your account manager at PerfectMoney.

Additional parameters on payout

If the payout references a register transaction, it depends on the extra data provided on the initial register transaction, if the current PerfectMoney account details should be compared to those. For example if the extra data requireVerifiedAccount has been provided, all follow up payouts require the current verification status to be verified. If that is not the case, the payout fails. If additional extra data fields (accountName|accountFullName|accountPhonenumber) have been provided initially, they also have to match the current returned PerfectMoney account details. If they do not, the payout fails.

Currencies

EUR, USD, OAU

Powercash21

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Mandatory Parameters

Trustly

MaxxWallet

PPRO

Payment Methods

Additional Parameters

none

Qualpay

Payment Methods

Additional Parameters

none

SCB

Payment Methods

Additional Parameters

SecureTrading

Payment Methods

Additional Parameters

none

SepaExpress

Payment Methods

Depending on your setup SepaExpress can be used as Server-to-Server only integration, or with an iFrame Payment form.

For the Server-to-Server integration the IBAN must be sent within the customer details, otherwise the customer will enter its IBAN within the iFrame form.

Additional parameters

• additionalId1: must contain the Order ID. One Order ID can contain more than one transaction! Relevant for SEPAexpress to detect the sequence of the transaction and for refunds. Allowed pattern ([A-Za-z0-9]|[+|\?|/|\-|:|(|)|.|,|']){1,50}
• additionalId2: for recurring transactions it must contain the Contract ID: A unique identifier of the user or contract of the user on merchant level. One Contract ID can contain more than one Order IDs! Relevant to detect the sequence of the transaction.
• description: mandatory
• customer.firstName: mandatory
• customer.lastName: mandatory
• customer.iban: mandatory (for Server-to-Server)
• customer.bic: optional
• customer.mandateId: mandatory. Allowed pattern ([A-Za-z0-9]|[+|\?|/|\-|:|(|)|.|,|']){1,35}
• customer.mandateDate: mandatory

SepaExpressV2

Payment Methods

Depending on your setup SepaExpressV2 can be used as Server-to-Server only integration, or with an iFrame Payment form.

For the Server-to-Server integration the IBAN must be sent within the customer details, otherwise the customer will enter its IBAN within the iFrame form.

Additional parameters

Shimotomo

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Depending on your merchant account, additional parameters might be mandatory.

SIX ELink

Payment Methods

Additional Parameters

If the dynamic descriptor is enabled, it is possible to set the descriptor with the extra parameter extraData.descriptor.

IXOPAY also supports final capture, for this you have to send the extra parameter extraData.captureType - final.

Skrill

Payment Methods

Additional Parameters

Sofort

Payment Methods

*Refund is only available in BE, NL

Additional Parameters

iDeal debit

*For the BIC you may do an Options Request using the identifier iDealBankList. It will return a list of available banks for iDeal which you should render to let the customer pick a bank. You should then pass the selected bank code as bic element inside IbanCustomer.

iDeal refund

Spreedly

Payment Methods

Additional Parameters

none

Stripe

Payment Methods

Additional Parameters

none

Stuzza

Payment Methods

Additional parameters

If no bank_bic is given, the user will be redirected to the Stuzza bank selection page.

You can use your own bank selection page by using the bank_bic value. To do this 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 BIC code of the chosen bank should then be passed via extra data value bank_bic.

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

TabaPay

Payment Methods

Additional Parameters

none

TECS

Payment Methods

Additional Parameters

none

TNG

Payment Methods

Additional Parameters

none

Options Request

Obtaining a QR code

In order to generate a QR code which shall be displayed by the payer in the app, an Options Request is required. Use requestTopupCode as identifier and pass the customer's ID in the customerId parameter.

Transact.eu

Cards vaulted with Transact.eu can only be charged but not preauthorized.

Truevo

Payment Methods

Additional Parameters

none

Trustly

Payment Methods

Additional parameters

TRUST Payments PCI

Payment Methods

Additional Parameters

WorldPay (Vantiv / Litle)

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Direct Debit (eCheckSales)

Debit

Refund

Although it is a refund call, the system will first try to void the Transaction (in case it was not settled by PSP by now). If the Void should fail a refund will be triggered.

VOLT

Payment Methods

Additional Parameters

Options Request

Vyne

Payment Methods

Additional Parameters

If the QR Method is used (on connector level), the initial debit call will return an extraData.qrCode field with an URL provided by Vyne to the QR Code to show to the customer.

WeAccept

Payment Methods

Additional parameters

*) only certain states and cities within Egypt are supported.
Refer to WeAccept's cash annex.

Wirecard

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Worldpay

Payment Methods

Additional Parameters

none

Required Parameters for POLi

Worldpay Access

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Worldpay Express

Payment Methods

Additional Parameters

none

Zip Payments

Payment Methods

Additional Parameters

Wallet (Debit & Preauthorize)

Mandatory Parameters

Wallet (Debit & Preauthorize)

Integration through ZIP Widget

The integration from the Gateway works by default through the redirect flow from ZipPayments. You can also integrate by using ZIP's Widget solution ("Lightbox Checkbout Library"), but you have to handle the Javascript part on your own. The Gateway returns you the following extraData values upon the initial Debit or Preauthorize call, which you will need for the ZIP Widget:

• zipId
• zipUri
• zipRedirectUri

You will have to use these values within the your HTTP endpoint which is called by the ZIP Widget:

{
  "id": "value of extraData.zipId",
  "uri": "value of extraData.zipUri",
  "redirect_uri": "value of extraData.zipRedirectUri"
}