> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/integrations/connectors-integrations/payment-processor-capabilities/available-connectors/worldline.md).

# Worldline

Accept card and bank-redirect payments through Worldline with HMAC-signed requests.

Worldline combines card checkout with bank-redirect payment paths. Refunds and delayed capture options apply across the declared methods. Payment callbacks distinguish successful and rejected outcomes.

### Status and capabilities

**Integration status:** sandbox

**Category:** payment gateway

**Webhook flows:** payments

| Payment method | Type        | Mandates      | Refunds   | Capture methods                         | 3DS                 | Card networks                                | Countries                                         | Currencies                                        |
| -------------- | ----------- | ------------- | --------- | --------------------------------------- | ------------------- | -------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
| bank redirect  | Giropay     | not supported | supported | automatic, manual, sequential automatic | not applicable      | -                                            | DEU                                               | EUR                                               |
| bank redirect  | iDEAL       | not supported | supported | automatic, manual, sequential automatic | not applicable      | -                                            | NLD                                               | EUR                                               |
| card           | Credit Card | not supported | supported | automatic, manual, sequential automatic | supported, optional | American Express, Discover, Mastercard, Visa | 247 ([full list](https://hyperswitch.io/pm-list)) | 154 ([full list](https://hyperswitch.io/pm-list)) |
| card           | Debit Card  | not supported | supported | automatic, manual, sequential automatic | supported, optional | American Express, Discover, Mastercard, Visa | 247 ([full list](https://hyperswitch.io/pm-list)) | 154 ([full list](https://hyperswitch.io/pm-list)) |

### Authentication

Worldline requires **API Key ID**, **Secret API Key**, and **Merchant ID**. Hyperswitch signs each request: it joins the HTTP method, content type, date, and endpoint into one string, signs it with HMAC-SHA256 using the Secret API Key, and sends `Authorization: GCS v1HMAC:<API Key ID>:<signature>`. The Merchant ID is part of the request URL. Details: [`build_headers()`](https://github.com/juspay/hyperswitch/blob/e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0/crates/hyperswitch_connectors/src/connectors/worldline.rs#L96-L128) builds the transport headers via [`generate_authorization_token()`](https://github.com/juspay/hyperswitch/blob/e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0/crates/hyperswitch_connectors/src/connectors/worldline.rs#L64-L88), and [`WorldlineAuthType::try_from()`](https://github.com/juspay/hyperswitch/blob/e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0/crates/hyperswitch_connectors/src/connectors/worldline/transformers.rs#L501-L519) maps the credentials.

### Before you start

1. Register with Worldline at [worldline.com](https://worldline.com/).
2. Sign in to the [Hyperswitch control center](https://app.hyperswitch.io/).
3. Obtain the **API Key ID**, **Secret API Key**, and **Merchant ID** under **API Keys** in the Worldline dashboard.
4. If the activation flow asks you to select payment methods, choose only the methods enabled in the connector dashboard.

Follow [Activate a connector on Hyperswitch](/integrations/connectors-integrations/activate-connector-on-hyperswitch.md), then return here for Worldline-specific behavior.

### Webhooks

Hyperswitch verifies the Base64-decoded `X-GCS-Signature` value with HMAC-SHA256 over the raw request body. Configure Worldline's webhook secret key in Hyperswitch's connector `merchant_secret` (the **Source Verification Key**); Hyperswitch uses it as the HMAC key when checking the signature. Worldline's own SDKs choose the key using the `X-GCS-KeyId` header; Hyperswitch always uses the single secret you configure. See [`get_webhook_source_verification_signature()`](https://github.com/juspay/hyperswitch/blob/e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0/crates/hyperswitch_connectors/src/connectors/worldline.rs#L721-L731) and [`get_webhook_source_verification_message()`](https://github.com/juspay/hyperswitch/blob/e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0/crates/hyperswitch_connectors/src/connectors/worldline.rs#L733-L740).

Hyperswitch reads the payment embedded in the callback to get the transaction ID and status, and answers Worldline's endpoint verification checks. Event types other than the three below are treated as unsupported. Object lookup: [`get_webhook_object_reference_id()`](https://github.com/juspay/hyperswitch/blob/e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0/crates/hyperswitch_connectors/src/connectors/worldline.rs#L742-L760). Resource extraction: [`get_webhook_resource_object()`](https://github.com/juspay/hyperswitch/blob/e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0/crates/hyperswitch_connectors/src/connectors/worldline.rs#L790-L804). Event dispatch: [`get_webhook_event_type()`](https://github.com/juspay/hyperswitch/blob/e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0/crates/hyperswitch_connectors/src/connectors/worldline.rs#L763-L788).

Handled event wire values: **3**.

| Wire value                 | Effect           |
| -------------------------- | ---------------- |
| `payment.paid`             | Payment succeeds |
| `payment.rejected`         | Payment fails    |
| `payment.rejected_capture` | Payment fails    |

The wire names come from [`WebhookEvent`](https://github.com/juspay/hyperswitch/blob/e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0/crates/hyperswitch_connectors/src/connectors/worldline/transformers.rs#L772-L782). Endpoint verification requests are echoed through [`get_webhook_api_response()`](https://github.com/juspay/hyperswitch/blob/e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0/crates/hyperswitch_connectors/src/connectors/worldline.rs#L806-L831).

### Source reference

Authentication and webhook behavior on this page is tied to Hyperswitch `e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0`. See [Worldline connector source](https://github.com/juspay/hyperswitch/blob/e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0/crates/hyperswitch_connectors/src/connectors/worldline.rs) and [Worldline transformers](https://github.com/juspay/hyperswitch/blob/e8e30d1018b1ab5aecada04cf1b3ab63a39a68d0/crates/hyperswitch_connectors/src/connectors/worldline/transformers.rs).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hyperswitch.io/integrations/connectors-integrations/payment-processor-capabilities/available-connectors/worldline.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
