GiroPay

Overview

GiroPay is a payment method that allows customers to perform payments by using online banking of the German banks. Purchases are performed by using Payment Page and Gate, refunds—by using Gate.

General information

Payment method type bank payments
Payment instruments bank accounts
Countries and regions DE
Payment currencies EUR
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.

Interaction diagram

Payment processing by using the GiroPay payment method requires merchant's web service, one of ecommpay interfaces, and the ecommpay payment platform, as well as GiroPay service which is supported interactions with banks.



Operations support

  Interfaces Amounts, EUR
Payment Page CMS Plug-ins Gate Dashboard minimum maximum
Purchases + – + – 1.00 –
Full refunds – – + – – –
Partial refunds – – + – – –

Processing scenarios

To perform a purchase operation, you need to redirect a customer to the GiroPay 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.

Figure: Purchase by using Payment Page procedure



Figure: Purchase by using Gate procedure



Figure: Refund by using Gate 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.

Purchases by using Payment Page

General information

In the GiroPay 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 GiroPay 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.



Figure: Purchase by using Payment Page

  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 GiroPay 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 GiroPay service.
  10. The purchase request is processed on the GiroPay 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 GiroPay service.
  14. The customer completes all the payment steps required.
  15. The payment is processed on GiroPay side.
  16. The result is displayed to the customer on the service.
  17. The customer is redirected to Payment Page.
  18. GiroPay 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.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the GiroPay 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 GiroPay method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • customer_id—the unique ID of the customer within your project
    • 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
  2. The currency of a payment can only be EUR.
  3. There are more mandatory parameters customer_first_name, customer_last_name, customer_email—first. last names, email of the customer within the project.
  4. If you need to have payment form displayed with the GiroPay method selected, set the force_payment_method parameter to giropay.
  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 GiroPay 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:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 100000, 
      payment_currency: 'EUR', 
      project_id: 121,
      customer_id: '123',
      customer_first_name: 'John',
      customer_last_name: 'Johnson',
      customer_email: 'John@mail.com',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KURLCvhtT4DqtOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the GiroPay method, see Parameters for opening payment form.

Callback format

The GiroPay 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 10.00 EUR purchase from the 41193 customer in the 15 project.

Figure: Example of a successful purchase callback


{
        "project_id": 15,
        "payment": {
            "id": "4ZW1pdW0uOTBkLERFLGRlX0RF",
            "type": "purchase",
            "status": "success",
            "date": "2019-07-08T11:08:58+0000",
            "method": "giropay",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "90 Tage Premium-Mitgliedschaft"
        },
        "customer": {
            "id": "41193"
        },
        "operation": {
            "id": 22482000003531,
            "type": "sale",
            "status": "success",
            "date": "2019-07-08T11:08:58+0000",
            "created_date": "2019-07-08T11:08:09+0000",
            "request_id": "3e4e37666d9b",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1171,
                "payment_id": "421417103",
                "date": "2019-07-08T11:08:14+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "moZ/l3t4qk2MuKWs/kWxPvXwwUpUXtZKZi/5CVAe5UtYOTqu2rRwIhIV8QcRRHhInYMy+MCBuQ=="
    }

The following is the example of a callback for a purchase declined due to the account owner cancelled operation.

Figure: Example of a declined purchase callback


{
        "project_id": 1569,
        "payment": {
            "id": "145408-190628095914-cmY0LnByZ=",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-28T09:59:58+0000",
            "method": "giropay",
            "sum": {
                "amount": 300,
                "currency": "EUR"
            },
            "description": "3 Tage Premium-Mitgliedschaft"
        },
        "customer": {
            "id": "145408"
        },
        "operation": {
            "id": 33841000003201,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-28T09:59:58+0000",
            "created_date": "2019-06-28T09:59:16+0000",
            "request_id": "cef7a32aa22a4e4bc8",
            "sum_initial": {
                "amount": 300,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 300,
                "currency": "EUR"
            },
            "provider": {
                "id": 1171,
                "payment_id": "474810276",
                "date": "2019-06-28T09:59:45+0000",
                "auth_code": ""
            },
            "code": "20301",
            "message": "Account owner cancelled operation"
        },
        "signature": "LifBDhURNHa0MYX4wFBHkoUr5ts4kocEq9eVkzL1UxRCp1JNbQ9M46TyotjGT5io17TSw=="
    }

Related topics

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

Purchases by using Gate

General information

In the GiroPay methods, when processing 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 GiroPay 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: Purchase by using Gate

  1. A customer initiates a purchase through GiroPay 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 GiroPay service.
  7. The request is processed on the GiroPay side.
  8. The GiroPay service sends the data for redirecting the customer to the GiroPay 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 GiroPay service.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the GiroPay side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The GiroPay 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.

The sections that follow discuss in more details the request format and the Gate parameters to use in the GiroPay 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 GiroPay method:
  1. You perform purchases by sending the /v2/payment/online-banking/giropay/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
      • first_name—first name
      • last_name—last name
      • email—email address
      • ip_address—customer IP address
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—purchase currency in the ISO-4217 alpha-3 format.
    • return_url—URL for customer returning from the bank site:
      • return—site URL for returning
  3. The currency of a 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 GiroPay method must include project, customer and payment IDs, customer data, currency and amount of the purchase, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
        "project_id": 2990,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
      "id": "123",
      "ip_address": "1.1.1.1",
      "email": "Johnson@mail.com",
      "first_name": "John",
      "last_name": "Johnson"
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
    },
    "return_url": {
      "return": "http://merchantsite.com"
    }
}

Formats of the customer redirection data

To redirect a customer from the web service to the GiroPay 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://girogate.de/giropay?tx=421417103&rs=uv333db1260e2"
                }

