Simulator (Testing connector)

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

Test data

Credit cards

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

Extended 3D-Secure Testing

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

3DS 2.x Simulation

3DS 1.x Simulation

Direct Debit IBANs

You can use any IBAN you like.

The last four digits will control the result:

Example: AT00 0000 0000 0000 1111 => Successful transaction

Alternatively you may override the outcome via extra data extraData.outcome

Defining outcome will overrule the behaviour based on the last 4 digits of the given IBAN.

Example: AT00 0000 0000 0000 2222 + outcome = success => Successful transaction

Simulate pending status change

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

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

2C2P

Payment Methods

Mandatory Parameters

Additional parameters

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

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

AdvCash

Payment Methods

Account Verification

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

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

Adyen

Payment Methods

Additional parameters

Creditcard

Blik

Riverty

*Note: If customer.billingAddress1 is sent, following parameters should also be sent:

• customer.billingAddress2
• customer.billingCity
• customer.billingPostcode
• customer.billingCountry

If any of these parameters are missing, the shipping data will be used as billing data.

MB Way

Multibanco

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

Alignet

Payment Methods

Debit Parameters

Register Parameters

Alipay

Payment Methods

Additional Parameters

Debit (One-Off)

Recurring debit

Register

AlipayPlus

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

Payment Methods

Connector Config

Debit Parameters

Debit Customer Parameters

Debit Item Parameters

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

ConsultPayment Request

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

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

ConsultPayment Parameters

Request body

Request Body Example

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

Response

Example responses

success

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

error

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

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

AmazonPayments

Payment Methods

Integration guide

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

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

