Sofort

Overview

Sofort is an banking payment method which allows to process payments in euros in several European countries. The ecommpay payment platform supports processing purchases made with the Sofort payment method. You can also perform refunds via payouts by using Payouts to bank accounts in SEPA as a complementary payment method.

Note:

Two technical implementations are currently supported for working with the Sofort method: the new one described in this section and the old one described in the section Sofort (legacy).

Details about the difference between these implementations and how to switch from the old implementation to the new one should be clarified with the ecommpay key account manager.

General information

Payment method type bank payments
Payment instruments
  • bank accounts
  • payments cards
Countries and regions AT, BE, DE, CH, ES, IT, NL, PL
Payment currencies EUR
Currency conversion on ecommpay side
Purchases +
Payouts –
Stored credentials payments –
Full refunds –
Partial refunds –
Chargebacks –
Notes
  • payment confirmation procedure may be used during purchase processing; contact your account manager to have this procedure set up
  • performing refunds via payouts is possible with the use of the complementary payment method Payouts to bank accounts in SEPA
Onboarding and access fee contact your ecommpay 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

To perform puchases by using the Sofort payment method you can use Gate and Payment Page interfaces. Keep in mind that amount limits and payment processing times depend on banks, that support purchases by using this payment method.

Processing scenarios

To perform a purchase operation, you need to redirect a customer to the Sofort service. Purchases can be processed in two ways: with payment confirmation procedure and without. This procedure may be useful when processing involves interaction with certain banks because payment processing on the side of the Sofort service and the banks can take up extended time (up to seven days or more) and initial confirmations of payments may subsequently be refuted.

Figure: Purchase processing by using Payment Page without the payment confirmation procedure



Figure: Purchase processing by using Payment Page with the payment confirmation procedure

Figure: Purchase processing by using Gate without the payment confirmation procedure



Figure: Purchase processing by using Gate with the payment confirmation procedure

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.

Payment confirmation procedure

The workflow of processing purchases made with Sofort implies participation of banks, and in certain cases, processing payments on the side of these banks and the Sofort service may take up considerable time (up to seven or more days). As a result, there can be situations when the earlier information about the payment's completion or decline contradicts the final result (for example, following a notification about a declined payment, the funds are credited to the recipient's account, or vice versa).

To ensure timely and correct notification of merchants regarding the status of payments in these cases, the ecommpay payment platform uses a payment confirmation procedure. When you integrate the Sofort payment method, discuss with your account manager the use of this procedure as well as switching of statuses of the payments with the confirmed declines to the reversed or decline status (to make monitoring and analysing payments more convenient).

The payment confirmation procedure is performed as follows: after the customer completes all required steps, the payment is processed on the Sofort service side while the customer is redirected to the payment interface where they receive the information about payment processing. The payment confirmation operation is created on the payment platform side while the payment status is set to awaiting confirmation until the information about payment confirmation is received from a service provider side and the corresponding payment status callback is sent to the web service.

The payment confirmation operation can have one of the following final statuses:

  • success—when the information about the crediting of funds to the recipient is received from a service provider side. In this case the payment status is set to success and the final callback containing the payment information is sent to the web service.
  • decline—when the information regarding the funds not being credited to the recipient is received from a service provider. In this case depending on the project settings, that were configured during integration, the following scenarios are available:
    • The reversal operation is initiated automatically and the payment platform sends the following callbacks successively: an intermediate callback, containing information about the funds not being credited and the final callback, containing the information about the purchase refund and the reversed payment status.
    • The payment status is set to decline and the final callback with information that purchase was declined is sent from the payment platform to the web service.

When using this procedure, you can also monitor payment statuses in the Dashboard interface.

Using payment confirmation via Payment Page and Gate is described in the corresponding sections of this article. If you have any additional questions regarding this procedure, contact the ecommpay specialists.

Purchase by using Payment Page

General information

