Payment-method icon

giropay for API only

Add giropay to an existing API-only integration.

Accept giropay payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Before you begin

These instructions explain how to add giropay to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.

Before starting your giropay integration:

  1. Make sure that you have set up your back end implementation.
  2. Add giropay in your test Customer Area.

Build your payment form for giropay

Include giropay in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.

We provide a giropay logo which you can use on your payment form. For more information, refer to Downloading logos.

If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:

The response contains paymentMethod.type: giropay.

Make a payment

In your /payments request, specify:

  • paymentMethod.type: giropay
  • returnUrl: The URL where the shopper will be redirected back to after they complete the payment. This URL can have a maximum of 1024 characters.

The /payments response contains an action object with the information needed to redirect the shopper.

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.

When using the HTTP GET method:
For security reasons, when displaying the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

  1. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

    • details: Object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.

You receive a response containing:

  • resultCode: Use this to present the result to your shopper.
  • pspReference: Our unique identifier for the transaction.

Present the payment result

Use the  resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for giropay are:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
You will receive the funds in 2-3 days.
Cancelled The shopper cancelled the payment while on their bank's website. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Pending or
Received
The shopper has completed the payment but the final result is not yet known. It may take minutes or hours for the Open Banking payments network to confirm this. Inform the shopper that you've received their order, and are waiting for the payment to be completed.
You will receive the final result of the payment in an AUTHORISATION webhook.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.
For a description of the refusal reason, check the Payment Details page in your Customer Area.

If the shopper failed to return to your website or app, wait for the AUTHORISATION webhook to receive the outcome of the payment:

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment has been successful, and proceed with the order.

Recurring payments

We support recurring transactions for giropay through SEPA Direct Debit. To make recurring payments, you need to:

  1. Create a shopper token.
  2. Use the token to make future payments for the shopper.

Create a token

We strongly recommend that you request explicit permission from the shopper if you intend to make recurring SEPA payments. Being transparent about the payment schedule and the charged amount reduces the risk of chargebacks.

To create a token, include in your /payments request:

As of Checkout v70, recurringProcessingModel is a required parameter when creating or using a token.

When the payment is settled, you receive a RECURRING_CONTRACT webhook containing:

  • eventCode: RECURRING_CONTRACT
  • originalReference: The pspReference of the initial payment.
  • pspReference: This is the token that you need to make recurring payments for this shopper.

    Make sure that your server is able to receive RECURRING_CONTRACT as part of your standard webhooks. You can enable the RECURRING_CONTRACT event code in the webhook settings page.

Make a payment with a token

For each recurring payment for this shopper, make a SEPA payment with a  /payments call, and additionally include:

As of Checkout v70, recurringProcessingModel is a required parameter when creating or using a token.

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Recurring transaction types.

If the payment was successfully received the response will contain a Received resultCode and a pspReference, which is our unique identifier for this transaction. You can track whether the payment was successful using webhooks.

Test and go live

On the bank selection screen, select giropay Testbank. You can use the following details to make test payments:

IBAN: DE48499999601234567890
VR-NetKey: Any value allowed
PIN: 1234
TAN (for Photo and Flicker devices): 123456

You can check the status of a giropay test payment in your Customer Area > Transactions > Payments.

Before you can accept live giropay payments, you need to submit a request for giropay in your live Customer Area.

See also