<script data-main="payment-js" src="https://gateway.tillpayments.com/js/integrated/payment.1.3.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>
  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>
    // 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>
  payment.tokenize(
    {}, //optional additional data
    function (token) {
      //Submit token to your server and perform transaction through Transaction API

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

Amazon Payment Services

Payment Methods

Mandatory Parameters

Optional Parameters

Additional Information

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

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

Apple Pay

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

Prerequisites

For processing transactions with Apple Pay 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 Apple Pay transactions acquire a Payment Token through your iOS App, or Apple Pay on the Web. (Refer to https://developer.apple.com/documentation/passkit & https://developer.apple.com/documentation/apple_pay_on_the_web).

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

Example:

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

ATOM

Payment Methods

Additional parameters

Authorize.net

Payment Methods

Additional Parameters

none

Banca Intesa

Payment Methods

Additional Parameters

Bank Of America

The Bank of America Adapter differs in its behavior from an ordinary Adapter. It does not directly communicate with any Bank of America provided Endpoint to process transactions. It is solely responsible for Transaction creation (and validation), to be processed later on with a so called Provider.

Please consult the official Bank of America NACHA File Spec User Guide for indepth information about individual Parameters.

Payment Methods

Connector Config

Transaction Parameters

Error Code Mapping

BDO

Payment Methods

Mandatory parameters for Debit

Beem

Payment Methods

Mandatory Fields

Additional Parameters (Conditional Mandatory)

BillPay

Payment Methods

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

Mandatory parameters

Bitpay

Payment Methods

Additional Parameters

Braintree CreditCard

A payment platform that gives you access to PayPal, Venmo (in the US), credit and debit cards plus the most relevant wallets and local payment methods in a single integration.

Supported features

Payment methods

The table below lists the payment methods that Braintree CreditCard supports. It also includes the available processing options and the supported transaction types for each of those payment methods.

Connector configuration

• To be able to use sendDescriptionInCustomField or sendMerchantTransactionIdInCustomField, you will have to set up "Custom Fields" in the Braintree Merchant Portal (please check out the official Braintree Documentation at Custom Fields).

  Add a new Custom Field and pass the Api Name of the field in the connector configuration (e.g merchant_tx_id for sendMerchantTransactionIdInCustomField).

• When useAvs is active, a request to Braintree's verifyCreditCard Service will be performed before charging the payment. The result of the verify call will be returned in the extraData.avs_result field. This will not affect the payment processing.

  In addition to activating that setting, you need to correctly set up the AVS options at Fraud Management in the Braintree Merchant Portal.

Mapping to Braintree CreditCard

This segment provides a comprehensive guide to effectively integrate Braintree CreditCard into your payment procedure. It offers a detailed mapping between the fields of the gateway and corresponding fields on the Braintree CreditCard side. Furthermore, it outlines the requisite fields which must be delivered per specific payment method and transaction type.

Parameters

Request mapping

Response mapping

Transaction indicators

Error codes

Braintree CreditCard error codes

Braintree CreditCard processor response legacy codes

Testing

While operating the Braintree CreditCard adapter in test mode, the following credit-card numbers can be used to examine various outcomes:

• Valid Card Numbers
• Card Numbers for Unsuccessful Verification
• Card Numbers with type Indicators
• Card Numbers with other Information
• Testing and Go Live

Miscellaneous

GooglePay via Braintree CreditCard currently only works with 3DS_CRYPTOGRAM tokens (via mobile phone application) and not with PAN_ONLY (via web).

For further information on how to process ApplePay and GooglePay see our docs at GooglePay and ApplePay.

Braintree PayPal

Payment Methods

Integration guide

Paypal

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.tillpayments.com/js/integrated/payment.1.3.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>
  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 parameter
    // send deviceData to us 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.

PayPal Pay Later

The integration for Pay Later works like the aforementioned normal PayPal integration. To enable Pay Later, usePayLater: true must be added to the PayPal options. Additionally, the flow parameter for the options must be set to checkout.

<script>
    var paypalOptions = {
        amount: "",
        currency: "",
        button: paypalButtonOptions,
        usePayLater: true,
        flow: 'checkout'
    };
</script>

Venmo

Braintree requires you to display the Venmo 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.tillpayments.com/js/integrated/payment.1.3.min.js"></script>

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

<div id="venmoButtonDiv">
  <svg width="280px" height="48px" viewBox="0 0 280 48" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
    <!-- Generator: Sketch 46.1 (44463) - http://www.bohemiancoding.com/sketch -->
    <title>svg/blue_venmo_button_active_280x48</title>
    <desc>Created with Sketch.</desc>
    <defs></defs>
    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
      <g id="blue_venmo_button_active_280x48">
        <rect id="Rectangle" fill="#1B74AE" x="0" y="0" width="280" height="48" rx="4"></rect>
        <g id="Group" transform="translate(98.000000, 16.000000)" fill="#FFFFFF">
          <path d="M14.1355722,0.0643062201 C14.6997229,0.996022242 14.9540614,1.95569119 14.9540614,3.16795034 C14.9540614,7.03443424 11.6533091,12.0572714 8.97435371,15.5842648 L2.85545503,15.5842648 L0.401435711,0.910859951 L5.75920168,0.402203543 L7.05667586,10.8432743 C8.26898429,8.86832019 9.76503373,5.76467606 9.76503373,3.64865382 C9.76503373,2.49041769 9.56660332,1.70150782 9.25650148,1.0519281 L14.1355722,0.0643062201 L14.1355722,0.0643062201 Z" id="Shape"></path>
          <path d="M21.0794779,6.525633 C22.0654018,6.525633 24.5475201,6.07462046 24.5475201,4.66393896 C24.5475201,3.98655114 24.0685351,3.64865382 23.5040948,3.64865382 C22.5165776,3.64865382 21.2206966,4.83281521 21.0794779,6.525633 L21.0794779,6.525633 Z M20.9665029,9.31947756 C20.9665029,11.0419863 21.924328,11.7177809 23.1941378,11.7177809 C24.5769225,11.7177809 25.9009024,11.3798836 27.6217431,10.505377 L26.9735853,14.9065874 C25.7611321,15.4989577 23.8715531,15.8942092 22.0374478,15.8942092 C17.3850512,15.8942092 15.7199738,13.0728462 15.7199738,9.545708 C15.7199738,4.97417302 18.4284766,0.120067244 24.0124822,0.120067244 C27.08685,0.120067244 28.8059526,1.84243114 28.8059526,4.24073451 C28.8062423,8.10707358 23.8437439,9.29152463 20.9665029,9.31947756 L20.9665029,9.31947756 Z" id="Shape"></path>
          <path d="M44.2677372,3.50758567 C44.2677372,4.07185827 44.1821369,4.89031424 44.0969712,5.42518557 L42.4892503,15.58412 L37.2722686,15.58412 L38.7387707,6.27159447 C38.7665799,6.01900427 38.8520354,5.51049269 38.8520354,5.22835639 C38.8520354,4.55096858 38.4288137,4.3819475 37.9199918,4.3819475 C37.2441697,4.3819475 36.5667543,4.69203673 36.1155786,4.918412 L34.4522393,15.5842648 L29.2058551,15.5842648 L31.6026627,0.374540282 L36.1433878,0.374540282 L36.2008892,1.58853744 C37.2721237,0.88319669 38.6827177,0.120356912 40.6841129,0.120356912 C43.3356936,0.120067244 44.2677372,1.47498771 44.2677372,3.50758567 L44.2677372,3.50758567 Z" id="Shape"></path>
          <path d="M59.7554481,1.78507694 C61.2496147,0.713885943 62.6604983,0.120067244 64.6058406,0.120067244 C67.2846511,0.120067244 68.216405,1.47498771 68.216405,3.50758567 C68.216405,4.07185827 68.1310944,4.89031424 68.0459287,5.42518557 L66.4400908,15.58412 L61.2216606,15.58412 L62.7161168,6.07476529 C62.7436363,5.82058192 62.8014274,5.51049269 62.8014274,5.31380835 C62.8014274,4.55111341 62.3780609,4.3819475 61.8693838,4.3819475 C61.2213709,4.3819475 60.5736477,4.6640838 60.0927798,4.918412 L58.4297302,15.5842648 L53.2126036,15.5842648 L54.7070598,6.07491013 C54.7345794,5.82072676 54.7906323,5.51063753 54.7906323,5.31395319 C54.7906323,4.55125824 54.367121,4.38209233 53.860182,4.38209233 C53.1829115,4.38209233 52.5069445,4.69218156 52.0557688,4.91855683 L50.3911259,15.5844097 L45.1464798,15.5844097 L47.5429977,0.374685116 L52.0282492,0.374685116 L52.1691783,1.64444329 C53.2126036,0.883486357 54.6220389,0.12064658 56.511473,0.12064658 C58.1474376,0.120067244 59.2185273,0.825552826 59.7554481,1.78507694 L59.7554481,1.78507694 Z" id="Shape"></path>
          <path d="M78.5990953,6.21583344 C78.5990953,4.97417302 78.288559,4.12761929 77.358688,4.12761929 C75.2997914,4.12761929 74.8770043,7.76743825 74.8770043,9.62942196 C74.8770043,11.0419863 75.2722719,11.9162033 76.2018532,11.9162033 C78.1479196,11.9162033 78.5990953,8.07767231 78.5990953,6.21583344 L78.5990953,6.21583344 Z M69.5751464,9.40463986 C69.5751464,4.60817794 72.1127383,0.120067244 77.9512273,0.120067244 C82.3505888,0.120067244 83.9587442,2.71679297 83.9587442,6.30099573 C83.9587442,11.0418415 81.4485271,15.9514186 75.4692539,15.9514186 C71.0415037,15.9514186 69.5751464,13.0446036 69.5751464,9.40463986 L69.5751464,9.40463986 Z" id="Shape"></path>
        </g>
      </g>
    </g>
  </svg>
</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
• Venmo 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>
  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 parameter
    // send deviceData to us via the extraData.deviceData parameter if the parameter 'gatherDeviceData' was set to true
  }

  const venmoLineItems = [];

  const venmoOptions = {
    totalAmount: '9.99',
    paymentMethodUsage: 'single_use', // multi_use,
    allowNewBrowserTab: false,
    allowDesktop: true,
    allowDesktopWebLogin: true,
    mobileWebFallBack: true,
    lineItems: venmoLineItems,
  };

  payment.initBraintreeVenmo(
    'public-integration-key',
    'venmoButtonDiv',
    true, // gatherDeviceData, set true for merchant initiated card-on-file transactions
    completeHandler,
    errorHandler,
    cancellationHandler,
    venmoOptions
  );
</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 required for Venmo 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:

Item Parameters:

Should be used to pass item details, so called "lineItems"

L2L3 Data Parameters:

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

Paypal Airline-Itinerary as Transaction ExtraData Parameters:

Braintree Documentation for AID.

Adding Legs to Transaction ExtraData Parameters

• Upto four legs can be added, each parameter for each leg can be added like this: leg.COUNT.parameter replacing COUNT with the number of leg and parameter with one of Legs Parameters. e.g adding parameter conjunctionTicket to first leg should be: leg.0.conjunctionTicket.

• Legs Parameters

Adding Additional Charges to Transaction ExtraData Parameters

• Multiple Additional Charges can be added, each parameter for each leg can be added like this: additional.COUNT.parameter replacing COUNT with the number of charge and parameter with one of Additional Charges Parameters.
• Additional Charges Parameters

Paypal STC ExtraData Parameters:

To add an STC parameter to extraData, start the name of the extraData field with stc. followed by the stc parameter. e.g: stc.sender_account_id.

IMPORTANT NOTE: setting Transaction Context must be activated on the merchant's Paypal Account

Braintree Local Payment Methods

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.tillpayments.com/js/integrated/payment.1.3.min.js"></script>

​2. Provide a DIV element on your page for the Local Payment Method button

<div id='localPaymentButtonDiv'></div>

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

• ID of the DIV element
• Javascript function to create a debit transaction and provide paymentId as transactionToken
• Javascript function to handle payment completion
• Javascript function to handle error events
• Javascript function to handle cancellation events
• Local Payment Method options (see examples below)

Example 1: Blik

<script>
  var payment = new PaymentJs('1.3');

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

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

  completeHandler = function (data) {
    // handle completed transaction
  }

  paymentIdHandler = function (paymentId) {
    // create a debit transaction including the paymentId in the request under the transactionToken parameter
  }

  let blikButtonDiv = document.getElementById('blikButtonDiv')

  var localPaymentMethodOptions = {
    paymentType: 'blik',
    amount: '9.99',
    currency: 'PLN',
    firstName: 'Max',
    lastName: 'Mustermann',
    email: '[email protected]', 
    address: { // NOTE: Address is optional. If present, then make sure it's complete and valid, otherwise the transaction will FAIL.
      streetAddress: 'Mokotowska 34',
      extendedAddress: 'Zlota Jesien 64',
      locality: 'Warsaw',
      postalCode: '02-697',
      countryCode: 'PL'
    },
    fallbackUrl: '[email protected]',
    fallbackButtonText: 'Please retry'
  };

  payment.initBraintreeLocalPayment(
    'public-integration-key',
    blikButtonDiv,
    paymentIdHandler,
    completeHandler,
    errorHandler,
    cancellationHandler,
    localPaymentMethodOptions
  );
</script>

Example 2: Blik Non-Redirect

<!-- Payment methods selection form fields-->

<!-- This field is mandatory. Id and name have to be  __blikToken.-->
<input type="hidden" name="__blikToken" id="__blikToken" />

<!-- This field is optional and is used to collect Blik code from the UI. Id of the element has to be blikCode. If present, then authCode does not need to be passed with localPaymentMethodOptions. -->
<input type="text" id="blikCode" name="blikCode"/>

<!-- This field is mandatory. It can be styled and is used for payment initiation.-->
<div id="blikButtonDiv"> </div>
<!-- end of HTML -->

<script>
  var payment = new PaymentJs('1.3');

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

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

  completeHandler = function () {
    // handle completed transaction
  }

  paymentIdHandler = function (paymentId) {
      // blikTokenElement has to be updated with paymentId so the transaction can be updated with it.
      var blikTokenElement = document.getElementById('__blikToken');

      blikTokenElement.value = paymentId;
  }

  let blikButtonDiv = document.getElementById('blikButtonDiv')

  var localPaymentMethodOptions = {
    paymentType: 'blik',
    amount: '9.99',
    currency: 'PLN',
    firstName: 'Max',
    lastName: 'Mustermann',
    email: '[email protected]', 
    address: { // NOTE: Address is optional. If present, then make sure it's complete and valid, otherwise the transaction will FAIL.
      streetAddress: 'Mokotowska 34',
      extendedAddress: 'Zlota Jesien 64',
      locality: 'Warsaw',
      postalCode: '02-697',
      countryCode: 'PL'
    },
    authCode: '123456', // Blik auth code from the Blik application
      // NOTE: authCode can also be automatically fetched from an element with an id 'blikCode'(example above). 
      // In this case, the localPaymentMethodOptions.authCode is not required.
  };

  payment.initBraintreeLocalPayment(
    'public-integration-key',
    blikButtonDiv,
    paymentIdHandler,
    completeHandler,
    errorHandler,
    cancellationHandler,
    localPaymentMethodOptions
  );
</script>

​4. After the end customer has completed the payment, we rely on incoming webhooks from Braintree. Therefore, it can take up to 2 minutes before we update the transaction status.

• Blik: The transaction is created with a pending_postback status during the payment process by calling paymentIdHandler().
• Blik Non-Redirect: The transaction is created with an await_redirect status during the payment process by calling paymentIdHandler(). Debit transaction result includes a redirectUrl parameter to Hosted payment page, where end customer should be redirected to.

Cardeta

Payment Methods

Additional Mandatory Parameters

CashFlows

Payment Methods

Additional parameters

Certegy

Payment Methods

Mandatory parameters for Debit and Preauthorize

Mandatory parameters for Register

CheckoutCom

Payment Methods

Additional Parameters

iDeal Debit

Bizum Debit

Payout parameters

Platform 1

On behalf of another person or business:

Platform 2

Destination

Sender

Misc

Account Funding Transfer parameters

Level 2 & 3 Data (Supported on Platform 2 only)

maximum of 50 item objects are allowed to be sent in a Level 3 Visa or Mastercard request American Express only supports Level 2 data maximum of 4 item objects are allowed to be sent in an American Express request

Result Extra Data for Credit Card

ChinaUMS H5

Payment Methods

Mandatory parameters for Debit

ChinaUMS C2B

Payment Methods

Additional Parameters for Debit

Additional Parameters for Refund

Result Extra Data

CKB

Payment Methods

Additional Parameters

Clearhaus

Payment Methods

Additional Parameters

none

CM

Payment Methods

Additional parameters

CMI

Payment Methods

Additional Parameters

CoinGate

Payment Methods

Additional Parameters

none

Cybersource PCI

Payment Methods

Adapter Config

The following fields are required depending on the used features:

General Transaction extraData

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

Capture Transactions

The following extraData fields are required for capture transactions:

Recurring Transactions

The following extraData fields are required for recurring transactions:

Debit/Authorization/Incremental Authorization Transactions

Decision Manager

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

Japan Payment Options

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.

DOKU

Payment Methods

Mandatory Parameters for Debit

Additional Parameters for Debit

Mandatory Parameters for Refund

Config Parameters

DOKU PCI

Payment Methods

Mandatory parameters for Register

Mandatory parameters for Preauthorize, Debit

Mandatory parameters for Capture, Refund, Void

Recurring transactions

All transactionIndicators within Doku including CARDONFILE_MERCHANT, RECURRING, CARDONFILE are associated with MOTO. for thes transactions, the optional parametersextraData.tenor and extraData.plan_id can be provided.

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 on country requirements).

Options Request

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

Debit - BankTransfer

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

Credit card - Installments

To make a payment using the installments make a Debit or Preauthorize request with extraData.installments param that stores the number of installment payments that customer chose to split the payment amount by. Optionally provide the id value of installment plan object inside extraData.installments_plan_id to secure the applicable installment rate.

To create an installment plan, you need to request it via the Options request identifier installmentsPlan. The returned value is installment plan object provided by dLocal (refer to dLocal's documentation on installment plans). It provides information of possible options for customer to split the payment by installments and the applicable installments rate.

Parameters

EasyPay (ePay.bg)

Payment Methods

Additional Parameters

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

EBANX PCI

Payment Methods

Credit Card

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

Additional Parameters

You will have to use the following extraData keys:

EBANX

Payment Methods

Additional Parameters

Debit: APM & BankTransfer

Refund: APM & BankTransfer

Payout: BankTransfer

Options Request

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

Retrieving a list of available banks

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

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

Ecommpay

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

As a 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

E-Comprocessing PCI

Payment Methods

Mandatory parameters for Debit, Debit with Register, Register

EmerchantPay

Payment Methods

Additional Parameters

none

Emerchantpay Genesis

Payment Methods

Mandatory parameters for Debit, Debit with Register, Register

Mandatory parameters for Recurring Debit

Mandatory parameters for Refund

Mandatory parameters for Payout

Supported countries

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

Emerchantpay Genesis PCI

Payment Methods

Mandatory parameters for Debit, Debit with Register, Register

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

FacilitaPay

Payment Methods

Parameters Register

Parameters Debit

Parameters Payout

Finance Wide

Payment Methods

Additional Parameters

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

Finaro

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Finrax

Payment Methods

Additional Parameters

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

FinTecSystems

Payment Methods

Additional parameters

Fiuu

Payment Methods

Additional parameters

Debit Parameters

Refund parameters

Fortumo

Payment Methods

Additional Parameters

none

GatewayHub

Payment Methods

Additional Mandatory Parameters

GiroSolutions

Payment Methods

Additional Parameters

none

GoCardless

Payment Methods

Mandatory Parameters for Debit with Register

Additional Parameters for Debit, Register

Additional Parameters for Refund

GooglePay™

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

Only GooglePay protocol version 2 (ECv2) is supported.

Prerequisites

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

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

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

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

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

Transaction Processing

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

Use the following parameters when sending a request to Google and replace YOUR_MERCHANT_ID with the GUID of your merchant:

gateway = "YOUR_GATEWAY_PARAMETER"
gatewayMerchantId = "YOUR_MERCHANT_ID"

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

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

Example XML:

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

Example JSON:

{
  "transactionToken": "googlepay:{\"signature\":\"...\", ...}\"}",
  ...
}

Card Parameters

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

Supported Card Authentication Methods

• PAN_ONLY
• CRYPTOGRAM_3DS

Supported Card Networks

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

HNCB - Hua Nan Commercial Bank

Payment Methods

Connector Config

Important Information (HNCB QR + Bank Transfer)

HNCB requires a strict format for the OrderNumber (also known as NoticeNumber in case of the Bank Transfer Payment Method) that is sent to them. The structure of this Number looks like : 5 chars (EnterpriseCode_BankTransfer_QR is automatically taken from the Connector Config) + 11 chars.

Our Gateway requires you to set up a Terminal to your Connector, which will autogenerate a STAN and add it as part of the OrderNumber.

Humm

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

Payment Methods

Additional Parameters

HiPay

Payment Methods

Mandatory parameters for Debit and Preauthorize

Aditional parameters Debit and Preauthorize

Mandatory parameters for capture and refund

Item Parameters

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

Hyp Yaad Pay PCI

Payment Methods

parameters for Register Preauthorize, Debit

parameters for Refund, Void

Ingenico Connect

Payment Methods

Required parameters for Sepa Direct Debit

• customer.billingCity: required for Register, Debit
• customer.billingCountry: required for Register, Debit
• customer.billingLastname: required for Register, Debit
• ibanCustomer.iban: required for Register, Debit
• transaction.description: required for Debit

Required parameters for Bank Transfer, Trustly and IDeal

• customer.identification
• customer.billingCountry

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 manager on Ingenico side.

TransactionIndicators

This applies only for the Payment Method SEPA Direct Debit For Register or withRegister transactions, IngenicoConnect Transaction Indicator will be set to "first"

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.

Test Cards

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

Jcc

Payment Methods

Mandatory Parameters

Additional Parameters

Item Parameters

JPM Commerce Platform PCI

Payment Methods

Additional parameters (Debit, Preauthorize, Register)

Capture parameters

MultiCaptureSequenceNumber and multiCaptureRecordCount are mandatory for multiple partial captures.

Result extra data

KakaoPay

Supported Payment Methods

Mandatory Debit parameters

Optional Debit parameters

Mandatory Refund & Partial-Refund parameters

References:

• KakaoPay Developer Documentation

Kalixa

Payment Methods

Additional Parameters

• 3D-Secure Verification Parameters

Kalixa Pci

Payment Methods

Mandatory Parameters (Debit, Preauthorize)

Kalixa InstoreCardDeposit

Payment Methods

Additional Parameters

Kassa Compleet

Payment Methods

Additional Parameters

none

Kcp Pc

Supported Payment Methods

Optional Debit parameters

Mandatory Refund & Partial-Refund parameters

Additional Postback ExtraData

References:

• KCP Developer Documentation ]

KCP Mobile

Supported Payment Methods

Mandatory Debit parameters

Optional Debit parameters

Mandatory Refund & Partial-Refund parameters

Additional Postback ExtraData

References:

• KCP Developer Documentation

  Khipu

Payment Methods

Connector Config

Debit Parameters

Options Request

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

Retrieving a list of available banks

Returns a list of available banks.

Please use bank-list as an option name e.g. POST /options/{apiKey}/bank-list.

Klarna

Klarna is a payment provider that offers its own payment methods, but also supports businesses by offering a large selection of the most popular payment methods on the market.

Supported features

We have two different implementations of the Klarna API in place.

KlarnaHPP

A full page redirect adapter. (See KlarnaHPP) documentation for more details)

