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`

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

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)

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 - no recurring transactions

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

3D-Secure Verification Parameters

Dalenys

Payment Methods

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

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

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

Debits

firstName (Customer) (required)
lastName (Customer) (required)
email (Customer) (required)
nationalId (Customer) (required)
bank_id (extra data) (optional):
Providing the dLocal's bank identifier (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

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

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

expressÜberweisung

Payment Methods

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

Additional parameters

none

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.

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

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

iSignThis

Payment Methods

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

Additional parameters

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

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

3D-Secure Verification Parameters

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

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

Payment Methods

Payment Method	Transaction Flows	Transaction Types
Creditcard	Full-Page Redirect	All
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

Payment Methods

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

Additional Parameters

Key	Values	Description
extraData.productName	string	If this parameter is missing, the value of `description` will be used instead

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

3D-Secure Verification Parameters

Required Parameters

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

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

email (Customer)
productId
productName
successUrl
errorUrl

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:

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:

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

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

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

additionalId1: must contain the Order ID. One Order ID can contain more than one transaction! Relevant for SEPAexpress to detect the sequence of the transaction and for refunds.
additionalId2: for recurring transactions it must contain the Contract ID: A unique identifier of the user or contract of the user on merchant level. One Contract ID can contain more than one Order IDs! Relevant to detect the sequence of the transaction.
description: mandatory
customer.firstName: mandatory
customer.lastName: mandatory
customer.iban: mandatory (for Server-to-Server)
customer.bic: optional
customer.mandateId: mandatory
customer.mandateDate: mandatory

Make sure to use the ibanCustomer element within the XML instead of the normal customer object. The ibanCustomer contains the fields necessary for DirectDebit transactions

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

NOTE: the payment.js integration differs from the general implementation.
Stripe does not support to render card number and CVC/CVV fields in different DIV elements, but uses a standard widget to collect card data. Hence only the numberDivId will be considered, and the cvvDivId is ignored.

Additional Parameters

none

Wirecard

Payment Methods

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

Additional Parameters

none

Worldpay

Payment Methods

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

Additional Parameters

none