giropay
Beta
Last updated: April 17, 2024
giropay enables customers to perform online purchases through quick, secure, and guaranteed bank transfers.
Information
To enable giropay payments on your account, contact your Account Manager or [email protected].
Model | Collecting |
---|---|
Payment flow | Redirect |
Payment method type | Online banking |
One-step payment | |
Authorization | |
Capture | |
Refund | |
Partial refund | |
Chargeback | |
Recurring payment |
Note
Refunds can be performed using the Refund API. Refunds are not supported via the Dashboard.
giropay payments follow a two-step process:
Use the details below to set up your request.
You can find the full list, as well as complete request and response examples, in our API reference.
post
https://api.checkout.com/payments
1{2"source": {3"type": "giropay"4},5"shipping": {6"address": {7"city": "Berlin",8"zip": "10101",9"country": "DE"10}11},12"description": "Mens black t-shirt L",13"amount": 1914,14"currency": "EUR",15"success_url": "http://example.com/payments/success",16"failure_url": "http://example.com/payments/fail"17}
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.
If you receive a 202 Success
response containing a status field set to Pending
, your request was successful.
1{2"id": "pay_d3ohhwwu3qderfjlzitknc26sq",3"status": "Pending",4"customer": {5"id": "cus_hfgq4ctsnr6e3cfhq5ctwb5gtu"6},7"_links": {8"self": {9"href": "https://api.sandbox.checkout.com/payments/pay_d3ohhwwu3qderfjlzitknc26sq"10},11"redirect": {12"href": "https://ftg-customer-integration.giropay.de/ftgbank/b/bankselection/219499703994809788;jsessionid=8ECFE1809F9BAB6635EC9D37D98A1CAE.sf-testapp01tom21?op=001"13}14}15}
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.
Retrieve details about an existing giropay payment with the following endpoint.
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}
1{2"id": "pay_iilqeu2rsdqedkvkjhl2rxgbvy",3"created_on": "2018-03-28T14:50:26Z",4"source": {5"type": "giropay",6"bic": "TESTDETT421",7"iban": "DE46940594210000012345",8"account_holder_name": "Test GmbH & Co. KG"9},10"amount": 1914,11"currency": "EUR",12"payment_type": "Regular",13"status": "Captured",14"description": "Set of three masks",15"flagged": false,16"shipping": {17"address": {18"city": "Berlin",19"zip": "10101",20"country": "DE"21}22},23"_links": {24"self": {25"href": "https://api.checkout.com/payments/pay_iilqeu2rsdqedkvkjhl2rxgbvy"26}27}28}
giropay supports both partial and full refunds. You can refund a payment using the Refund API.
post
https://api.checkout.com/payments/{id}/refunds
1{2"reference": "ORD-5023-4E89",3"metadata": {4"coupon_code": "NY2018",5"partner_id": 1239896}7}
A successful refund request returns a 202 Refund accepted
response. However, if there was a problem with your request, you'll receive an error response.
1{2"action_id": "act_y3oqhf46pyzuxjbcn2giaqnb44",3"reference": "ORD-5023-4E89",4"_links": {5"payment": {6"href": "https://api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44"7}8}9}
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.
Use the following steps to test payment capture, payment expiry, and payment cancellation (or void) with giropay.
Information
For more information on giropay testing, refer to the giropay Test Data documentation.
- Make the payment request.
- Navigate to the redirection URL returned in the response. The URL should begin with
https://sandbox.paydirekt.de
. - Select Commerzbank from the menu, or search for it using the Bankname search field.
- The BIC number will appear. Select Commerzbank again to continue.
- In the payment screen that appears, enter DE48499999601234567890 in the IBAN field.
- Enter Tester123 in the Benutzername/Teilnehmernummer field.
- In the status screen, set the Transaktion field to AcceptedCreditorSettlementCompleted and click Senden.
- Click the TPP-Redirect-URI folgen link to be redirected to the success url.
- Make the payment request.
- Wait approximately 15 minutes for the payment to expire.
- Make the payment request.
- Navigate to the redirection URL returned in the response.
- Select Zahlung abbrechen.