Card payments
Transaction Flows
- iFrame Payment Form
- Full-Page Redirect
- payment.js Integration
Transaction types
- Register / Deregister
- Preauthorize / Capture / Void
- Debit
- Refund
- Recurring Debit/Preauthorize
- Chargebacks
Mandatory Parameters
- customer.identification
- customer.email
- customer.ipAddress
Additional Parameters
Banco Do Brasil
Transaction Flows
Transaction types
Mandatory Parameters
- customer.identification
- customer.firstName
- customer.lastName
- customer.billingAddress1
- customer.billingPostcode
- customer.billingCountry
- customer.email
- customer.nationalId (without special characters)
Additional Parameters
Country and Currency Restrictions
Countries
BR
Currencies
USD
- customer.billingCountry
- customer.firstName
- customer.lastName
none
Countries
BE
Currencies
EUR
Blik
Transaction Flows
Transaction types
Mandatory Parameters
- customer.billingCountry
- customer.firstName
- customer.lastName
Additional Parameters
none
Country and Currency Restrictions
Countries
PL
Currencies
PLN
Boleto
Transaction Flows
Transaction types
Mandatory Parameters
- customer.identification
- customer.firstName
- customer.lastName
- customer.billingAddress1
- customer.billingPostcode
- customer.billingCountry
- customer.email
- customer.nationalId (without special characters)
Additional Parameters
Country and Currency Restrictions
Countries
BR
Currencies
USD
Bradesco
Transaction Flows
Transaction types
Mandatory Parameters
- customer.identification
- customer.firstName
- customer.lastName
- customer.billingAddress1
- customer.billingPostcode
- customer.billingCountry
- customer.email
- customer.nationalId (without special characters)
Additional Parameters
Country and Currency Restrictions
Countries
BR
Currencies
USD
CashtoCode
Transaction Flows
Transaction Types
Mandatory Parameters
- customer.identification
- customer.firstname
- customer.lastname
- customer.billingCountry
- customer.birthDate
Additional Parameters
none
Country and Currency Restrictions
Countries
AT, DE, IT, UK
Currencies
EUR, GBP
Procedure
A personal URL will be "assigned" to you by CashtoCode which should
then be used for the connector configuration hostURL
Coingate
Transaction Flows
Transaction types
Additional Parameters
none
DirectCarrierBilling
Transaction Flows
Transaction types
Mandatory Parameters
Additional Parameters
| Parameter |
Description |
Example |
| customer.billingPhone |
to pre-fill phone number on payment page |
|
| extraData.promptContentArgs |
JSON-formatted. Sets the content of the payment SMS |
{"text":{"de":"Willkommen im Club!", "en":"Welcome to the club!"}} |
| extraData.promptImageArgs |
JSON-formatted. Link to additional images presented on payment pages. There can be multiple elements and the specific names depend on the actual used prompts. Contact Dimoco for the element names of your specific use case. |
{"album":{"pic":{"img":"http://.../mozart.png","alt":"Mozart"},"desc":{"de":"Amadeus"}},"track1":{"pic":{"img":"http://.../requiem.png","alt":"Requiem"},"desc":{"de":"Trauer"}}} |
| extraData.promptMerchantArgs |
JSON-formatted. Link to merchant's logo. The JSON object shall contain a logo element with img and alt properties that will be embedded in the user prompt pages. |
{"logo":{"img":"http://.../logo.jpg","alt":"Ring Store"}} |
| extraData.promptProductArgs |
JSON-formatted. Link to product image, and product description given in multiple languages. The JSON object shall contain a pic element with img and alt properties as well as a desc element providing the product names in different languages. For language codes refer to ISO 639-1. |
{"pic":{"img":"http://.../ring.jpg","alt":"The Ring"},"desc":{"de":"CoolerRing","en":"Cool Ring"}} |
| extraData.promptUrlArgs |
JSON-formatted. Definition of administration URLs presented on payment pages. |
{"agb":{"url":"http://.../agb.html"},"impressum":{"url":"http://.../impressum.html"}} |
EPS
Transaction Flows
Transaction types
Mandatory Parameters
- customer.billingCountry
- customer.firstName
- customer.lastName
Additional Parameters
none
Options Request
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.
Country and Currency Restrictions
Countries
AT
Currencies
EUR
Giropay
Transaction Flows
Transaction types
Mandatory Parameters
- ibanCustomer.billingCountry
- ibanCustomer.firstName
- ibanCustomer.lastName
- ibanCustomer.iban
- ibanCustomer.bic
Additional Parameters
none
Country and Currency Restrictions
Countries
DE
Currencies
EUR
iDeal
Transaction Flows
Transaction types
Mandatory Parameters
- customer.billingCountry
- customer.firstName
- customer.lastName
Additional Parameters
none
Country and Currency Restrictions
Countries
NL
Currencies
EUR
iSignThis
Transaction Flows
- iFrame Payment Form
- Full-Page Redirect
- payment.js Integration
Transaction types
Mandatory Parameters
- customer.identification
- customer.firstName
- customer.lastName
- customer.email
- customer.ipAddress
Itau
Transaction Flows
Transaction types
Mandatory Parameters
- customer.identification
- customer.firstName
- customer.lastName
- customer.billingAddress1 (for BR)
- customer.billingPostcode (for BR)
- customer.billingCountry
- customer.email
- customer.nationalId (without special characters)
Additional Parameters
- customer.birthDate
- customer.billingAddress1 (for CL)
- customer.billingPostcode (for CL)
Country and Currency Restrictions
Countries
BR, CL
Currencies
USD
Klarna Sofort
Transaction Flows
Transaction types
Mandatory Parameters
- customer.billingCountry
- customer.firstName
- customer.lastName
Optional Parameters
Additional Parameters
none
Country and Currency Restrictions
Countries
AT, BE, DE, ES, IT, NL
Currencies
EUR
Multibanco
Transaction Flows
Transaction types
Mandatory Parameters
- customer.billingCountry
- customer.firstName
- customer.lastName
Additional Parameters
none
Country and Currency Restrictions
Countries
PT
Currencies
EUR
MyBank
Transaction Flows
Transaction types
Mandatory Parameters
- customer.billingCountry
- customer.firstName
- customer.lastName
Additional Parameters
none
Country and Currency Restrictions
Countries
ES, GR, IT
Currencies
EUR
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
| Payment Method |
Transaction Flows |
Transaction Types |
| Neteller |
Full-Page Redirect |
Debit |
| Neteller |
false interaction |
Payout |
Additional Parameters
| Key |
Required |
Values |
Validation |
Description |
| Customer - Identification |
true |
string |
length<=150 |
Unique customer identification. The email address of the customer who is making or receiving the payment. |
| Transaction - Description |
true |
string |
length<=150 |
Description of the Item. |
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 |
| merchantSessionId |
|
Refer to PayPal documentation |
| isFinalCapture |
true, false |
Only for Capture transactions. Sending isFinalCapture = true will mark the capture as final on the PayPal side and subsequent captures won't be possible. Default value = false |
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
Transaction Flows
Transaction types
Mandatory Parameters
- customer.billingCountry
- customer.firstName
- customer.lastName
Additional Parameters
none
PayU
Transaction Flows
Transaction types
Mandatory Parameters
- customer.billingCountry
- customer.firstName
- customer.lastName
Optional Parameters
Additional Parameters
none
Country and Currency Restrictions
Countries
PL, CZ
Currencies
PLN, CZK
SEPA Direct Debit
Transaction Flows
Transaction types
- Debit
- Recurring Debit
- Refund
- Chargeback
Mandatory Parameters
- description
- additionalId1 (should contain your Purchase Order ID)
- additionalId2 (only for recurring transaction, should contain your Contract ID)
- ibanCustomer.firstName
- ibanCustomer.lastName
- ibanCustomer.iban
- ibanCustomer.mandateDate
- ibanCustomer.mandateId
Additional Parameters
none
Country and Currency Restrictions
Countries
All SEPA countries
FI, AT, BE, BG, ES, HR, CY, CZ, DK, EE, FI, FR, GF, DE, GI,
GR, GP, HU, IS, IE, IT, LV, LI, LT, LU, MT, MQ, YT, MC, NL,
NO, PL, PT, RE, RO, BL, MF, PM, SK, SI, ES, SE, CH, GB
Currencies
EUR
SEPA Direct Debit PLUS
Transaction Flows
- iFrame or Full-Page Redirect
Transaction types
- Register
- Debit
- Recurring Debit
- Refund
- Chargeback
Mandatory Parameters
- description
- additionalId1 (should contain your Purchase Order ID)
- additionalId2 (only for recurring transaction, should contain your Contract ID)
- customer.firstName
- customer.lastName
Additional Parameters
For Register transactions:
- extraData.checkAmount (e.g.
9.99)
- extraData.checkCurrency (e.g.
"EUR")
Providing these data fields, the system automatically verifies on the customer's bank account if the required balance is available.
In case the balance is lower than the required amount, the Register transaction will fail with an Insufficient funds error.
Country and Currency Restrictions
Countries
All SEPA countries
FI, AT, BE, BG, ES, HR, CY, CZ, DK, EE, FI, FR, GF, DE, GI,
GR, GP, HU, IS, IE, IT, LV, LI, LT, LU, MT, MQ, YT, MC, NL,
NO, PL, PT, RE, RO, BL, MF, PM, SK, SI, ES, SE, CH, GB
Currencies
EUR
SEPA Credit Transfer
Transaction Flows
Transaction types
Mandatory Parameters
- description
- additionalId1 (should contain your Credit Statement ID)
- ibanCustomer.firstName
- ibanCustomer.lastName
- ibanCustomer.iban
- ibanCustomer.mandateDate
- ibanCustomer.mandateId
Additional Parameters
none
Country and Currency Restrictions
Countries
All SEPA countries
FI, AT, BE, BG, ES, HR, CY, CZ, DK, EE, FI, FR, GF, DE, GI,
GR, GP, HU, IS, IE, IT, LV, LI, LT, LU, MT, MQ, YT, MC, NL,
NO, PL, PT, RE, RO, BL, MF, PM, SK, SI, ES, SE, CH, GB
Currencies
EUR
Rapi Pago
Transaction Flows
Transaction types
Mandatory Parameters
- customer.identification
- customer.firstName
- customer.lastName
- customer.billingCountry
- customer.email
- customer.nationalId (without special characters)
Additional Parameters
- customer.birthDate
- customer.billingAddress1
- customer.billingPostcode
Country and Currency Restrictions
Countries
AR
Currencies
USD
Skrill
Transaction Flows
Transaction types
Debit
| Parameter |
Required |
Description |
| successUrl |
true |
Redirect url after the payment process |
| cancelUrl |
true |
Redirect url when cancelling payment process |
| extraData.companyName |
false |
Display name on the payment page |
Payout
| Parameter |
Required |
Description |
| customer.email |
true |
Email of recipient |
| extraData.subject |
true |
Subject of the notification email (250 1-byte characters) |
| extraData.note |
true |
Comment to be included in the notification email (max 2000 1-byte characters) |
Refund
| Parameter |
Required |
Description |
| referenceTransactionId |
true |
ID of the transaction which should be refunded |
Partial refund is supported.
Trustly
Transaction Flows
Transaction types
Mandatory Parameters
- customer.identification
- customer.billingCountry
- customer.firstName
- customer.lastName
Optional Parameters
- customer.ipAddress
- customer.nationalId (without special characters)
Additional Parameters
none
Country and Currency Restrictions
Countries
DE, DK, EE, ES, FI, IT, NL, NO, PL, SE, GB
Currencies
EUR, DKK, NOK, PLN, SEK, GBP
TrustPay
Transaction Flows
Transaction types
Mandatory Parameters
- customer.billingCountry
- customer.firstName
- customer.lastName
Additional Parameters
none
Country and Currency Restrictions
Countries
CZ, SK
Currencies
CZK, EUR
Pago Facil
Transaction Flows
Transaction types
Mandatory Parameters
- customer.identification
- customer.firstName
- customer.lastName
- customer.billingCountry
- customer.email
- customer.nationalId (without special characters)
Additional Parameters
- customer.birthDate
- customer.billingAddress1
- customer.billingPostcode
Country and Currency Restrictions
Countries
AR
Currencies
USD
Przelewy24
Transaction Flows
Transaction types
Mandatory Parameters
- customer.email
- customer.billingCountry
- customer.firstName
- customer.lastName
Additional Parameters
none
Country and Currency Restrictions
Countries
PL
Currencies
PLN, EUR
Qiwi Wallet
Transaction Flows
Transaction types
Mandatory Parameters
- description
- successUrl
- callbackUrl
- customer.firstName
- customer.lastName
- customer.billingCountry
- customer.billingPhone
Additional Parameters
none
Country and Currency Restrictions
Countries
RU, KZ, UA
Currencies
EUR, KZT, RUB, USD
Verkkopankki (Finnish Online-Bank Transfer)
Transaction Flows
Transaction types
Mandatory Parameters
- customer.billingCountry
- customer.firstName
- customer.lastName
Additional Parameters
none
Country and Currency Restrictions
Countries
FI
Currencies
EUR
Wirecard
Transaction Flows
- iFrame Payment Form
- Full-Page Redirect
- payment.js Integration
Transaction types
- Debit
- Register
- Preauthorize
- Capture
- Void
- Refund
- Deregister
Mandatory Parameters
none
Additional Parameters
none
Risk-Check Only
For this kind of connector you submit a transaction just like a normal transaction,
but in fact no real money flow will occur.
The result tells you whether this transaction has passed the risk checks or not.
(SUCCESS or ERROR with code 2013)
Transaction Flows
Transaction types
Mandatory Parameters
The mandatory parameters depend on your individual merchant configuration
Additional Parameters
none
Restricted Countries for all payment methods
- Afghanistan
- Iran
- Sudan South
- Belarus
- Iraq
- Syria
- Burundi
- Korea (North)
- Trinidad & Tobago
- Bosnia & Herzegowina
- Laos
- Tunisia
- Central African Republic
- Lebanon
- Uganda
- Crimea
- Libya
- Vanuatu
- Cuba
- Nicaragua
- Yemenia
- Darfur
- Somalia
- Zimbabwe
- Democratic Republic Congo
- Sri Lanka
- Guyana
- Sudan