Sofort (legacy)
Overview
Sofort is an alternative payment method that allows customers in Poland to perform purchases and issue refunds by using online banking. Purchases are performed by using Payment Page and Gate, refunds—by using Gate.
General information
Payment method type | Online banking |
---|---|
Countries and regions | AT, BE, CH, DE, ES, NL |
Payment currencies | EUR, CHF * |
Currency conversion | On ecommpay side |
Purchases | + |
Payouts | – |
Stored credentials payments | – |
Full refunds | + |
Partial refunds | + |
Chargebacks | – |
Notes | – |
Onboarding and access fee | Refer to your ecommpay key account manager |
* For exact information on available currencies refer to the ecommpay key account manager.
Interaction diagram
Payment processing by using the Sofort payment method requires merchant's web service, one of ecommpay interfaces, and the ecommpay payment platform, as well as Sofort service which supports interactions with banks.
Operations support
Interfaces | Amounts, EUR | |||||
---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | minimum | maximum | |
Purchases | + | – | – | – | 1.00 | 5,000.00 * |
Full refunds | – | – | + | – | – | – |
Partial refunds | – | – | + | – | – | – |
* Refer to your ecommpay key account manager for more information.
Processing scenarios
To perform a purchase operation, you need to redirect a customer to the Sofort service, while to initiate a refund, you need to receive a request from a customer via your web service and then notify the customer about funds crediting.
The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.
Purchase by using Payment Page
General information
In the Sofort method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ecommpay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Sofort method selected. For more information about preselecting payment methods, see in Preselecting payment methods.
The full sequence and particularities of the purchase process are provided below.
The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Sofort payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.
Request format
There are several things you need to consider when requesting a payment through the Sofort method:
- You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
- project_id—the project ID obtained from ecommpay
- payment_id—payment ID unique within the project
- payment_currency—payment currency in ISO-4217 alpha-3 format
- payment_amount—payment amount in minor units
- The currency of payment can only be EUR or CHF.
- To open Payment Page, pass the language code in the language_code parameter in the request for opening. For more information, see Interface language support.
- There are more mandatory parameters with customer details:
- customer_id—the unique ID of the customer within your project
- customer_country—country
- customer_first_name—first name
- customer_last_name—last name
- customer_email—email address
- If you need to have payment form displayed with the Sofort method selected, set the force_payment_method parameter to
sofort
. - If required, you can also add any other additional parameters Payment Page supports.
- After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.
Thus, a correct payment request in the Sofort method must include project, customer, and payment IDs, the currency and the amount of a payment in the appropriate currency, as shown in the following example:
For information about all parameters available in the Sofort method, see Parameters for opening payment form.
Callback format
The Sofort method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.
The following is the example of a callback with an information about successful 100,00 EUR
purchase on account 2626324568
in the 238
project.
Related topics
The following topics might be useful when implementing payments through Payment Page:
Purchases by using Gate
General information
In the Sofort methods, when processing a purchase by using Gate, the merchant web service is required to do the following:
- Send a request with all the required parameters and signature to the ecommpay URL.
- Perform the redirection of a customer to the Sofort service.
- Get the callback with the payment result from the payment platform.
The following diagram provides the detailed picture of the payment processing procedure.
The sections that follow discuss in more details the request format and the Gate parameters to use in the Sofort payment method and provide the information on the format of callbacks with purchase results.
Request format
There are several things you must consider when using purchase requests in the Sofort method:
- You perform refunds by sending the
/v2/payment/online-banking/sofort/sale/
request by using POST (HTTP) method. This is an online banking request group: /v2/payment/online-banking/{payment_method}/sale - The following objects and parameters must be specified in any request:
- Object general—general purchase information:
- project_id—project identifier
- payment_id—unique purchase identifier
- signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
- Object customer—customer information:
- id—the unique ID of the customer within your project
- country—country
- first_name—first name
- last_name—last name
- email—email address
- ip_address—IP address
- Object payment—purchase information:
- amount—purchase amount
- currency—payout currency in the ISO-4217 alpha-3 format.
- return_url—URL for customer returning from the bank site:
- return—site URL for returning
- Object general—general purchase information:
- The currency of payment can only be EUR or CHF.
- If required, you can also add any other additional parameters Gate supports.
Thus, a correct payment request in the Sofort method must include project, customer and payment IDs, customer data, currency and amount of the purchase, as shown in the following example:
Formats of the customer redirection data
To redirect a customer from the web service to the Sofort site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.
The following is the callback fragment containing the redirection data.
Callback format
The Sofort method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.
The following is the example of a callback with an information about successful 100.00 EUR
purchase from account 2626324568
made by the customer in the 239
project.
The following is the example of a callback for a purchase declined due to the inappropriate payment amount.
Related topics
The following topics might be useful when implementing payments through Gate:
Refunds by using Gate
General information
Sofort supports full and partial refunds processing by using Gate: merchant's web service sends a request with all the required parameters and signature to ecommpay URL, and receives a callback with the payment result. The full sequence of the refund process is provided below.
The sections that follow discuss in more details the request format and the Gate parameters to use in the Sofort payment method and provide the information on the format of callbacks with refund results.
Request format
There are several things you must consider when using refund requests in the Sofort method:
- You perform refunds by sending the
/v2/payment/online-banking/sofort/refund/
request by using POST (HTTP) method. This is an online banking request group: /v2/payment/online-banking/{payment_method}/refund - The following objects and parameters must be specified in any request:
- Object general—general payment information:
- project_id—project identifier
- payment_id—unique payment identifier
- signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
- Object customer—customer information:
- ip_address—customer IP address
- Object payment—refund information:
- description—comment or description
- amount—refund amount in minor units (mandatory for partial refund only)
- currency—refund currency in ISO-4217 alpha-3 format (mandatory for partial refund only)
- Object general—general payment information:
- If required, you can also add any other additional parameters Gate supports.
Thus, a correct refund request in the Sofort method must include project and payment IDs, customer IP address, currency and amount of the refund, as shown in the following example:
Callback format
The Sofort method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.
Here is an example of callback with an information about successful 100.00 EUR
refund for the customer account 2626324568
in the 238
project.
Here is an example of callback for a refund declined as the amount in the refund requested is greater than the amount in the initial payment.
Relates topics
The following topics might be useful when implementing payments through Gate:
Analysis of payments results
As with other payment methods ecommpay offers, when using the Sofort method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.
You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.
Also, you can export the information for further analysis by using third party analytical tools. The following options are available:
- Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
- Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.
If you have any further questions regarding payment data analysis, contact ecommpay technical support.