giropay Redirect Component

Add giropay to an existing Components integration.

If you are using Android Components v5.0.0 or later:

This payment method requires no additional configuration.

Follow the Components integration guide and use the following module and Component names:

To import the module:
To launch and show the Component: InstantPaymentComponent

You do not need to collect any information from your shopper in your payments form. If you have an existing Android Components integration, you can use our Redirect Component to redirect the shopper to their bank's website or app where they can complete the payment.

When making a giropay payment, you need to:

Include giropay in the list of available payment methods.
Handle the redirect.

Requirements

Requirement	Description
Integration type	Make sure that you have built an Advanced flow Android Components integration.
Setup steps	Before you begin, add in your Customer Area.

Show giropay in your payment form

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

Specify in your /paymentMethods request:
- countryCode: DE
- amount.currency: EUR
- channel: Specify Android.

The response contains paymentMethod.type: giropay.

We provide logos for giropay and the issuing banks which you can use on your payment form. For more information, refer to Downloading logos.

Make a payment

When the shopper proceeds to pay, you need to:

From your server, make a /payments request, specifying:
- paymentMethod.type: Set this to giropay.
- returnURL: URL to where the shopper should be redirected back to after they complete the payment. This URL can have a maximum of 1024 characters. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).
```
In the  /payments response, note the `action` object. This contains the information needed to redirect the shopper.
```
Pass the action object to your client app. You need this to initialize the Redirect Component.

Handle the redirect

Use the Redirect Component to redirect the shopper to giropay's website where they can select their bank and provide their account details. When the shopper returns back to your app, the Redirect Component provides the actionComponentData object.
After the shopper returns to your app, make a POST /payments/details request from your server, providing:
- details: The actionComponentData.details object from the Redirect Component.

You receive a response containing:

resultCode: Use this to present the payment 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 have 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:

Create a shopper token.
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:

amount: The transaction must have a minimum value of EUR 0.01.
storePaymentMethod: true
shopperReference: your unique identifier for the shopper (minimum length three characters). Do not include personally identifiable information (PII), such as name or email address.
recurringProcessingModel: Subscription or UnscheduledCardOnFile

From 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 to the /payments endpoint, specifying:

paymentMethod.type: sepadirectdebit
paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT webhook. You can also get this value using the /listRecurringDetails endpoint.
shopperReference: The shopper ID you provided when you created the shopper token.
shopperInteraction: ContAuth.
recurringProcessingModel: Subscription or UnscheduledCardOnFile.

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

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Tokenization.

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.