NAV Navbar
  • Simulator (Testing connector)
  • Adyen
  • AmazonPayments
  • ApplePay
  • Authorize.net
  • BillPay
  • Braintree
  • Cardeta
  • CashFlows
  • CheckoutCom
  • CKB
  • Clearhaus
  • CM
  • CoinGate
  • Credorax
  • Dalenys
  • Dimoco
  • dLocal
  • EasyPay (ePay.bg)
  • Ecommpay
  • EmerchantPay
  • ESR / SwissQR Bill
  • expressÜberweisung
  • Finance Wide
  • Finrax
  • FinTecSystems
  • Fortumo
  • GiroSolutions
  • GooglePay™
  • Ingenico Connect
  • iSignThis
  • Kalixa
  • Kassa Compleet
  • Klarna
  • Mastercard Payment Gateway Services
  • MasterPayment
  • MocoPay
  • Mollie
  • MultiSafePay
  • Neteller
  • NMI (Network Merchants Integrated)
  • Ochapay
  • Pago46
  • Paymentwall PCI
  • Paymentwall
  • PayOn
  • PayPal
  • Paysafecard
  • Powercash21
  • PPRO
  • Qualpay
  • SafeCharge
  • SecureTrading
  • SepaExpress
  • Shimotomo
  • Skrill
  • Sofort
  • Spreedly
  • Stripe
  • TECS
  • TNG
  • Truevo
  • Trustly
  • WeAccept
  • Wirecard
  • Worldpay
  • Worldpay Access
  • Worldpay Express
  • Zip Payments
  • 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

    Brand Number Result
    Visa 4111 1111 1111 1111 Success
    Visa 4242 4242 4242 4242 Failure
    Mastercard 5555 5555 5555 4444 Success
    Mastercard 5105 1051 0510 5100 Failure

    Direct Debit IBANs

    You can use any IBAN you like.

    The last four digits will control the result:

    Last 4 digits Result
    1111 Success
    2222 Pending
    2003 Transaction Declined
    2006 Insufficient funds


    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.

    Extra data Value Result
    pendingOutcome success Status will change from pending to success
    pendingOutcome anyOtherString Status will change from pending to error

    Adyen

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration All
    AliPay Full-Page Redirect Debit, Refund
    Giropay Full-Page Redirect Debit, Refund
    EPS Full-Page Redirect Debit, Refund
    DirectDebit Full-Page Redirect Debit, Refund
    iDeal Full-Page Redirect Debit, Refund
    Dotpay Full-Page Redirect Debit, Refund
    DragonPay Full-Page Redirect Debit, Refund
    Boleto Full-Page Redirect Debit, Refund
    Bancontact Full-Page Redirect Debit, Refund
    Qiwi Full-Page Redirect Debit, Refund
    Sofort Full-Page Redirect Debit, Refund
    UnionPay Full-Page Redirect Debit, Refund
    WeChatPay Full-Page Redirect Debit, Refund

    Additional parameters

    none

    AmazonPayments

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    AmazonPayments payment.js All

    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:

    <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:

    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

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form All

    Additional Parameters

    none

    BillPay

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    DirectDebit Server-To-Server Register, Debit, Refund
    Invoice Server-To-Server Register, Debit, Refund

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

    Mandatory parameters

    Extra data Mandatory Description
    Description No Description that should be shown on the bank statement
    extraData.expectedDaysTillShipping Yes integer in days
    extraData.shippingMethod Yes any string
    extraData.itemIdentification For Register any string, used as articleId
    extraData.itemName For Register any string, used as articleName
    customer.identification Yes
    customer.firstName Yes
    customer.lastName Yes
    customer.email Yes
    customer.billingAddress Yes all address details
    customer.birthDate Yes e.g. 1980-01-01
    customer.iban Yes for DirectDebit
    customer.extraData.salutation Yes Mr., Mrs., Hr., Fr., etc.
    customer.extraData.type Yes guest, existing or new
    items Yes at least one item
    extraData.paymentType No one of invoice, directDebit - overrules configuration
    extraData.shippingPriceNet No decimal
    extraData.shippingPriceGross No decimal
    extraData.rebateNet No decimal
    extraData.rebateGross No decimal
    extraData.orderAmountNet No decimal
    extraData.shippingTrackingNumber No string
    customer.extraData.title No string
    customer.extraData.copmanyLegalForm No string
    customer.extraData.companyHolderName No string
    customer.extraData.companyTaxNumber No string
    item.extraData.category No string
    item.extraData.subcategory1 No string
    item.extraData.subcategory2 No string
    item.extraData.priceNet No string

    Braintree

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    PayPal payment.js All

    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:

    <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 Ixopay via the transactionToken parameter
            //send deviceData to Ixopay via the extraData.deviceData parameter if the parameter 'gatherDeviceData' was set to true
        }
    
        var paypalOptions = {
            amount: "9.99",
            currency: "EUR"
        };
    
        payment.initBraintreePaypal(
            'public-integration-key',
            'paypal-button-div',
            false, // gatherDeviceData, set true for merchant initiated card-on-file transactions
            completeHandler,
            errorHandler,
            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:

    Key Description
    merchantAccountId The merchant account ID used to create a transaction, which also defines the currency. If not given, the default merchant account ID is used.
    deviceData Only required for Card-On-File transactions. Use device data returned by the completeHandler.

    Customer ExtraData Parameters:

    Key Description
    fax Refer to Braintree documentation
    phone Refer to Braintree documentation
    website Refer to Braintree documentation
    billingCompany Refer to Braintree documentation
    billingFirstName Refer to Braintree documentation
    billingLastName Refer to Braintree documentation

    Customer Identification Mandatory

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

    Cardeta

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard Server-To-Server Debit, Register, Preauthorize, Capture, Refund, Deregister, Recurring Debit/Preauthorize


    Additional Mandatory Parameters

    Parameter Required Description
    customer.billingPhone Yes Customer phone number
    customer.email Yes Customer email address

    CashFlows

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard (without 3DS) iFrame Form & payment.js Integration All

    Additional parameters

    Extra data Mandatory Description
    Customer - Address yes (for AMEX)
    Customer - City yes (for AMEX)
    Customer - State yes (for AMEX)
    Customer - ZIP yes (for AMEX)
    Customer - Country yes (for AMEX)
    Customer - Email yes (for AMEX)
    Customer - IP yes (for AMEX)

    CheckoutCom

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration Debit, Register, Preauthorize, Capture, Void, Refund, Deregister

    Additional Parameters

    none

    CKB

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard Server-To-Server Debit, Preauthorize, Capture, Refund, Void


    Additional Parameters

    Parameter Required Description
    extraData.cardExpirationDay No Expiration day of the card. Defaults to end of month if not set.
    extraData.udf1 No User defined field.
    extraData.udf2 No User defined field.
    extraData.udf3 No User defined field.
    extraData.udf4 No User defined field.
    extraData.udf5 No User defined field.

    Clearhaus

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration All
    ApplePay Server-to-Server Debit, Preauthorize, Capture, Void, Refund

    Additional Parameters

    none

    CM

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Direct Carrier Billing (SMS) Server-to-Server Debit only

    Additional parameters

    Extra data Mandatory Description
    from Yes Originators of the message
    alphanumeric: max length 11 characters
    numeric: max length 17 characters (must start with 00), e.g. 0031 for Netherlands
    body Yes Message to be sent
    alphanumeric: max 160 characters
    type Yes TEXT or BINARY
    to Yes Recipient MSISDN
    including country code, e.g. 0031
    tariff No End user tariff
    0-3 decimals
    header No User data header of binary message
    (Do not add length byte at start)
    operator No Mobile Country Code / Mobile Network Combination

    CoinGate

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    BitCoin Full-Page Redirect Debit

    Additional Parameters

    none

    Credorax

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration All

    Additional Parameters

    Creditcard

    Dalenys

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Credit card payment.js, Redirect & iFrame Form all

    Additional Parameters

    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

    Payment Method Transaction Flows Transaction Types
    Direct Carrier Billing (SMS) Redirect & iFrame Form Debit only
    Credit card payment.js, Redirect & iFrame Form all
    EPS Redirect Debit only

    Additional Parameters

    none

    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

    Payment Method Transaction Flows Transaction Types
    Credit card iFrame Form & payment.js Integration Debit, Preauthorize, Capture, Void, Register, Deregister, Refund
    BankTransfer Full-Page Redirect Debit, Payout
    Abitab Full-Page Redirect Debit
    Baloto Full-Page Redirect Debit
    Boleto Full-Page Redirect Debit
    Cash Full-Page Redirect Debit
    Davivienda Full-Page Redirect Debit
    Efecty Full-Page Redirect Debit
    Oxxo Full-Page Redirect Debit
    PagoEfectivo Full-Page Redirect Debit
    PagoExpress Full-Page Redirect Debit
    PagoFacil Full-Page Redirect Debit
    RapiPago Full-Page Redirect Debit
    RedPagos Full-Page Redirect Debit

    Additional Parameters

    Credit card

    Field Mandatory
    customer.firstName Yes
    customer.lastName Yes
    customer.billingCountry Yes
    customer.nationalId Yes
    customer.billingAddress1 Yes in India

    Note: 3D-Secure behaviour is dependent on dLocal's configuration


    APM & BankTransfer

    Field Mandatory
    customer.firstName Yes
    customer.lastName Yes
    customer.email Yes
    customer.nationalId Yes
    extraData.bank_id Optional (see Options Request below)

    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

    Payment Method Transaction Flows Transaction Types
    Creditcard Full-Page Redirect Debit
    EasyPay Full-Page Redirect & Server-to-server Debit

    Additional Parameters

    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

    Payment Method Transaction Flows Transaction Types Supported Currencies
    Alipay Redirect Debit, Refund* ** AUD, CAD, CNY, EUR, GBP,
    HKD, JPY, SGD, USD
    China Union Pay (CUP P2P) Redirect Debit, Payout* CNY
    DOKU Wallet Redirect Debit, Payout* IDR
    Nganluong Wallet Redirect Debit, Payout* VND
    Bank Transfer Indonesia Redirect Debit, Payout* IDR
    Bank Transfer Malaysia Redirect Debit, Payout* MYR
    Bank Transfer Philippines Redirect Debit, Payout* PHP
    Bank Transfer Korea Redirect Debit, Payout* KRW
    Bank Transfer Thailand Redirect Debit, Payout* THB
    Bank Transfer Vietnam Redirect Debit, Payout* VND
    Bank Transfer Vietnam QR Redirect Debit VND

    *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

    Extra data Mandatory Description
    Customer - Identification Yes Unique customer identification,
    should be used on multiple payments if it is the same customer
    Customer - First name Yes For Korea: the name entered needs to be the same as the account holder
    Customer - Last name Yes For Korea: the surname entered needs to be the same as the account holder
    Customer - EMail Yes
    Customer - Phone No
    Customer - Country No
    Customer - City No
    Customer - State No
    Customer - Postcode No
    Customer - National Id No

    Additional parameters for BankTransfer Payout

    Extra data Mandatory Description
    Customer - Identification Yes Unique customer identification,
    should be used on multiple payments if it is the same customer
    Customer - First name Yes
    Customer - Last name Yes
    Customer - EMail Yes
    Customer - IP Address Yes
    extraData.account_number Yes Customer account number
    extraData.bank_id Yes Bank identifier*
    extraData.bank_branch Yes Bank branch identifier
    extraData.bank_city Yes Bank branch city
    extraData.region_id Yes Region identifier**

    ** 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

    Extra data Mandatory Description
    Customer - Identification No Unique customer identification,
    should be used on multiple payments if it is the same customer
    Customer - First name No
    Customer - Last name No
    Customer - EMail No
    Customer - Phone No
    Customer - Country No
    Customer - City No
    Customer - State No
    Customer - National Id No

    Additional parameters for China Union Pay Payout

    Extra data Mandatory Description
    Customer - Identification Yes Unique customer identification,
    should be used on multiple payments if it is the same customer
    Customer - First name Yes
    Customer - Last name Yes
    Customer - IP Address Yes
    Customer - EMail Yes
    Customer - Phone Yes
    Customer - Address Yes
    Customer - Country Yes Need to be CN
    Customer - City Yes
    Customer - State Yes
    Customer - Postcode Yes
    extraData.bank_id Yes Bank identifier*
    extraData.bank_branch Yes Bank branch identifier
    extraData.bank_city Yes Bank branch city
    extraData.region_id Yes Region identifier**
    extraData.doc_number No Document number

    ** 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

    Extra data Mandatory Description
    Description Yes
    Customer - Ip Address Yes

    Additional parameters for Nganluong Wallet Payout

    Extra data Mandatory Description
    Customer - Identification Yes Unique customer identification,
    should be used on multiple payments if it is the same customer
    Customer - IP Address Yes
    extraData.account_number Yes

    Additional parameters for DOKU Wallet Payout

    Extra data Mandatory Description
    Customer - Identification Yes Unique customer identification,
    should be used on multiple payments if it is the same customer
    Customer - First name Yes
    Customer - Last name Yes
    Customer - EMail Yes
    Customer - IP Address Yes
    Customer - Phone Yes
    Customer - City Yes
    Customer - Country Yes
    Customer - Birthday Yes
    extraData.wallet_number Yes Customer account number
    extraData.doc_number Yes Document number
    extraData.doc_type Yes Document type
    extraData.doc_issue_country Yes An ISO 3166-1 (alpha-2) code of country that issued the document

    EmerchantPay

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration All
    SEPA Direct Debit iFrame Form & Server-to-server All

    Additional Parameters

    none

    ESR / SwissQR Bill

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    ESR Server-To-Server Debit

    Additional parameters

    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.

    expressÜberweisung

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    BankTransfer iFrame Payment Form Debit (no recurring)

    Additional parameters

    Extra data Mandatory Description
    checkAmount Required for risk check Amount to be checked against
    checkCurrency Required for risk check Currency, e.g. EUR
    checkBalanceOverview Not required If set to true, the current running total of the account will be returned
    checkChargebacks Not required If set to true, the number of detected chargeback transactions for the account will be returned
    checkName Required for name risk check Last name to be checked against. Both first and last name are required for the check
    checkFirstname Required for name risk check First name to be checked against. Both first and last name are required for the check
    checkAccountSnapshotDays Required for snapshot risk check if from and to date are not set Range in days which should be used (between 10 and 365)
    checkAccountSnapshotFrom Required for snapshot risk check if days are not set A date in the format yyyy-mm-dd
    checkAccountSnapshotTo Required for snapshot risk check if days are not set A date in the format yyyy-mm-dd
    checkAccountSnapshotFilters Not required An array of strings to filter the snapshot (e.g. ["income", "rent", "living-cost", "credit", "expenditure", "revenue", "salary"])
    checkAccountSnapshotAllAccounts Not required If set to true, returns snapshot for all accounts including their turnovers
    checkAccountSnapshotAllTags Not required If set to true, returns the full categorization of the turnovers in the snapshot

    Finance Wide

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration All (no recurring, CVV must be present)

    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

    Payment Method Transaction Flows Transaction Types
    BitCoin Full-Page Redirect Debit, Payout

    Additional Parameters

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

    Key Values Description
    withdrawCurrency BTC,ETH,XRP.. Cryptocurrency abbreviation that should be withdrawn
    targetAmountPolicy fiat, crypto Specifies if the targetAmount will be requested in fiat or crypto

    FinTecSystems

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    BankTransfer Full-Page Redirect Debit, Register

    Additional parameters

    Extra data Mandatory Description
    checkAmount Required for risk check Amount to be checked against
    checkCurrency Required for risk check Currency, e.g. EUR
    checkBalanceOverview Not required If set to true, the current running total of the account will be returned
    checkChargebacks Not required If set to true, the number of detected chargeback transactions for the account will be returned
    checkName Required for name risk check Last name to be checked against. Both first and last name are required for the check
    checkFirstname Required for name risk check First name to be checked against. Both first and last name are required for the check
    checkAccountSnapshotDays Required for snapshot risk check if from and to date are not set Range in days which should be used (between 10 and 365)
    checkAccountSnapshotFrom Required for snapshot risk check if days are not set A date in the format yyyy-mm-dd
    checkAccountSnapshotTo Required for snapshot risk check if days are not set A date in the format yyyy-mm-dd
    checkAccountSnapshotFilters Not required An array of strings to filter the snapshot (e.g. ["income", "rent", "living-cost", "credit", "expenditure", "revenue", "salary"])
    checkAccountSnapshotAllAccounts Not required If set to true, returns snapshot for all accounts including their turnovers
    checkAccountSnapshotAllTags Not required If set to true, returns the full categorization of the turnovers in the snapshot

    Fortumo

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Direct Carrier Billing (SMS) Redirect & iFrame Form Debit only

    Additional Parameters

    none

    GiroSolutions

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    GiroPay Full-Page Redirect Debit only
    EPS Full-Page Redirect Debit only

    Additional Parameters

    none

    GooglePay™

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

    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:

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

    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: <transactionToken>googlepay:{"signature":"...","intermediateSigningKey":{"signedKey":"{\"keyValue\":\"...\",\"keyExpiration\":\"...\"}","signatures":["..."]},"protocolVersion":"ECv2","signedMessage":"{\"encryptedMessage\":\"...\",\"ephemeralPublicKey\":\"...\",\"tag\":\"...\"}"}</transactionToken>

    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

    Supported Card Networks

    Ingenico Connect

    Payment Methods

    Payment Method Transaction Flows 3DSecure
    Creditcard / Global Collect iFrame Form & payment.js Integration 3DS, 3DSv2
    Creditcard / Ogone iFrame Form & payment.js Integration 3DS

    Required parameters

    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

    iSignThis

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration Debit only

    Additional parameters

    Kalixa

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Sofort Full-Page Redirect Debit
    Giropay Full-Page Redirect Debit
    EPS Full-Page Redirect Debit
    Przelewy24 Full-Page Redirect & iFrame Form Debit
    iDeal Full-Page Redirect Debit
    Creditcard iFrame Form & payment.js Integration All

    Additional Parameters

    Creditcard

    Kassa Compleet

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard Full-Page Redirect Debit only
    iDeal Full-Page Redirect Debit only

    Additional Parameters

    none

    Klarna

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Invoice Full-Page Redirect Debit, Authorize, Refund

    Additional Parameters

    none

    Mastercard Payment Gateway Services

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration Debit, Register, Preauthorize, Capture, Void, Refund, Deregister

    Additional Parameters

    Creditcard

    MasterPayment

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration All
    Sofortüberweisung Full-Page Redirect Debit only

    Additional Parameters

    none

    MocoPay

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Direct Carrier Billing (SMS) Redirect & iFrame Form Debit only
    PayByCall Redirect & iFrame Form Debit only

    Additional Parameters

    none

    Mollie

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard Full-Page Redirect All
    Paysafecard Full-Page Redirect All
    Bancontact Full-Page Redirect All
    Belfius Full-Page Redirect All
    KBC Full-Page Redirect All
    PodiumCadeaukaart Full-Page Redirect All
    Sofortüberweisung Full-Page Redirect All
    iDeal Full-Page Redirect All
    BankTransfer Full-Page Redirect All
    SEPA Direct Debit Full-Page Redirect All
    BitCoin Full-Page Redirect All

    Additional Parameters

    none

    MultiSafePay

    Following features has to be enabled from your Multisafepay Account Manager

    Payment Methods

    Payment Method Transaction Flows Transaction Types 3DS Versions
    Creditcard Full-Page Redirect, payment.js Integration All 3DSv1 with payment.js
    DotPay Full-Page Redirect All -
    GiroPay Full-Page Redirect All -
    Sofortüberweisung Full-Page Redirect All -
    iDeal Full-Page Redirect All -
    BankTransfer Full-Page Redirect All -
    SEPA Direct Debit Full-Page Redirect All -

    Additional Parameters

    none

    Neteller

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

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Neteller Full-Page Redirect Debit
    Neteller No interaction Payout

    Additional Parameters

    Key Mandatory Values Validation Description
    Customer - Identification true string length<=150 Unique customer identification.
    The email address of the customer who is making or receiving the payment.
    Transaction - Description true string length<=150 Description of the Item.

    NMI (Network Merchants Integrated)

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & Full-Page Redirect All

    Additional Parameters

    none

    Ochapay

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard Full-Page Redirect Debit only

    Additional Parameters

    none

    Pago46

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Pago46 Full-Page Redirect Debit

    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.

    Paymentwall PCI

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration All

    Recurring payments

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

    Additional Parameters

    Required Parameters

    Paymentwall

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard Full-Page Redirect Debit & Refund
    Bancontact Full-Page Redirect Debit & Refund
    Belfius Full-Page Redirect Debit & Refund
    Dotpay Full-Page Redirect Debit & Refund
    EPS Full-Page Redirect Debit & Refund
    Giropay Full-Page Redirect Debit & Refund
    iDeal Full-Page Redirect Debit & Refund
    KBC Full-Page Redirect Debit & Refund
    Multibanco Full-Page Redirect Debit & Refund
    MyBank Full-Page Redirect Debit & Refund
    POLi Full-Page Redirect Debit & Refund
    Przelewy24 Full-Page Redirect Debit & Refund
    SafetyPay Full-Page Redirect Debit & Refund
    Sofort/Klarna Full-Page Redirect Debit & Refund
    Boleto Full-Page Redirect Debit & Refund
    Oxxo Full-Page Redirect Debit & Refund

    Additional Parameters

    PayOn

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration All

    Additional Parameters

    none

    PayPal

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    PayPal Full-Page Redirect All

    PayPal Payment Types

    PayPal supports different kind of payments:

    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:

    Key Values Description
    paypalPaymentAction "Authorization", "Order", "Order_Auth", "Sale" Only for Preauthorize transactions. Defines "PaymentAction" for PayPal payments. "Order_Auth" automatically performs an Authorization for full amount after Order has been confirmed by customer
    addressOverride 0 or 1 Tells PayPal to use the shipping address you are providing instead of the customer's configured address in the PayPal account
    noShipping 0, 1, 2 0 = Display Shipping address, 1 = No Shipping address (digital goods), 2 = Use customer's configured shipping address
    noteToBuyer string a note displayed to the customer
    requiredConfirmShipping true, false Refer to PayPal documentation
    noShipping 0, 1, 2 0 = Display, 1 = No display, 2 = Buyers account
    allowNote true, false Refer to PayPal documentation
    localeCode Refer to PayPal documentation
    pageStyle Refer to PayPal documentation
    hdrImg Refer to PayPal documentation
    payflowColor Refer to PayPal documentation
    cartBoardColor Refer to PayPal documentation
    logoImg Refer to PayPal documentation
    solutionType "Sole", "Mark" Refer to PayPal documentation
    landingPageType "Billing", "Login" Refer to PayPal documentation
    channelType "Merchant", "eBayItem" Refer to PayPal documentation
    totalType "Total", "EstimatedTotal" Refer to PayPal documentation
    brandName Refer to PayPal documentation
    customerServiceNumber Refer to PayPal documentation
    giftMessageEnable Refer to PayPal documentation
    giftReceiptEnable Refer to PayPal documentation
    giftWrapEnable Refer to PayPal documentation
    giftWrapName Refer to PayPal documentation
    giftWrapAmount Refer to PayPal documentation
    buyerEmailOptInEnable Refer to PayPal documentation
    taxIdType Refer to PayPal documentation
    taxId Refer to PayPal documentation

    Items

    If submitting items, the following fields are Mandatory:

    Field
    quantity
    name
    price
    extraData -> category

    Item ExtraData Parameters:

    Key Values Description
    category Refer to PayPal documentation
    number Refer to PayPal documentation
    tax Refer to PayPal documentation
    weightValue Refer to PayPal documentation
    weightUnit Refer to PayPal documentation
    lengthValue Refer to PayPal documentation
    lengthUnit Refer to PayPal documentation
    widthValue Refer to PayPal documentation
    widthUnit Refer to PayPal documentation
    heightValue Refer to PayPal documentation
    heightUnit Refer to PayPal documentation

    Paysafecard

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Paysafecard Full-Page Redirect Debit, Refund

    Additional Parameters

    none

    Powercash21

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration Debit, Register, Preauthorize, Capture, Void, Refund, Deregister
    Trustly Full-Page Redirect Debit
    Trustly No interaction Payout, Refund

    Additional Parameters

    Creditcard

    Mandatory Parameters

    Trustly

    Parameter Mandatory
    customer.firstName yes
    customer.lastName yes
    customer.email yes (debit, payout)
    customer.billingCountry yes (debit)
    extraData.bankCountry required for payout if no reference transaction is provided
    customer.iban required for payout if no reference transaction is provided
    customer.birthDate required for payout if no reference transaction is provided

    PPRO

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    AstroPayCard Full-Page Redirect Debit
    AstroPayDirect Full-Page Redirect Debit & Refund
    BancoDoBrasil Full-Page Redirect Debit
    Bcmc Full-Page Redirect Debit & Refund
    Blik Full-Page Redirect Debit & Refund
    Boleto Full-Page Redirect Debit
    Bradesco Full-Page Redirect Debit
    DirectDebit Server-to-server Debit & Refund
    EPS Full-Page Redirect Debit & Refund
    Giropay Full-Page Redirect Debit & Refund
    IbanOnDemand Full-Page Redirect Debit & Refund
    iDeal Full-Page Redirect Debit & Refund
    InstantTransfer Full-Page Redirect Debit & Refund
    Itau Full-Page Redirect Debit
    Multibanco Full-Page Redirect Debit
    MyBank Full-Page Redirect Debit & Refund
    Oxxo Full-Page Redirect Debit
    PagoFacil Full-Page Redirect Debit
    Paypal Full-Page Redirect Debit & Refund
    Paysafecard Full-Page Redirect Debit
    POLi Full-Page Redirect Debit
    Przelewy24 Full-Page Redirect Debit & Refund
    Qiwi Full-Page Redirect Debit & Refund
    QiwiPayout Full-Page Redirect Debit
    Raberil Full-Page Redirect Debit & Refund
    RaberilPayout Full-Page Redirect Debit & Refund
    RapiPago Full-Page Redirect Debit
    SafetyPay Full-Page Redirect Debit & Refund
    SepaPayout Server-to-server Debit
    Skrill Full-Page Redirect Debit & Refund
    Sofort Full-Page Redirect Debit & Refund
    Teleingreso Full-Page Redirect Debit
    Trustly Full-Page Redirect Debit & Refund
    TrustPay Full-Page Redirect Debit
    Ukash Full-Page Redirect Debit & Refund
    Verkkopankki Full-Page Redirect Debit
    YellowPay Full-Page Redirect Debit & Refund

    Additional Parameters

    none

    Qualpay

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration Debit, Register, Preauthorize, Capture, Void

    Additional Parameters

    none

    SafeCharge

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration Debit, Register, Preauthorize, Capture, Void, Refund, Deregister
    AliPay Full-Page Redirect Debit only
    FastBankTransfer Full-Page Redirect Debit only
    Giropay Full-Page Redirect Debit only
    iDeal Full-Page Redirect Debit only
    Mistercash Full-Page Redirect Debit only
    Qiwi Full-Page Redirect Debit only
    Sofort Full-Page Redirect Debit only
    UnionPay Full-Page Redirect Debit only
    WeChatPay Full-Page Redirect Debit only

    Additional Parameters

    none

    SecureTrading

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form All
    Cash-To-Code iFrame Form Debit only

    Additional Parameters

    none

    SepaExpress

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    DirectDebit iFrame Form & Server-To-Server Debit, Register, Deregister, Refund
    CreditTransfer iFrame Form & Server-To-Server Payout

    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

    Shimotomo

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration Debit, Register, Preauthorize, Capture, Void, Refund, Deregister

    Additional Parameters

    Parameter Mandatory
    customer.identification Yes
    customer.firstName Yes
    customer.lastName Yes
    customer.billingAddress1 Yes
    customer.billingCity Yes
    customer.billingPostcode Yes
    customer.billingState Yes
    customer.billingCountry Yes
    customer.billingPhone Yes
    customer.email Yes
    customer.ipAddress Yes


    Creditcard

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

    Skrill

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Skrill Full-Page Redirect Debit, Refund, Payour

    Additional Parameters

    Key Values Description
    extraData.companyName string Display name on the payment page
    extraData.subject string for Payouts: Subject of the notification email (250 1-byte characters)
    extraData.note string for Payouts: Comment to be included in the notification email (max 2000 1-byte characters)

    Sofort

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Sofortüberweisung Full-Page Redirect Debit only
    iDeal Full-Page Redirect Debit, Refund*


    *Refund is only available in BE, NL

    Additional Parameters

    iDeal debit

    Parameter Required Description
    customer.bic Yes Bankcode of customer*
    customer.billingCountry Yes Customer country
    description Conditional Required if reason1 is not given, max. 27 characters
    extraData.reason1 Conditional Required if description is not given, max. 27 characters
    extraData.reason2 Optional Can be given additional to reason1, max. 27 characters. If both reasons are given, their total number of characters must not exceed 31 characters


    *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

    Parameter Required Description
    extraData.reason1 Optional max. 27 characters, if none given it uses the description of the initial transaction
    extraData.reason2 Conditional Can be given additional to reason1, max. 27 characters. If both reasons are given, their total number of characters must not exceed 31 characters

    Spreedly

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration All

    Additional Parameters

    none

    Stripe

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard payment.js Integration All
    Giropay Full-page Redirect Debit
    iDeal Full-page Redirect Debit
    Sofort Full-page Redirect Debit
    Bancontact Full-page Redirect Debit
    DirectDebit Server-to-Server Register, Debit, Refund

    Additional Parameters

    none

    TECS

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard Server-To-Server Refund only

    Additional Parameters

    none

    TNG

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    TNG pushed by provider Debit

    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.

    Truevo

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration All

    Additional Parameters

    none

    Trustly

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Bank Transfer iFrame Form All
    iDeal iFrame Form All

    Additional parameters

    Extra data Mandatory Description
    Description No Description that should be shown on the bank statement
    Customer - Identification Yes Unique customer identification, should be used on multiple payments if it is the same customer
    Customer - First name Yes
    Customer - Last name Yes
    Customer - EMail Yes
    Customer - Billing Country Yes
    Customer - Billing Phone No
    Customer - IP Address No
    Customer - National ID No
    Customer - Shipping Country No
    Customer - Shipping Postcode No
    Customer - Shipping City No
    Customer - Shipping Address 1 No
    Customer - Shipping Address 2 No

    WeAccept

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Kiosk Server-to-Server Debit
    Cash Payment Server-to-Server Debit
    Wallet Redirect & iFrame Debit

    Additional parameters

    Extra data Mandatory Description
    first name (customer) Yes
    last name (customer) Yes
    email (customer) Yes
    billing phone (customer) Yes
    billingAddress1 (customer) only for cash payments
    billingPostcode (customer) only for cash payments
    billingCity (customer) only for cash payments *
    billingState (customer) only for cash payments *
    billingCountry (customer) only for cash payments
    success URL only for wallet payments To where the shopper should be back-directed

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

    Wirecard

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & payment.js Integration Debit, Register, Preauthorize, Capture, Void, Refund, Deregister

    Additional Parameters

    Creditcard

    Worldpay

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & Full-Page Redirect All
    iDeal Full-Page Redirect Debit & Refund

    Additional Parameters

    none

    Worldpay Access

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard iFrame Form & Full-Page Redirect All

    Additional Parameters

    Creditcard

    Parameter Required Description
    extraData.narrativeLine2 No Additional details about the payment e.g. order number, telephone number

    Worldpay Express

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Creditcard payment.js, Redirect & iFrame Form All

    Additional Parameters

    none

    Zip Payments

    Payment Methods

    Payment Method Transaction Flows Transaction Types
    Wallet Full-Page Redirect Debit, Preauthorize, Capture, Void, Refund

    Additional Parameters

    Wallet (Debit & Preauthorize)

    Parameter Type Description
    extraData.pickup 0 or 1 Whether this is a pickup order
    extraData.trackingUri string URI to tracking page of shipment
    extraData.trackingNumber string Tracking number of shipment
    extraData.trackingCarrier 0 or 1 Carrier used for shipment
    customer.extraData.title yes Title of customer (Mr., Mrs. etc.)
    item.extraData.type sku, tax, shipping or discoung Type of item
    item.extraData.item_uri string URI to product page
    item.extraData.image_uri string URI to product image (thumbnail)

    Mandatory Parameters

    Wallet (Debit & Preauthorize)

    Parameter Mandatory
    items yes
    customer.firstName yes
    customer.lastName yes
    customer.email yes
    customer.billingAddress1 yes
    customer.billingCity yes
    customer.billingPostcode yes
    customer.billingState yes
    customer.billingCountry yes

    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:

    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"
    }