Depending on processing the payment confirmation procedure, purchase processing by using Payment Page can involve additional actions. Generally, 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 one or more callback 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 Preselecting payment methods.



Figure: The purchase processing by using Payment Page steps without the payment confirmation procedure

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ecommpay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ecommpay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects Sofort method.
  8. The payment platform receives the purchase request for payment processing.
  9. The payment platform performs the internal purchase request processing and sends it to the Sofort service.
  10. The purchase request is processed on the Sofort service side.
  11. The service generates the data for redirecting the customer to its payment form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the Sofort service.
  14. The customer completes all the payment steps required.
  15. The payment is processed on Sofort side.
  16. The result is displayed to the customer on the service.
  17. The customer is redirected to Payment Page.
  18. Sofort sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. A page with the payment result information is displayed to the customer on Payment Page.


Figure: The purchase processing by using Payment Page steps with the payment confirmation procedure

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ecommpay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ecommpay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects Sofort method.
  8. The payment platform receives the purchase request for payment processing.
  9. The payment platform performs the internal purchase request processing and sends it to the Sofort service.
  10. The purchase request is processed on the Sofort service side.
  11. The service Sofort generates the data for redirecting the customer to its payment form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the Sofort payment form.
  14. The customer completes all the payment steps required.
  15. The payment is processed on Sofort service side.
  16. The customer is redirected to Payment Page.
  17. Sofort sends the payment status notification to the payment platform.
  18. The payment platform sends a callback with the payment status information to the web service.
  19. The payment platform sends the notification about processing payment on the Sofort side to the web service.
  20. A page with the notification about processing the payment on the Sofort side is displayed to the customer on Payment Page.
  21. When the procedure of payment confirmation is completed, Sofort sends the result notification to the payment platform.
  22. The payment platform sends a callback with the payment result to the web service.

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:

  1. 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
    • customer_id—the unique ID of the customer within your project
  2. The currency of payment can only be EUR.
  3. 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.
  4. If you need to have payment form displayed with the Sofort method selected, set the force_payment_method parameter to sofort.
  5. If required, you can also add any other additional parameters Payment Page supports.
  6. 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:

{ 
      project_id: 8791,   
      payment_id: 'B436', 
      customer_id: 'customer123',
      payment_currency: 'EUR', 
      payment_amount: 10000,  
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KUDJrOcZzUCwX6R\/ekpZhkIQg=="
    }

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.

Figure: Example of a successful purchase callback (without the payment confirmation procedure)

{
        "project_id": 8791,
        "payment": {
            "id": "test_02",
            "type": "purchase",
            "status": "success",
            "date": "2022-02-19T14:25:25+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": "payment_02"
        },
        "account": {
            "number": "2300568"
        },
        "operation": {
            "id": 141539000182,
            "type": "sale",
            "status": "success",
            "date": "2022-02-19T14:25:25+0000",
            "created_date": "2022-02-19T14:25:24+0000",
            "request_id": "9d22c3bad2913b488"
                "amount": 10000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 11339,
                "payment_id": "1228",
                "date": "2022-02-19T14:25:24+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "of8k9xerKSKpFBRh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
    }

Figure: Example of a declined purchase callback (without the payment confirmation procedure)

{
        "project_id": 8791,
        "payment": {
            "id": "TEST_154996862174000",
            "type": "purchase",
            "status": "decline",
            "date": "2022-02-12T10:56:22+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": "TEST_154996174000"
        },
        "customer": {
            "id": "customer123"
        },
        "operation": {
            "id": 9172000183,
            "type": "sale",
            "status": "decline",
            "date": "2022-02-12T10:56:22+0000",
            "created_date": "2022-02-12T10:56:18+0000",
            "request_id": "11d4a9cb74c0681927ad7",
            "sum_initial": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1100,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "n/1oVdS/mE0AlVOUDbbNqasdfghjiRz0yJRrqn7HiBOEIObz2tN5SLw=="
    }
}

Figure: Example of callback data indicating about payment status information (with the payment confirmation procedure)

{
        "project_id": 8792,
        "payment": {
            "id": "E4364-fc4d",
            "type": "purchase",
            "status": "awaiting confirmation", // payment status
            "date": "2022-04-12T08:46:13+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "DE06000123456789"
        },
        "customer": {
            "id": "customer123"
        },
        "operation": {
            "id": 77,
            "type": "payment confirmation",
            "status": "success",
            "date": "2022-04-12T08:46:13+0000",
            "created_date": "2022-04-12T08:45:01+0000",
            "request_id": "935948575ce85f651ac81f6c412c205eee9a01f0-00000001",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 15203,
                "payment_id": "212225-7590-6710",
                "auth_code": "",
                "endpoint_id": "TD0XXX",
                "date": "2022-04-12T08:45:29+0000"
            }
        },
        "signature": "AvFBWWqia+EItai8yr7yLWl+24bRAouEm59YzlMCUxl/Dhlw5QRFpw5+Q=="
    }