KlarnaWidget

A payment widget solution. (See KlarnaWidget) documentation for more details)

Miscellaneous

Supported Countries and Currencies

KlarnaHpp

Klarna is a payment provider that offers its own payment methods, but also supports businesses by offering a large selection of the most popular payment methods on the market.

Payment Methods

Required Parameters

Connector Config

KlarnaWidget

Klarna is a payment provider that offers its own payment methods, but also supports businesses by offering a large selection of the most popular payment methods on the market.

Payment Methods

Connector Config

Integration Guide

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

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

<script data-main="payment-widget-js" src="https://gateway.tillpayments.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.tillpayments.com/api/v3/transaction/{apiKey}/prepare-(debit or preauthorize)

Prepare Transaction Parameters

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

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

<script>
  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 multistep checkouts. In a multistep 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>
  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 // or false (optional)
  );

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

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

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

Transaction Request Debit, Preauthorize, Capture

Transaction Parameters

Recurring Transactions

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

Klarna Partial Capturing / Release remaining authorization

Klarna supports partial capturing of created orders. Therefore, send a regular Capture call with the desired capture amount and the 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 a "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 sent on either order level oder item level. For further information about this topic please visit the official Klarna Documentation. We assume to receive the correct Discount relevant Data and won't apply any validation to it. If your send that Data don't fit the Klarna convention you might be served with a 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 as extraData.

