This page explains how to add giropay to your existing Web Drop-in integration.
Requirements
Select which endpoint you are using:
API reference
You do not need to send additional fields for giropay. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:
- /sessions: This is the default with Drop-in v5.0.0 or later.
- /payments: If you implemented an additional use case.
Drop-in configuration
There are no configuration steps specific to giropay required for Drop-in.
Recurring payments
We support recurring transactions for giropay through SEPA Direct Debit. To make recurring payments, you need to:
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_CONTRACToriginalReference
: ThepspReference
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.