Skip to content

Giropay Beta

Last updated: 16th September 2022

Start accepting payments using Giropay, a favorite payment method in Germany.

Giropay provides the ability to make purchases online through quick and easy bank transfers that are both secure and guaranteed.

To learn more, reach out to your Customer Success Manager or support@checkout.com.

Model

Collecting

Payment flow

Redirect

Payment method type

Online banking

One-step payment

Authorization

Capture

Refund

Partial refund

Chargeback

Recurring payment


Overview

Giropay payments follow a two-step process:

Request a payment

Use the details below to set up your request.

Endpoints

You can find the full list, as well as complete request and response examples, in our API reference.

    post

    https://api.checkout.com/payments

    Request example

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    {
    "source": {
    "type": "giropay",
    "purpose":"Mens black t-shirt L"
    },
    "amount": 1914,
    "currency": "EUR",
    "success_url": "http://example.com/payments/success",
    "failure_url": "http://example.com/payments/fail"
    }

    If a customer ID or email is not provided in the request, we automatically create a customer profile and return the customer id in the response.

    Response example

    If you receive a 202 Success response containing a status field set to Pending, your request was successful.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    {
    "id": "pay_d3ohhwwu3qderfjlzitknc26sq",
    "status": "Pending",
    "customer": {
    "id": "cus_hfgq4ctsnr6e3cfhq5ctwb5gtu"
    },
    "_links": {
    "self": {
    "href": "https://api.sandbox.checkout.com/payments/pay_d3ohhwwu3qderfjlzitknc26sq"
    },
    "redirect": {
    "href": "https://ftg-customer-integration.giropay.de/ftgbank/b/bankselection/219499703994809788;jsessionid=8ECFE1809F9BAB6635EC9D37D98A1CAE.sf-testapp01tom21?op=001"
    }
    }
    }

    Redirect the customer

    Redirect your customer to the redirect link’s href in the response. The link will send them to a Giropay page where they can select their bank.

    Once they've selected a bank, they'll be transferred to the specified bank's page to enter their authorization details. If successful, the payment can be approved and the customer is either redirected to your predefined success or failure URL.

    Confirmation of a Giropay payment is only communicated through webhooks. All payments are labeled as Pending until you receive a payment_captured webhook notification (response code 10000), indicating a successful transaction.


    Get details about a payment

    Retrieve details about an existing Giropay payment with the following endpoint.

    Endpoints

    You can find the full list, as well as complete request and response examples, in our API reference.

      get

      https://api.checkout.com/payments/{id}

      Response example

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      {
      "id": "pay_iilqeu2rsdqedkvkjhl2rxgbvy",
      "created_on": "2018-03-28T14:50:26Z",
      "source": {
      "type": "giropay",
      "purpose": "Set of three masks",
      "bic": "TESTDETT421",
      "iban": "DE46940594210000012345",
      "account_holder_name": "Test GmbH & Co. KG"
      },
      "amount": 1914,
      "currency": "EUR",
      "payment_type": "Regular",
      "status": "Captured",
      "flagged": false,
      "_links": {
      "self": {
      "href": "https://api.checkout.com/gateway/payments/pay_iilqeu2rsdqedkvkjhl2rxgbvy"
      }
      }
      }

      Refund a payment

      Giropay supports both partial and full refunds. You can refund a payment through the Dashboard or using the refund API.


      Cancel a payment

      If the customer fails to complete their payment, we automatically void it and send a payment_expired webhook.

      However, if the customer explicitly cancels their payment, we send a payment_canceled webhook instead.


      Testing Giropay

      Before you being testing, you'll need to create a test account and contact your Customer Success Manager to activate Giropay payments in your sandbox environment.

      Once you're set up, follow the steps below to test:

      1. Create a Giropay transaction using the steps mentioned on this page and follow the redirect link in the response to Giropay's bank selection page.
      2. Select the bank ("Wählen Sie Ihre Bank aus"):
      • BIC: TESTDETT421
      • Name: Sparkasse Testinstitut-421 94059421 TESTDETT421.
      1. Select Weiter zu meiner Bank and wait until you're redirected to the bank's page.
      2. Log in with the following details:
      • Anmeldename oder Legitimations-ID: chiptanscatest2
      • PIN: 12345
      1. Select Jetzt bezahlen to continue.
      2. Scroll to the end of the page, select Optischer TAN, and then select Jetzt bezahlen.
      3. Scroll to the end of the page again, enter 123456 in the TAN field, and select Login.
      4. Select Weiter, enter 123456 in the TAN field, and then select Jetzt bezahlen.
      5. If the above steps were successful, you should be redirected to your predefined success URL.