Laybuy

The required currency is AUD (Australian dollar).

Payment Methods

Additional Parameters

Item

Additional parameters for Refund

LuxonPay

Payment Methods

Debit, Refund, Payout Parameters

Debit Customer Parameters

Mashreq CCAvenue PCI

Payment Methods

Mandatory Parameters

Mandatory Parameters for 3ds

Mandatory Parameters for followup transactions

Mastercard Payment Gateway Services

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Optional

Sub-Merchant fields (must be enabled for the account)

MasterPayment

Payment Methods

Additional Parameters

none

MercadoPago

Payment Methods

Additional Parameters

Device Data

When redirecting the user to a Payment Template - Hosted Payment Page (HPP), it's possible to collect their DeviceID and include it as a X-meli-session-id headers of the payment creation, refer to MercadoPago Documentation. Include the following script in the Hosted Payment Page (HPP):

  <script src="https://www.mercadopago.com/v2/security.js" view="checkout" output="deviceId"></script>

Then pass it in a new input field that has the name attribute name="deviceData" and the id must equal the output of the script:

<input type="hidden" id="deviceId" name="deviceData">

MocoPay

Payment Methods

Additional Parameters

none

Mollie

Payment Methods

Additional Parameters

none

MpGateway

The required currency is EUR (Euro).