Figure: Example of callback data indicating that the purchase was completed (with the payment confirmation procedure)

{
        "project_id": 8792,
        "payment": {
            "id": "PAYMENT_5524",
            "type": "purchase",
            "status": "success",    // payment status
            "date": "2022-07-18T07:36:19+0000",
            "method": "sofort",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "PAYMENT_5524"
        },
        "customer": {
            "id": "customer123"
        },
        "account": {
            "number": "DE0123456789"
        },
        "operation": {
            "id": 55221,
            "type": "sale",
            "status": "success",
            "date": "2022-07-18T07:36:19+0000",
            "created_date": "2022-07-18T07:33:01+0000",
            "request_id": "a0dd90bd188cc93104d8776f3f23ff66-00023585...",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 9491,
                "payment_id": "212BAB0",
                "auth_code": "",
                "endpoint_id": "ABCXXX",
                "date": "2022-07-18T07:36:13+0000"
            }
        },
        "signature": "RVbY4YUVF0a+K28YPr2//P+mPht24BjO9lPWvRLla4Bic5KdiRg=="
}

Figure: Example of callback data indicating that the funds are not credited (with the payment confirmation procedure)

{
        "project_id": 8792,
        "payment": {
            "id": "PAYMENT_6617",
            "type": "purchase",
            "status": "awaiting confirmation",    // payment status
            "date": "2022-07-18T07:51:24+0000",
            "method": "sofort",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "PAYMENT_6617"
        },
        "customer": {
            "id": "customer123"
        },
        "account": {
            "number": "DE0123456789"
        },
        "operation": {
            "id": 10103681,
            "type": "payment confirmation", 
            "status": "decline",    // the funds are not credited
            "date": "2022-07-18T07:52:25+0000",
            "created_date": "2022-07-18T07:51:24+0000",
            "request_id": "752d-7aac86523ffcc8f19bab54b1e93c14...",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 0123,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "RRBu5U1woawhuYXdpf5lHB6OEsp9SGuiJI3AWvOXhKqtw=="
    }

Figure: Example of callback data indicating that the funds are returned (with the payment confirmation procedure)

{
        "project_id": 8792,
        "payment": {
            "id": "PAYMENT_6017",
            "type": "purchase",
            "status": "reversed",    // payment status
            "date": "2022-07-18T07:52:27+0000",
            "method": "sofort",
            "sum": {
                "amount": 0,
                "currency": "EUR"
            },
            "description": "PAYMENT_6017"
        },
        "customer": {
            "id": "customer123"
        },
        "account": {
            "number": "DE0123456789"
        },
        "operation": {
            "id": 2010691,
            "type": "reversal",
            "status": "success",
            "date": "2022-07-18T07:52:27+0000",
            "created_date": "2022-07-18T07:52:26+0000",
            "request_id": "a4037d3ce2d1812c1-45c98e4898e2854a1325-00086743...",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2345,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "LcsU5RU0LiHfP5Sc/6LVxMt5+Q8w21RGUZehQW0SpHt1VpB7MmV8bg=="
    }

Related topics

The following topics might be useful when implementing payments through Payment Page:

Purchases by using Gate

General information

Depending on processing the payment confirmation procedure, purchase processing by using Gate can involve additional actions. Generally, to perform a purchase by using Gate the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Perform the redirection of a customer to the Sofort service.
  3. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.



Figure: The purchase processing by using Gate steps without the payment confirmation procedure

  1. A customer initiates a purchase through Sofort on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the Sofort service.
  7. The request is processed on the Sofort side.
  8. The Sofort service sends the data for redirecting the customer to the Sofort service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the Sofort service.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the Sofort side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The Sofort service sends the payment result notification to the payment platform.
  16. The payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.


Figure: The purchase processing by using Gate steps with the payment confirmation procedure

  1. A customer initiates a purchase through Sofort on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the Sofort service.
  7. The request is processed on the Sofort side.
  8. The Sofort service sends the data for redirecting the customer to the Sofort service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the Sofort service.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the Sofort side.
  13. The customer is redirected to the merchant's web service.
  14. Sofort sends the payment status notification to the payment platform.
  15. The payment platform sends a callback with the payment status information to the web service.
  16. The customer receives the notification about processing payment on the Sofort side on the web service.
  17. When the procedure of payment confirmation is completed, Sofort service sends the result notification to the payment platform.
  18. The payment platform sends a callback with the payment result to the web service.

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:
  1. You perform purchases 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
  2. 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
      • ip_address—IP address
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—purchase currency in the ISO-4217 alpha-3 format.
  3. The currency of payment can only be EUR.
  4. 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, currency and amount of the purchase, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
        "project_id": 2390,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
      "id": "customer_1",
      "ip_address": "127.0.0.1"
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
    }
}

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.