Callback format

The GiroPay 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 10.00 EUR purchase from the 41193 customer in the 15 project.

Figure: Example of a successful purchase callback


{
        "project_id": 15,
        "payment": {
            "id": "4ZW1pdW0uOTBkLERFLGRlX0RF",
            "type": "purchase",
            "status": "success",
            "date": "2019-07-08T11:08:58+0000",
            "method": "giropay",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "90 Tage Premium-Mitgliedschaft"
        },
        "customer": {
            "id": "41193"
        },
        "operation": {
            "id": 22482000003531,
            "type": "sale",
            "status": "success",
            "date": "2019-07-08T11:08:58+0000",
            "created_date": "2019-07-08T11:08:09+0000",
            "request_id": "3e4e37666d9b",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1171,
                "payment_id": "421417103",
                "date": "2019-07-08T11:08:14+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "moZ/l3t4qk2MuKWs/kWxPvXwwUpUXtZKZi/5CVAe5UtYOTqu2rRwIhIV8QcRRHhInYMy+MCBuQ=="
    }

The following is the example of a callback for a purchase declined due to the account owner cancelled operation.

Figure: Example of a declined purchase callback


{
        "project_id": 1569,
        "payment": {
            "id": "145408-190628095914-cmY0LnByZ=",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-28T09:59:58+0000",
            "method": "giropay",
            "sum": {
                "amount": 300,
                "currency": "EUR"
            },
            "description": "3 Tage Premium-Mitgliedschaft"
        },
        "customer": {
            "id": "145408"
        },
        "operation": {
            "id": 33841000003201,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-28T09:59:58+0000",
            "created_date": "2019-06-28T09:59:16+0000",
            "request_id": "cef7a32aa22a4e4bc8",
            "sum_initial": {
                "amount": 300,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 300,
                "currency": "EUR"
            },
            "provider": {
                "id": 1171,
                "payment_id": "474810276",
                "date": "2019-06-28T09:59:45+0000",
                "auth_code": ""
            },
            "code": "20301",
            "message": "Account owner cancelled operation"
        },
        "signature": "LifBDhURNHa0MYX4wFBHkoUr5ts4kocEq9eVkzL1UxRCp1JNbQ9M46TyotjGT5io17TSw=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Refunds by using Gate

General information

GiroPay supports full and partial refunds processing. In the GiroPay method, to perform a refund by using Gate: merchant's web service sends a request with all the required parameters and signature to ecommpay URL, Gate accepts the request and redirects to the payment platform for further processing. The full sequence of the refund process is provided below.



Figure: Refund sequence by using Gate

  1. A customer orders a refund by using merchant's web service.
  2. Merchant's web service sends the refund request for processing the payout by using Gate to the appropriate ecommpay URL.
  3. Gate redirects the request to the ecommpay payment platform.
  4. The payment platform performs all the necessary check and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the refund request to the GiroPay service.
  7. The refund is processed on GiroPay side.
  8. GiroPay sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the information about refund from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the GiroPay 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 GiroPay method:
  1. You perform refund by sending the request to /v2/payment/online-banking/giropay/refund by using POST (HTTP) method. This is an online banking request group: /v2/payment/online-banking/{payment_method}/refund
  2. 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)
  3. If required, you can also add any other additional parameters Gate supports.

Thus, a correct refund request in the GiroPay method must include project and payment IDs, customer IP address, currency and amount of the payout, as shown in the following example:

Figure: Example of a refund request 

  "general": {    
    "project_id": 239,    
    "payment_id": "refund_02",   
    "signature": "of8k9xerKSKpFBR4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
  },  
    "customer": {    
     "ip_address": "1.2.3.4" 
 },  
    "payment": {    
     "amount": 10000,    
     "currency": "EUR",
     "description": "refund_02"
}
}

Callback format

The GiroPay 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 1.00 EUR refund for the customer account in the 238 project.

Figure: Example of a successful refund callback

 
{
        "project_id": 238,
        "payment": {
            "id": "TEST_15611060328012",
            "type": "purchase",
            "status": "refunded",
            "date": "2019-06-21T11:15:40+0000",
            "method": "giropay",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": ""
        },
        "provider_extra_fields": {
            "description": "Refund"
        },
        "operation": {
            "id": 36084000003050,
            "type": "refund",
            "status": "success",
            "date": "2019-06-21T11:15:40+0000",
            "created_date": "2019-06-21T11:15:38+0000",
            "request_id": "ec1a34153dc43fe1bae7b6397",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1171,
                "payment_id": "105796085",
                "date": "2019-06-21T11:15:39+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "DtwI1Wbg6Wda71k/xGHEzVUZXPcCSwT2tyo1q38vy0dGWGE2qHhfA7naVeEk0wtfqg=="
    }

Here is an example of callback for a refund declined.

Figure: Example of a declined refund callback

{
        "project_id": 238,
        "payment": {
            "id": "TEST_15611060328012",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-21T08:39:50+0000",
            "method": "giropay",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": ""
        },
        "errors": [
            {
                "code": "100",
                "message": "General decline",
                "description": "Gate. Operation was declined. General Gate error"
            }
        ],
        "operation": {
            "id": 36084000003046,
            "type": "refund",
            "status": "decline",
            "date": "2019-06-21T09:42:44+0000",
            "created_date": "2019-06-21T09:42:44+0000",
            "request_id": "5d0c7bf5304685ab9c9613a8e9a86",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1171,
                "payment_id": ""
            },
            "code": "100",
            "message": "General decline"
        },
        "signature": "AX+FugJdXi3kc0KirM5ckfzH6NXlbeHaIUiIjCpaTk94+4gIvrhj/6n3PBA=="
    }

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