Payment Methods

Additional Parameters

MpGateway Pci

Payment Methods

Additional Parameters

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

If you want to use Multisafepay SDD without redirect please activate "useDirectType" option on the connector.

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

Customer details verification

@ Customer details verification is used verify that the member's account information in the Neteller system corresponds to the member's information in Merchant system Customer verification is done with each Debit transaction

Parameters for Customer details verification

NETS

Payment Methods

Additional Parameters

Item Parameters

Config Parameters

Nexi

Payment Methods

Additional Parameters

NMI (Network Merchants Integrated)

Payment Methods

Additional Parameters

Direct Post API

• 3D-Secure Verification Parameters

Nuvei

Payment Methods

Mandatory Parameters

NuveiDCC

NuveiDCC adapter is used to proceed payments with Nuvei using DCC (Dynamic Curency Conversion) service.

Guideline

To use DCC service it's necessary to send requestDcc: "true" with your debit/preauthorize request. If DCC is allowed for the specific card you'll receive an API response with a status "PENDING_DCC" and all the necessary data to provide to the end customer to decide in which currency he/she wants to pay.

As soon as end customer decided which currency to use - you have to send an additional /continue-dcc API call

Mandatory Parameters

Nuvei PCI

Payment Methods

Mandatory Parameters

Mapping to Nuvei

VISA AFT Parameters

To enable VISA AFT both fields mentioned below are necessary. Additionally, it's required to set up a dedicated connector for the AFT transactions and check "Enable Account Funding Transactions" checkbox in the connector Vault Setup

Nuvei POS

Payment Methods

Additional Parameters

Ochapay

Payment Methods

Additional Parameters

none

Omipay

The required currency is AUD (Australian dollar).

Payment Methods

Additional Parameters

none

Oney

Payment Methods

Adapter Config

The following fields are mandatory:

Pre-Authorise: Additional Parameters

The following extraData fields are mandatory for the pre-authorization (purchase) request:

The following extraData fields are optional for the pre-authorization (purchase) request:

Refund & Void: Additional Parameters

Additional Information for Refund:

RULES FRANCE ONLY

• payment_amount field can contain a value lower than the initial payment.payment_amount value (sent with the payment request).
• Only one confirm call per payment is possible (the call cancels the rest of the order)
• Between 00h00 et 04h00 it is not possible to confirm an amount different from the original amount of the payment request.
• In case of error during partial or total confirm, the payment goes from FAVORABLE to REFUSED

RULES OTHER COUNTRIES (PT, RO, IT, BE, SP)