"redirect_data": {
                    "body": [],
                    "method": "GET",
                    "url": "https://sofort.com/payment/9X4AP1vj&cs=13073..."
                }

Callback format

The Sofort method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

Figure: Example of a successful purchase callback (without the payment confirmation procedure)

{
        "project_id": 8791,
        "payment": {
            "id": "test_02",
            "type": "purchase",
            "status": "success",
            "date": "2022-02-19T14:25:25+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": "payment_02"
        },
        "account": {
            "number": "2300568"
        },
        "operation": {
            "id": 141539000182,
            "type": "sale",
            "status": "success",
            "date": "2022-02-19T14:25:25+0000",
            "created_date": "2022-02-19T14:25:24+0000",
            "request_id": "9d22c3bad2913b488"
                "amount": 10000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 11339,
                "payment_id": "1228",
                "date": "2022-02-19T14:25:24+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "of8k9xerKSKpFBRh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
    }

Figure: Example of a declined purchase callback (without the payment confirmation procedure)

{
        "project_id": 8791,
        "payment": {
            "id": "TEST_154996862174000",
            "type": "purchase",
            "status": "decline",
            "date": "2022-02-12T10:56:22+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": "TEST_154996174000"
        },
        "customer": {
            "id": "customer123"
        },
        "operation": {
            "id": 9172000183,
            "type": "sale",
            "status": "decline",
            "date": "2022-02-12T10:56:22+0000",
            "created_date": "2022-02-12T10:56:18+0000",
            "request_id": "11d4a9cb74c0681927ad7",
            "sum_initial": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1100,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "n/1oVdS/mE0AlVOUDbbNqasdfghjiRz0yJRrqn7HiBOEIObz2tN5SLw=="
    }
}

Figure: Example of callback data indicating about payment status information (with the payment confirmation procedure)

{
        "project_id": 8792,
        "payment": {
            "id": "E4364-fc4d",
            "type": "purchase",
            "status": "awaiting confirmation", // payment status
            "date": "2022-04-12T08:46:13+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "DE06000123456789"
        },
        "customer": {
            "id": "customer123"
        },
        "operation": {
            "id": 77,
            "type": "payment confirmation",
            "status": "success",
            "date": "2022-04-12T08:46:13+0000",
            "created_date": "2022-04-12T08:45:01+0000",
            "request_id": "935948575ce85f651ac81f6c412c205eee9a01f0-00000001",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 15203,
                "payment_id": "212225-7590-6710",
                "auth_code": "",
                "endpoint_id": "TD0XXX",
                "date": "2022-04-12T08:45:29+0000"
            }
        },
        "signature": "AvFBWWqia+EItai8yr7yLWl+24bRAouEm59YzlMCUxl/Dhlw5QRFpw5+Q=="
    }

