# giropay payments with Sources

Use Sources to accept payments using giropay, a popular payment method in Germany.

> We deprecated the Sources API and plan to remove support for local payment methods. If you currently integrate with giropay using the Sources API, you must [migrate to the Payment Methods API](https://docs.stripe.com/payments/payment-methods/transitioning.md).
> 
> For information about integrating giropay with the current APIs, see [giropay payments](https://docs.stripe.com/payments/giropay.md).

Before you can use giropay, you must activate it in the [Dashboard](https://dashboard.stripe.com/account/payments/settings). Your use of giropay must be in accordance with our [giropay Terms of Service](https://stripe.com/giropay/legal).

Stripe users in Europe and the United States can accept giropay payments from customers in Germany using [Sources](https://docs.stripe.com/sources.md).

During the payment process, a [Source](https://docs.stripe.com/api.md#sources) object is created and your customer is redirected to their bank’s website or mobile application to authorize the payment. After completing this, your integration can use the source to make a charge request to complete the payment.

giropay is a [push](https://docs.stripe.com/sources.md#pull-or-push-of-funds)-based, [single-use](https://docs.stripe.com/sources.md#single-use-or-reusable) and [synchronous](https://docs.stripe.com/sources.md#synchronous-or-asynchronous-confirmation) method of payment. This means your customer takes action to send the amount to you through a [redirect](https://docs.stripe.com/sources.md#flow-for-customer-action) and there is immediate confirmation about the success or failure of a payment.

## Create a Source object

A `Source` object is either created client-side using [Stripe.js](https://docs.stripe.com/payments/elements.md) or server-side using the [Source creation endpoint](https://docs.stripe.com/api.md#create_source), with the following parameters:

| Parameter                         | Value                                                                                                                                                                                                  |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type`                            | **giropay**                                                                                                                                                                                            |
| `amount`                          | A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies.md#zero-decimal) representing the amount to charge the customer (for example, **1099** for a 10.99 EUR payment). |
| `currency`                        | **eur** (giropay must always use Euros)                                                                                                                                                                |
| `owner[name]`                     | The full name of the account holder.                                                                                                                                                                   |
| `redirect[return_url]`            | The URL the customer should be redirected to after the authorization process.                                                                                                                          |
| `statement_descriptor` (optional) | A custom statement descriptor for the payment.                                                                                                                                                         |

To create a source with [Stripe.js](https://docs.stripe.com/payments/elements.md), first include the library within your website and set your [publishable API key](https://dashboard.stripe.com/apikeys). Once included, use the following `createSource` method to create a source client-side:

```json
stripe.createSource({
  type: 'giropay',
  amount: 1099,
  currency: 'eur',
  owner: {
    name: 'Jenny Rosen',
  },
  redirect: {
    return_url: 'https://shop.example.com/crtA6B28E1',
  },
}).then(function(result) {
  // handle result.error or result.source
});
```

Using either method, Stripe returns a `Source` object containing the relevant details for the method of payment used. Information specific to giropay is provided within the `giropay` subhash.

```json
{
  "id": "src_16xhynE8WzK49JbAs9M21jaR",
  "object": "source",
  "amount": 1099,
  "client_secret": "src_client_secret_UfwvW2WHpZ0s3QEn9g5x7waU",
  "created": 1445277809,
  "currency": "eur",
  "flow": "redirect",
  "livemode": true,
  "owner": {
    "address": null,
    "email": null,
    "name": null,
    "phone": null,
    "verified_address": null,
    "verified_email": null,
    "verified_name": "Jenny Rosen",
    "verified_phone": null
  },
  "redirect": {
    "return_url": "https://shop.example.com/crtA6B28E1",
    "status": "pending",
    "url": "https://hooks.stripe.com/redirect/src_16xhynE8WzK49JbAs9M21jaR?client_secret=src_client_secret_UfwvW2WHpZ0s3QEn9g5x7waU"
  },
  "statement_descriptor": null,
  "status": "pending",
  "type": "giropay",
  "usage": "single_use",
  "giropay": {
    "bank_code": null,
    "bic": null,
    "bank_name": null,
    "statement_descriptor": null
  }
}
```

### Source creation in mobile applications

If you’re building an iOS or Android app, you can implement sources using our mobile SDKs.

### Optional: Providing a custom statement descriptor 

giropay requires a [statement descriptor](https://support.stripe.com/questions/when-i-charge-a-customer-what-will-they-see-on-their-card-statements) before the customer is redirected to authenticate the payment. By default, your Stripe account’s statement descriptor is used (you can review this in the [Dashboard](https://dashboard.stripe.com/settings/public)). You can provide a custom descriptor by specifying `statement_descriptor` when creating a source. giropay statement descriptors support a maximum of 35 characters.

```json
stripe.createSource({
  type: 'giropay',
  amount: 1099,
  currency: 'eur',
  statement_descriptor: 'ORDER AT11990',
  owner: {
    name: 'Jenny Rosen',
  },
  redirect: {
    return_url: 'https://shop.example.com/crtA6B28E1',
  },
}).then(function(result) {
  // handle result.error or result.source
});
```

Providing a custom statement descriptor within a subsequent charge request has no effect.

## Error codes

Source creation for giropay payments might return any of the following errors:

| Error                          | Description                                                                                                                      |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| `payment_method_not_available` | The payment method is currently not available. You should invite your customer to fallback to another payment method to proceed. |
| `processing_error`             | An unexpected error occurred preventing us from creating the source. The source creation should be retried.                      |

## Have the customer authorize the payment

When creating a source, its status is initially set to `pending` and can’t yet be used to make a charge request. Your customer must authorize a giropay payment to make the source chargeable. To allow your customer to authorize the payment, redirect them to the URL provided within the`redirect[url]` attribute of the `Source` object.

After the authorization process, your customer is redirected back to the URL provided as a value of `redirect[return_url]`. This happens regardless of whether authorization was successful or not. If the customer has authorized the payment, the `Source` object’s status is updated to `chargeable` and it’s ready to use in a charge request. If your customer declines the payment, the status transitions to `failed`.

Stripe populates the `redirect[return_url]` with the following GET parameters when returning your customer to your website:

- `source`: a string representing the original ID of the `Source` object
- `livemode`: indicates if this is a live payment, either `true` or `false`
- `client_secret`: used to *confirm* (Confirming an intent indicates that the customer intends to use the current or provided payment method. Upon confirmation, the intent attempts to initiate the portions of the flow that have real-world side effects) that the returning customer is the same one who triggered the creation of the source (source IDs aren’t considered secret)

You might include any other GET parameters you might need when specifying `redirect[return_url]`. Don’t use the above as parameter names yourself as these would be overridden by the values we populate.

### Mobile applications

To integrate giropay within a mobile application, provide your application URI scheme as the `redirect[return_url]` value. By doing so, your customers are returned to your app after completing authorization.

### Testing the redirect process

When creating a `Source` object using your test API keys, you can follow the URL returned in the `redirect[url]` field. This leads to a Stripe page that displays information about the API request, and where you can either authorize or cancel the payment. Authorizing the payment redirects you to the URL specified in `redirect[return_url]`.

Alternatively, to accelerate testing, use the following value for `owner[email]`, where `xxx_` is any prefix of your choice (these patterns are significant only in testmode):

| Email Address                | Effect                                                                                                                |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `xxx_chargeable@example.com` | The source will be created as `pending`, but automatically transition to `chargeable` within seconds of its creation. |

## Charge the Source

Your integration must use [webhooks](https://docs.stripe.com/webhooks.md) in order for you to receive notifications of status changes on `Source` and `Charge` objects.

Once the customer has authenticated the payment, the source’s `status` transitions to `chargeable` and it can be used to make a charge request. This transition happens asynchronously and may occur after the customer was redirected back to your website.

Some customers using giropay assume that the order process is complete once they have authenticated the payment and received confirmation from their bank. This results in customers who close their browser instead of following the redirect and returning to your app or website.

For these reasons it’s essential that your integration rely on *webhooks* (A webhook is a real-time push notification sent to your application as a JSON payload through HTTPS requests) to determine when the source becomes chargeable to create a charge.

### Webhooks

The following webhook events are sent to notify you about changes to the source’s status:

| Event               | Description                                                                                          |
| ------------------- | ---------------------------------------------------------------------------------------------------- |
| `source.chargeable` | A `Source` object becomes `chargeable` after a customer has authenticated and verified a payment.    |
| `source.failed`     | A `Source` object failed to become chargeable as your customer declined to authenticate the payment. |
| `source.canceled`   | A `Source` object expired and can’t be used to create a charge.                                      |

### Make a charge request using the source

Once the source is chargeable, from your `source.chargeable` webhook handler, you can make a charge request using the source ID as the value for the `source` parameter to complete the payment.

#### curl

```bash
curl https://api.stripe.com/v1/charges \
  -u <<YOUR_SECRET_KEY>>: \
  -d amount="1099" \
  -d currency="eur" \
  -d source=src_18eYalAHEMiOZZp1l9ZTjSU0
```

giropay Sources are [single-use](https://docs.stripe.com/sources.md#single-use-or-reusable) and can’t be used for recurring or additional payments.

## Confirm that the charge has succeeded

Since giropay is a [synchronous](https://docs.stripe.com/sources.md#synchronous-or-asynchronous-confirmation) payment method and the customer has already authenticated the payment as part of the redirect, unless there is an unexpected error, the [Charge](https://docs.stripe.com/api.md#charge_object) will immediately succeed.

You’ll also receive the following webhook event as the charge is created:

| Event              | Description                                       |
| ------------------ | ------------------------------------------------- |
| `charge.succeeded` | The charge succeeded and the payment is complete. |

We recommend that you rely on the `charge.succeeded` webhook event to notify your customer that the payment process has been completed and their order is confirmed.

### Disputed payments

The risk of fraud or unrecognized payments is much lower as the customer must authenticate the payment with their bank. As such, there is no dispute process that can result in a chargeback and funds withdrawn from your Stripe account. Should a customer dispute a payment to their bank, it’s handled internally—no dispute information is presented in the Dashboard.

### Refunds

Payments made with giropay can only be submitted for refund within 180 days from the date of the original charge. After 180 days, it’s no longer possible to refund the charge.

### Source expiration

A source must be used within six hours of becoming `chargeable`. If it’s not, its status automatically transitions to `canceled` and your integration receives a `source.canceled` webhook event. Additionally, `pending` sources are canceled after 1 hour if they aren’t used to authenticate a payment.

Once a source is canceled, the customer’s authenticated payment is refunded automatically—no money is moved into your account. For this reason, make sure the order is canceled on your end and the customer is notified once you receive the `source.canceled` event.

## See also

- [Other supported payment methods](https://docs.stripe.com/sources.md)
- [Sources API reference](https://docs.stripe.com/api.md#sources)