• payment_amount field can contain a value lower than the initial payment.payment_amount value (sent with the payment request).
• Several confirm call per payment are possible (no limit)
• The customer will be charged only when the total amount will be confirmed
• Each call must have an item_list according to the goods ready to be shipped.
• Each confirm call will generate a transfer to the merchant regarding the amount confirmed

The following extraData fields are mandatory for the refund request:

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

Paygate PCI

Payment Methods

Required Parameters

Optional Parameters

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 paid an agent an Options Request is required. Use payAgent as identifier and pass the adapter's transaction ID in the transaction parameter.

Paygate

Payment methods

Mandatory Parameters

Data Levels

ExtraData Parameters

ExtraData fields for different levels. If level is not mandatory then fields are also not required until you specify it.

If extraData value has [i] - it means that multiply object could be mapped. [i] - should always start with 1. It should be used even if you are mapping only one object.

Paygent

Adapter Configuration

Merchant ID and Hash Code Generation Key are provided by Paygent.

Payment Methods

Extra Data

Bank Transaction

• No extra data to add, but please notice that the customer first and last name and the company name must be in Japanese (none of them is mandatory to fill in), otherwise an error will happen.
• For multiple goods, add more Items, but notice only Item Name and Item Price are counted
• Bank Transfer accepts only JPY as a currency, and the amount should be an integer (decimals will be rounded to integers).

paylado

Payment Methods

Additional Parameters for Debit

Additional Parameters for Payout

Payline

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Payfacs parameters

Note: to enable sending of Payfacs parameters, please enable the "Enable Payfacs" setting on the connector.

• R = required
• O = optional
• C = conditional

PaymentsOS PayU

Payment Methods

Additional Parameters for Debit/Authorize

Creditcard

The following parameters are only required for One-off transactions or initial recurring transactions. On recurring transactions the value of the referenced transaction will be used if not explicitly set.

Netbanking

UPI

PayTM, PhonePe, PayZapp

Paymee

The required currency is TND (Tunisian dinar).

Payment Methods

Additional parameters

Debit Parameters

Paymentwall

Payment Methods

Additional Parameters

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

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)

Paynetics

Payment Methods

Additional Parameters for Preauthorize

Additional Parameters for Capture

Additional Parameters Register and Debit

PayOn

Payment Methods

Additional Parameters

Payone

Payment Methods

Additional Parameters for Preauthorize

Additional Parameters for Capture

Additional Parameters Register and Debit

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://{HOSTNAME}/backdirect/custom/{CONNECTOR-ID}.

Additional Information

In order to process via Payoneer you will have to generate unique ID that you register your clients with, this ID is known as the Payoneer Payee 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:

PayPal Complete Platform

Payment Methods

Integration guide

PayPal

PayPal 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.tillpayments.com/js/integrated/payment.1.3.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
• 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 PayPal Documentation for possible options. The 'vault' option is per default set to 'false' if not otherwise specified. Please refer to the PayPal Documentation for the different button options)
• Your server endpoint where prepareCall is implemented. It could either be prepare-debit/prepare-preauthorize/prepare-register based on the transaction type

PayPal options

<script>
  var paymentJs = new PaymentJs('1.3');

  errorHandler = function (error) {
      // If an error prevents buyer checkout, alert the user that an error has occurred with the buttons using the onError callback
  }

  cancellationHandler = function (data) {
      // When a buyer cancels a payment, they typically return to the parent page.
      // You can instead use the onCancel function to show a cancellation page or return to the shopping cart.
  }

  completeHandler = function (paypalToken) {
      // Captures the funds from the transaction and shows a message that tells the buyer the payment was successful.
      // The method is called after the buyer approves the transaction on the paypal.com website.
      // paypalToken should be passed to the debit request using extraData with the key 'paypalToken'

  }

  var paypalOptions = {
      button: {
          color: gold,
      },
      currency: "EUR",
      intent: "capture" || "authorize", // debit = capture / preauthorize = authorize
      vaultingWithoutPurchase: false // should be set to true if you're doing register call
      vault: false // should be set to true if you would like to vault transaction using PayPal vaulting. for example register / debit + withRegister=true
  };

  // Prepare Transaction
  var prepareCall = () => {
    return fetch('{MY_PREPARE_ENDPOINT}', {
      method: 'POST',
    }).then(function (res) {
      return res.json();
    }).then(function (data) {
      return data.orderID;
    });
  };

  paymentJs.initPaypal(
    'public-integration-key',
    'paypal-button-div',
    completeHandler,
    errorHandler,
    cancellationHandler,
    paypalOptions,
    prepareCall
  );
</script>

​4. You can now call the Transaction API with the extraData.paypalToken set to the paypalToken returned to the completeHandler.

Prepare Transaction

PayPal requires to create order/setup token when the PayPal button is being pressed. That's being handled with prepare-debit/prepare-preauthorize/prepare-register API calls. Therefore, you would need to implement prepareDebit call and provide your server endpoint initializing PayPal via PaymentJs.

When using the Hosted Payment Page option, the prepare call can be handled automatically on our side. E.g.

 prepareCall = function() {
    return fetch('', {
        method: 'POST',
        headers: {
            'Accept': 'application/json',
            'Content-Type': 'application/json'
        }
    }).then(function (res) {
        return res.json();
    }).then(function (data) {
        return data.orderID;
    });
}

Additional Prepare Transaction Parameters (CreateOrder)

One-click payment / Customer Initiated Transaction

To render One-click payment button you would need to do a prepareDebit/preparePreauthorize call to retrieve user-token-id that needs to be passed to paymentJs via paypalOptions.userIdToken.

Example API Request:

{
  "referenceUuid": "referenceUuid",
  "extraData": {
    "useReturnUserExperience": "true"
  },
  "transactionIndicator": "CARDONFILE"
}

Example API Response:

{
  "data": {
    "success": true,
    "returnType": "FINISHED",
    "widgetToken": "eyJraWQiOiJhMDRiMjEwZDYzYjU0NWQzODEwOWUxNDM3ZjQ3ZWYxMiIsInR5cCI6IkpXVCIsImFsZyI6IkVTMjU2In0.eyJpc3MiOiJodHRwczovL2FwaS5zYW3kYm94LasdasXBhbC5jb20iLCJzdWIiOiJDRVlINFVNUUpLMzM4IiwiYWNyIjpbImNsaWVudCJdLCJzY29wZSI6WyJCcmFpbnRyZWU6VmF1bHQiXSwib3B0aW9ucyI6eyJjdXN0b21lcl9pZCI6IklpUklSYWR1UEMifSwiYXoiOiJjY2cxOC5zbGMiLCJleHRlcm5hbF9pZCI6WyJQYXlQYWw6Q0VZSDRVTVFKSzMzOCIsIkJyYWludHJlZTozZG04NjdjdHJyZ3Y2Y2R3Il0sImV4cCI6MTcxNTcwNTEwNiwiaWF0IjoxNzE1NzA0MjA2LCJqdGkiOiJVMkFBSVA4NGprc3dfX1pYSHduR21KeVRQV003SkxzbFJLVlI2OHlxOEN4YmhHN1VWNkFWVVlyTTBqbXRyVEZmU3hBbjZKa0hlekNvSUtTdlZ6LUVpR1JxbVl4VWZaRHJOMDY1eXZQRkMySmgtQWkxaXNiV0xOWnh1MWJNa0VkdyJ9._s54YCC8MRqjllX2wDTmo4fQyTkUXl6_7aPOiNwBnVBJfLoQlwIZvtrkvgxU7RPBQy3uiRp-hhK4LGvwRC74CA"
  }
}

Items

If submitting items, the following fields are Mandatory:

Item Additional Parameters:

Additional Postback ExtraData

PayPal ACDC

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

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

​2. Provide an input field for the paypalToken which will be created later.

<input type="hidden" name="paypalToken" id="paypalToken" value="">

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

paymentJsPayPal.initPaypal(
  'the public integration key of your connector',
  {
    cardName: 'card-name-field-container',
    cardNumber: 'card-number-field-container',
    cardCvv: 'card-cvv-field-container',
    cardExpiry: 'card-expiry-field-container'
  },
  completeHandler,     <!-- your callback function for when the token has been created -->
  errorHandler,        <!-- your callback function in case of error -->
  cancellationHandler, <!-- your callback funciton in case of cancellation -->
  payPalOptions,       <!-- see PayPalOptions -->
  prepareCall          <!-- see prepareCall -->
);

completeHandler

The completeHandler callback will be called once the PayPal token has been created

Example

completeHandler = function (payPalToken) {
    // do things when the PayPal token is created
    console.log('done: ' + payPalToken);

    // set the PayPal token and submit
    <!-- important to name it paypalToken -->
    document.getElementById("paypalToken").value = paypalToken;
    document.getElementById("payment-form").submit();
}

prepareCall

The prepareCall must be implemented by you and is based on the transaction type: prepare-debit/prepare-preauthorize/prepare-register

Please refer to Prepare Transaction

When using the Hosted Payment Page option, the prepare call can be handled automatically on our side. E.g.

  prepareCall = function() {
      document.getElementById('loader').style.display = '';

      return fetch('{{ paypal.prepareCallEndpoint }}', {
          method: 'POST',
      }).then(function (res) {
          return res.json();
      }).then(function (data) {
          return data.orderID;
      });
  }

errorHandler, cancellationHandler

Here you may implement handling of scenarios for errors and user cancellations.

payPalOptions

Example

var paypalOptions = {
      currency: "EUR",
      intent: "authorize",
      vaultingWithoutPurchase: false,
      vault: false,
      style: {
          'input': {
              'font-size': '12px',
              'line-height': '1.7rem',
              'color': '#000',
              'padding': '5px',
              'appearance': 'none'
          },
          ':focus': {
              'padding': '5px',
              'outline': 'none'
          }
     }
};

​4. Trigger Payment with billing address data

Billing address data should be collected and submitted with the card data.

To trigger the payment you may use the paymentjs.trigger(data) function.

Example

document.getElementById('submit-btn').addEventListener('click', function (event) {
  event.preventDefault();
  paymentJs.trigger({
    billingAddress: {
      addressLine1: document.getElementById('card-billing-address-line-1').value,
      addressLine2: document.getElementById('card-billing-address-line-2').value,
      adminArea1: document.getElementById('card-billing-address-admin-area-line-1').value,
      adminArea2: document.getElementById('card-billing-address-admin-area-line-2').value,
      countryCode: document.getElementById('card-billing-address-country-code').value,
      postalCode: document.getElementById('card-billing-address-postal-code').value
    }
  });
});

Please note that billing address line 1 and country code are mandatory.

Paysafecard

Payment Methods

Required Parameters for Payout

If the transaction includes the parameter 'referenceUuid' the customer parameters will be extracted from the reference transaction if they are not explicitly provided.

PayTabs

Payment Method

Mandatory parameters for Debit

Additional parameters for Debit

Mandatory parameters for Refund

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

Redsys

Payment Methods

Additional Information

Be aware that there is a format restriction for the required Parameter DS_MERCHANT_ORDER, which represents the given MerchantTransactionId. The currently known max character limit is 12.

Please consult the official Redsys Api Documentation (available on request from Redsys)

CreditCard

Connector Config (Vault Setup)

Note: If the options Prioritize Description Field over MerchantTransactionId Field & Assign Timestamp to empty Description Field are enabled simultaneously the first 6 characters of the respective Transaction are appended to the timestamp to ensure uniqueness.

Parameter mapping

Bizum and BizumAPI

Connector Config

SideNote: The merchantTransactionId which has to be sent in the API request, must be between 4 and 12 Characters long to work for Bizum and BizumAPI.

Field Mapping For BizumAPI

possible values of exemptionIndicator

Sampath Bank Paycenter

Payment Methods

Optional Fields

Sampath Bank Shopping Mall

Payment Methods

SIA

Payment Methods

Scalapay

Payment Methods

Additional Parameters

Additional Information

It's mandatory to add items to the Debit and Preauthorize transactions where Item Description represents the "category", and the Item Identification represents the "sku" of the item.

SCB

Payment Methods

Additional Parameters

SecureTrading

Payment Methods

Additional Parameters

none

SepaExpressV2

Payment Methods

Depending on your setup SepaExpressV2 DirectDebit 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.

For SepaExpressV2 BankTransfer, you must use a full-page redirect instead.

Additional parameters for DirectDebit transactions

Additional parameters for BankTransfer transactions

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

Skrill

Payment Methods

Additional Parameters