Figure: Example of callback data indicating that the purchase was completed (with the payment confirmation procedure)

{
        "project_id": 8792,
        "payment": {
            "id": "PAYMENT_5524",
            "type": "purchase",
            "status": "success",    // payment status
            "date": "2022-07-18T07:36:19+0000",
            "method": "sofort",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "PAYMENT_5524"
        },
        "customer": {
            "id": "customer123"
        },
        "account": {
            "number": "DE0123456789"
        },
        "operation": {
            "id": 55221,
            "type": "sale",
            "status": "success",
            "date": "2022-07-18T07:36:19+0000",
            "created_date": "2022-07-18T07:33:01+0000",
            "request_id": "a0dd90bd188cc93104d8776f3f23ff66-00023585...",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 9491,
                "payment_id": "212BAB0",
                "auth_code": "",
                "endpoint_id": "ABCXXX",
                "date": "2022-07-18T07:36:13+0000"
            }
        },
        "signature": "RVbY4YUVF0a+K28YPr2//P+mPht24BjO9lPWvRLla4Bic5KdiRg=="
}

Figure: Example of callback data indicating that the funds are not credited (with the payment confirmation procedure)

{
        "project_id": 8792,
        "payment": {
            "id": "PAYMENT_6617",
            "type": "purchase",
            "status": "awaiting confirmation",    // payment status
            "date": "2022-07-18T07:51:24+0000",
            "method": "sofort",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "PAYMENT_6617"
        },
        "customer": {
            "id": "customer123"
        },
        "account": {
            "number": "DE0123456789"
        },
        "operation": {
            "id": 10103681,
            "type": "payment confirmation", 
            "status": "decline",    // the funds are not credited
            "date": "2022-07-18T07:52:25+0000",
            "created_date": "2022-07-18T07:51:24+0000",
            "request_id": "752d-7aac86523ffcc8f19bab54b1e93c14...",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 0123,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "RRBu5U1woawhuYXdpf5lHB6OEsp9SGuiJI3AWvOXhKqtw=="
    }

Figure: Example of callback data indicating that the funds are returned (with the payment confirmation procedure)

{
        "project_id": 8792,
        "payment": {
            "id": "PAYMENT_6017",
            "type": "purchase",
            "status": "reversed",    // payment status
            "date": "2022-07-18T07:52:27+0000",
            "method": "sofort",
            "sum": {
                "amount": 0,
                "currency": "EUR"
            },
            "description": "PAYMENT_6017"
        },
        "customer": {
            "id": "customer123"
        },
        "account": {
            "number": "DE0123456789"
        },
        "operation": {
            "id": 2010691,
            "type": "reversal",
            "status": "success",
            "date": "2022-07-18T07:52:27+0000",
            "created_date": "2022-07-18T07:52:26+0000",
            "request_id": "a4037d3ce2d1812c1-45c98e4898e2854a1325-00086743...",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2345,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "LcsU5RU0LiHfP5Sc/6LVxMt5+Q8w21RGUZehQW0SpHt1VpB7MmV8bg=="
    }

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