Customer details verification

The customer verification service is used to check if a customer, identified by an email address, is registered with Skrill.

Parameters for Customer details verification

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

ACSS/Pre-Authorized debit ("PAD")

Prior to being able to charge the customer, the merchant must verify that the account is owned by the customer and obtain a mandate. This may be either achieved with a successful Register transaction or aDebit transaction with the withRegister flag set.

Additionally, the merchant is required to pass on the following data when trying to acquire the initial mandate.

For subsequent transactions, these data are not required anymore.

ACH

Prior to being able to charge the customer, the merchant must verify that the account is owned by the customer and obtain a mandate. This may be either achieved with a successful Register transaction or aDebit transaction with the withRegister flag set.

Additionally, the merchant is required to pass on the following data when trying to acquire the initial mandate.

For subsequent transactions, these data are not required anymore.

ACH Credit Transfer

In order to provision and retrieve a VBAN from Stripe, send a Register transaction. The bank data are included in the response object.

Creditcard

Postback Extra Data for Credit Card

Account Funding Transactions (AFTs)

Refer to: https://docs.stripe.com/payments/aft (page restricted; request access from Stripe)

For description of Stripe request fields refer to: https://docs.stripe.com/payments/aft/integration-guide (page restricted; request access from Stripe)

It's required to enable AFT transactions by marking "Enable Account Funding Transactions" checkbox in connector Config (for PCI connectors in Vault Setup).

Extended Authorization

Refer to https://docs.stripe.com/payments/extended-authorization

Postback/Response Extra Data for Extended Authorization

refer to https://docs.stripe.com/terminal/features/extended-authorizations

Example
  "extraData": {
      "charges.data.payment_method_details.card.extended_authorization.status": "enabled",
      "charges.data.payment_method_details.card.capture_before": 1732878746
  },

Straight2Bank

Payment Methods

Additional Parameters

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

Tabby

Payment Methods

Additional Parameters (Debit)

Additional Parameters (Refund)

TECS

Payment Methods

Additional Parameters

none

Tikkie

Payment Methods

Mandatory Parameters

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.

Transbank Webpay Plus

Payment Methods

TransferWise

Payment Methods

Additional Parameters

Additional Parameters depending on source and target currency

Depending on the source and target currency, different parameters may be necessary or different parameter values may be available. If your wanted currency is not listed, kindly contact support.

Truevo

Payment Methods

Additional Parameters

none

Trustly

Payment Methods

Additional parameters

TRUST Payments PCI

Payment Methods

Additional Parameters

Unzer

Payment Methods

Mandatory Parameters

Item

Optional ThreatMetrix Parameters

You can find more information about the ThreadMatrix script here: Unzer API docs

Additional Parameters for Installment

Options Request

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

Retrieving a list of available installment plans

Returns a list of available installment plans with the inquiryId

Please use installmentPlans as an option name e.g. POST /options/{apiKey}/installmentPlans.

Parameters

ValitorPayPci

Payment Methods

Additional parameters

WorldPay (Vantiv / Litle)

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Direct Debit (eCheckSales)

Debit

Refund & Void

VOLT

Payment Methods

Additional Parameters

Pix

BankTransfer

Options Request

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

Retrieving a list of available banks

Returns a list of available banks with there id that can be used for the bank_id

Please use bank-list as an option name e.g. POST /options/{apiKey}/bank-list.

BankList Parameters

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 a 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. For more details, consult with WeAccept

Wirecard

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Worldline/Ogone

Payment Methods

Mandatory Parameters

Optional Parameters

Additional Parameters for COF and ALIAS

Worldline/NPS PCI

Payment Methods

Mandatory Parameters

Optional Parameters

• 3D-Secure Verification Parameters

Connector Config

Second Merchant* :

The ability to set a second merchant can be required to test all Transaction types with one connector. This is caused by a limitation of the testing environment of the PSP. If you are able to do all you need with one merchant account, please do so. Otherwise, the second merchant will be used (if set) to do a register.

Worldpay

Payment Methods

Additional Parameters

none

Required Parameters for POLi

Required Parameters for Klarna

Worldpay Access

Payment Methods

Additional Parameters

Creditcard

• 3D-Secure Verification Parameters

Worldpay Express

Payment Methods

Additional Parameters

none

Worldpay WPG PCI

Payment Methods

Parameters

Additional AFT Parameters

Data of the sender account are taken from the customer object, everything else needs to be provided via extraData. Also see https://docs.worldpay.com/apis/wpg/manage/pull-from-card

*Required for transactions in Argentina, Bangladesh, Chile, Columbia, Jordan, Mexico, Thailand, UAE, India cross-border

Funding Transfer Type

Can be configured on the connector, sending extraData.fundingTransferType overwrites the configuration

Payment Purpose

Can be configured on the connector, sending extraData.paymentPurpose overwrites the configuration

Account Type

Result Extra Data

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

Zona Pagos

Payment Methods

Additional Parameters

ZonaPagos method

ZonaPagos method allows the user to select the payment method on the Zona Pagos hosted payment page. Which payment was selected is communicated through a webhook notification. The information can be found in extra_data under field id_forma_pago.

External Risk

Forter External Risk Adapter

Forter External Risk Check additional extra data

Those extra data fields are mapped to the corresponding Forter Validation Request Parameters: https://portal.forter.com/app/developer/api/api/services-and-apis/validation-api#request

Customer Extra Data

Example

{
  "customer": {
    "identification": "c0001",
    "extraData": {
      "FORTER_CUSTOMER_LAST_LOGINIP": "203.12.55.12",
      "FORTER_CUSTOMER_BILLING_ADDRESS_TYPE": "HOME"
    }
  }
}

Transaction Extra Data

Transaction Item Extra Data besides the standard item data

FraudNet External Risk Adapter

FraudNet External Risk Check additional extra data

Those optional extra data fields are mapped to the corresponding FraudNet Transaction Check Parameters and may help to get much more accurate risk score from the FraudNet: https://api-docs.fraud.net/docs/public-apis/395e4a8yfue3b-transaction-check

Required fields

Customer Extra Data

Transaction Extra Data

Transaction Extra Data related to seller

Transaction Extra Data related to device

Transaction Extra Data related to account

Transaction Extra Data related to credit card