Straumur

https://docs.straumur.is/
Admin
Straumur is a payment services platform offering APIs, hosted checkout, payment gateway, and...
Tokens:74,205
Snippets:752
Trust Score:6.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Request Example with Shopper Infos

Source: https://docs.straumur.is/payment-gateway/payment-links/api/optional-parameters/shopper-infos

This example demonstrates how to include shopperInfos in a PayByLink request to collect the shopper's SSN.

```json
{
  "type": "PayByLink",
  "terminalIdentifier": "1adfe4a1",
  "amount": 48900,
  "currency": "ISK",
  "shopperInfos": [
    {
      "field": "Ssn",
      "requirementType": "Required",
      "prefilledValue": null
    }
  ]
}
```

--------------------------------

### Items List Request Example

Source: https://docs.straumur.is/hosted-checkout/optional-parameters/items-list

An example of how to structure the items list in the request payload.

```APIDOC
## Request Example
```json
{
  "amount": 48900,
  "currency": "ISK",
  "returnUrl": "https://your-ecommerce-website.com/straumur_redirect",
  "reference": "9990QQAZ1221",
  "items": [
    {
      "name": "Gummy Bears",
      "amount": 6900
    },
    {
      "name": "Lollipops",
      "amount": 42000,
      "unitPrice": 23500,
      "quantity": 2,
      "amountWithoutDiscount": 47000
    }
  ]
}
```
```

--------------------------------

### Install Straumur Web npm Package

Source: https://docs.straumur.is/payment-gateway/components/straumur-components/web-component?parameter=instant-payments

Install the recommended version of the Straumur Web component using npm.

```bash
npm install straumur-web-component@"^1.0.0" --save
```

--------------------------------

### Request Example - Card Tokenization with Subscription

Source: https://docs.straumur.is/payment-gateway/components/adyen-components/optional-parameters/recurring-processing-model

Example of a request body for card tokenization with a subscription, utilizing the Subscription recurringProcessingModel.

```APIDOC
## Request Example - Card Tokenization with Subscription
```json
{
  "terminalIdentifier": "1adfe4a1",
  "amount": 48900,
  "currency": "ISK",
  "reference": "9990QQAZ1221",
  "channel": "Web",
  "origin": "https://www.your-ecommerce-website.com",
  "threeDsReturnUrl": "https://your-ecommerce-website.com/straumur_redirect",
  "recurringProcessingModel": "Subscription"
}
```
```

--------------------------------

### Minimum Request Example - Pay by Link

Source: https://docs.straumur.is/payment-gateway/payment-links/api/create-payment-link

Use this example to create a payment link for collecting payments. Ensure all required fields, including item details, are provided.

```json
{
  "type": "PayByLink",
  "terminalIdentifier": "1adfe4a1",
  "amount": 20000,
  "currency": "ISK",
  "items": [
    {
      "name": "Playstation 2 Analog RCA/SCART to HDMI Adapter Low Latency",
      "quantity": 1,
      "amountWithoutDiscount": 25000,
      "amount": 20000,
      "unitPrice": 20000
    }
  ]
}
```

--------------------------------

### Example Response for Get Payment Links

Source: https://docs.straumur.is/payment-gateway/payment-links/api/get-payment-links

This is an example of the JSON response when retrieving payment links. It includes an array of payment link objects, each with its reference, description, amount, currency, type, and creation timestamp.

```json
{
  "data": [
    {
      "paymentLinkReference": "30001aylo2a",
      "description": "Payment for PlayStation 2 HDMI Adapter.",
      "amount": 20000,
      "currency": "ISK",
      "type": "PayByLink",
      "createdAt": "2025-01-01T09:50:14.343503Z"
    },
    {
      "paymentLinkReference": "30001aylo2b",
      "description": "Tokenization for PlayStation 2 purchase.",
      "amount": 0,
      "currency": "ISK",
      "type": "TokenizeByLink",
      "createdAt": "2025-01-01T09:50:14.343503Z"
    }
  ],
  "totalCount": 2,
  "responseDateTime": "2025-01-04T09:50:14.343503Z",
  "responseIdentifier": "e3605f81-6b09-4ce1-83ad-5a8d49f3cd44"
}
```

--------------------------------

### Pre-Authorization Request Example

Source: https://docs.straumur.is/payment-gateway/payments/optional-parameters/pre-authorization

An example of a request body for a pre-authorization payment.

```APIDOC
## Request Example

```json
{
  "amount": 48900,
  "currency": "ISK",
  "returnUrl": "https://your-ecommerce-website.com/straumur_redirect",
  "reference": "9990QQAZ1221",
  "isPreAuth": true
}
```
```

--------------------------------

### Minimum Request Example - Tokenize by Link

Source: https://docs.straumur.is/payment-gateway/payment-links/api/create-payment-link

Use this example to create a payment link for tokenizing payment methods. The amount must be set to 0 for this type.

```json
{
  "type": "TokenizeByLink",
  "terminalIdentifier": "1adfe4a1",
  "recurringProcessingModel": "CardOnFile",
  "amount": 0,
  "currency": "ISK"
}
```

--------------------------------

### Adjustment Event Webhook Example

Source: https://docs.straumur.is/webhooks/payment/adjustment-event

This example demonstrates the structure of the Adjustment Event webhook payload.

```APIDOC
## Adjustment Event Webhook

### Description
This webhook event is triggered when a payment amount has been adjusted after the initial transaction. The event includes the adjusted amount and references to the original payment for proper transaction reconciliation.

### Headers
In the Authorization header, we will set the matching Api key for your webhook.

### Fields
You will always get these fields.
Field| Type| Description  
---|---|---
**checkoutReference**|  nullable string| Unique identifier for the payment that was done through a checkout.  
**payfacReference**|  string| Unique identifier for the payment generated by the payment service provider.  
**merchantReference**|  nullable string| The identifier for the payment provided by you, the merchant, allowing for correlation with the merchant’s system.  
**amount**|  string| The payment amount in the minor currency unit.  
**currency**|  string| The three-letter ISO currency code.  
**reason**|  nullable string| A field that provides additional context in case of payment errors or declines, helping diagnose specific issues.  
**success**|  string| Indicates the payment status (true/false).  
**hmacSignature**|  string| A cryptographic signature generated using a secret, enabling verification of the message authenticity and ensuring it hasn’t been tampered with.  
**additionalData**|  object| An object for the additional details included in the event.  

### Additional Data Fields
Fields you will get depend on the event type of the webhook.
Field| Type| Description  
---|---|---
**eventType**|  string| A string representing the type of event that occurred.  
**authCode**|  nullable string| An authorization code is a unique series of letters or numbers generated by a card issuer or bank to validate a card payment.  
**cardNumber**|  nullable string| A partially masked PAN.  
**cardUsage**|  nullable string| The source of funds used for a payment.  
**originalPayfacReference**|  nullable string| This field indicates the payment request associated with the original payment.  
**paymentMethod**|  nullable string| The payment method used in the payment.

### Webhook Example
```json
{
    "checkoutReference": "kxhbi28jdlo55lbk1u4eskmprbdd9mkh6cj5mpotlduclf13fi",
    "payfacReference": "4WHT92XEIL2EXMHZ",
    "merchantReference": "23770963420369",
    "amount": "48900",
    "currency": "ISK",
    "reason": "",
    "success": "true",
    "hmacSignature": "urlLKKMuoPZK4w6IAoGMiKKbKsG2CYyUN/2CiXeGumA=",
    "additionalData": {
        "eventType": "Adjustment",
        "authCode": "123457",
        "cardNumber": "411111******1111",
        "cardUsage": "Debit",
        "originalPayfacReference": "OOJWITWVQV42PSE8",
        "paymentMethod": "VI"
    }
}
```
```

--------------------------------

### Request Example with Culture

Source: https://docs.straumur.is/hosted-checkout/optional-parameters/culture

This example demonstrates how to include the 'culture' parameter in your hosted checkout request to set the default language to Icelandic.

```APIDOC
## Request Example

```json
{
  "amount": 48900,
  "currency": "ISK",
  "returnUrl": "https://your-ecommerce-website.com/straumur_redirect",
  "reference": "9990QQAZ1221",
  "culture": "is"
}
```
```

--------------------------------

### Authorization Event Webhook Example

Source: https://docs.straumur.is/webhooks/payment/authorization-event

This example demonstrates the structure of the Authorization Event webhook payload.

```APIDOC
## Authorization Event Webhook

### Description
This webhook event is triggered when a payment authorization has been processed, notifying your system that funds have been successfully reserved on the customer's payment method. The event includes transaction details, payment method information, and authentication status to help you track and manage authorized payments.

### Headers
In the Authorization header, we will set the matching Api key for your webhook.

### Fields
You will always get these fields.
Field| Type| Description  
---|---|---
**checkoutReference**|  nullable string| Unique identifier for the payment that was done through a checkout.  
**payfacReference**|  string| Unique identifier for the payment generated by the payment service provider.  
**merchantReference**|  nullable string| The identifier for the payment provided by you, the merchant, allowing for correlation with the merchant’s system.  
**amount**|  string| The payment amount in the minor currency unit.  
**currency**|  string| The three-letter ISO currency code.  
**reason**|  nullable string| A field that provides additional context in case of payment errors or declines, helping diagnose specific issues.  
**success**|  string| Indicates the payment status (true/false).  
**hmacSignature**|  string| A cryptographic signature generated using a secret, enabling verification of the message authenticity and ensuring it hasn’t been tampered with.  
**additionalData**|  object| An object for the additional details included in the event.  

### Additional Data Fields
Fields you will get depend on the event type of the webhook.
Field| Type| Description  
---|---|---
**eventType**|  string| A string representing the type of event that occurred.  
**authCode**|  nullable string| An authorization code is a unique series of letters or numbers generated by a card issuer or bank to validate a card payment.  
**cardExpiryDate**|  nullable string| Card expiration date in "MM/yyyy" format.  
**cardNumber**|  nullable string| A partially masked PAN.  
**cardSummary**|  nullable string| Last 4 digits of PAN.  
**cardUsage**|  nullable string| The source of funds used for a authorization.  
**paymentMethod**|  nullable string| The payment method used in the authorization.  
**threeDAuthenticated**|  nullable string| Indicates if 3D Secure authentication was completed for this authorization.  
**untokenizedCardSummary**|  nullable string| Last 4 digits of original PAN in case of network payment.  
**paymentLinkIdentifier**|  nullable string| A unique identifier for the payment link used to create authorization.  
**paymentLinkDescription**|  nullable string| A human-readable description of the payment link.

### Webhook Example
```json
{
    "checkoutReference": "9eh9g1loq8ygdmtj1kw47dbogkr2qyijyen53hnglpx2eq4213",
    "payfacReference": "OOJWITWVQV42PSE8",
    "merchantReference": "89807267361535",
    "amount": "100000",
    "currency": "ISK",
    "reason": "383528:1111:03/2030",
    "success": "true",
    "hmacSignature": "V/iaRHNyBnmqVG1mRCZUQo7HTX2sZGgDsJzajV1hOVs=",
    "additionalData": {
        "eventType": "Authorization",
        "authCode": "123456",
        "cardExpiryDate": "03/2030",
        "cardUsage": "Debit",
        "cardNumber": "411111******1111",
        "cardSummary": "1111",
        "paymentMethod": "VI",
        "threeDAuthenticated": "false",
        "paymentLinkIdentifier": "78c5ec6ea95477",
        "paymentLinkDescription": "Payment for Custom T-shirt Design"
    }
}
```
```

--------------------------------

### Tokenization Event Webhook Example

Source: https://docs.straumur.is/webhooks/payment/tokenization-event

This example demonstrates the structure of the JSON payload received for a successful tokenization event.

```APIDOC
## Tokenization Event Webhook

### Description
This webhook event is triggered when a tokenization request has been successfully completed during a payment, indicating that a new payment token has been created and is ready for use in future transactions. The event includes the generated token along with transaction details and payment method information for secure payment processing.

### Headers
In the Authorization header, we will set the matching Api key for your webhook.

### Fields

You will always get these fields:

- **checkoutReference** (nullable string): Unique identifier for the payment that was done through a checkout.
- **payfacReference** (string): Unique identifier for the payment generated by the payment service provider.
- **merchantReference** (nullable string): The identifier for the payment provided by you, the merchant, allowing for correlation with the merchant’s system.
- **amount** (string): The payment amount in the minor currency unit.
- **currency** (string): The three-letter ISO currency code.
- **reason** (nullable string): A field that provides additional context in case of payment errors or declines, helping diagnose specific issues.
- **success** (string): Indicates the payment status (true/false).
- **hmacSignature** (string): A cryptographic signature generated using a secret, enabling verification of the message authenticity and ensuring it hasn’t been tampered with.
- **additionalData** (object): An object for the additional details included in the event.

### Additional Data Fields

Fields you will get depend on the event type of the webhook:

- **eventType** (string): A string representing the type of event that occurred.
- **authCode** (nullable string): An authorization code is a unique series of letters or numbers generated by a card issuer or bank to validate a card payment.
- **cardExpiryDate** (nullable string): Card expiration date in "MM/yyyy" format.
- **cardNumber** (nullable string): A partially masked PAN.
- **cardSummary** (nullable string): Last 4 digits of PAN.
- **cardUsage** (nullable string): The source of funds used for a authorization.
- **originalPayfacReference** (nullable string): This field indicates the payment request associated with the original payment.
- **paymentMethod** (nullable string): The payment method used in the authorization.
- **threeDAuthenticated** (nullable string): Indicates if 3D Secure authentication was completed for this authorization.
- **untokenizedCardSummary** (nullable string): Last 4 digits of original PAN in case of network payment.
- **token** (string): A payment token you can use for future payments through API.
- **paymentLinkIdentifier** (nullable string): A unique identifier for the payment link used to create authorization.
- **paymentLinkDescription** (nullable string): A human-readable description of the payment link.

### Request Example
```json
{
    "checkoutReference": "w4znp75zopqwfpg60jhdz6sjhrgz210zefd5o2bcnmn3i8uu5w",
    "payfacReference": "OOJWITWVQV42PSE8",
    "merchantReference": "63666423116709",
    "amount": "250000",
    "currency": "ISK",
    "reason": "773206:1111:03/2030",
    "success": "true",
    "hmacSignature": "ag8i/dlOLFtGTFlDWo0NMhltf6iV4RM7NuNr7wwoUTE=",
    "additionalData": {
        "eventType": "Tokenization",
        "authCode": "123456",
        "cardExpiryDate": "30/2030",
        "cardNumber": "411111******1111",
        "cardSummary": "1111",
        "cardUsage": "Debit",
        "originalPayfacReference": "OOJWITWVQV42PSE8",
        "paymentMethod": "VI",
        "threeDAuthenticated": "false",
        "token": "69RX6F0Z8119CAB6",
        "paymentLinkIdentifier": "78c5ec6ea95477",
        "paymentLinkDescription": "Payment for Custom T-shirt Design"
    }
}
```
```

--------------------------------

### Capture Event Webhook Example

Source: https://docs.straumur.is/webhooks/payment/capture-event

This example demonstrates the structure of the JSON payload received for a Capture event webhook.

```APIDOC
## Capture Event Webhook

### Description
This webhook event is triggered when an authorized payment has been captured, indicating that the reserved funds have been successfully transferred from the customer's account. The event provides transaction details and references to the original authorization for complete payment tracking.

### Headers
In the Authorization header, we will set the matching Api key for your webhook.

### Fields
You will always get these fields.
Field| Type| Description
---|---|---
**checkoutReference**|  nullable string| Unique identifier for the payment that was done through a checkout.
**payfacReference**|  string| Unique identifier for the payment generated by the payment service provider.
**merchantReference**|  nullable string| The identifier for the payment provided by you, the merchant, allowing for correlation with the merchant’s system.
**amount**|  string| The payment amount in the minor currency unit.
**currency**|  string| The three-letter ISO currency code.
**reason**|  nullable string| A field that provides additional context in case of payment errors or declines, helping diagnose specific issues.
**success**|  string| Indicates the payment status (true/false).
**hmacSignature**|  string| A cryptographic signature generated using a secret, enabling verification of the message authenticity and ensuring it hasn’t been tampered with.
**additionalData**|  object| An object for the additional details included in the event.

### Additional Data Fields
Fields you will get depend on the event type of the webhook.
Field| Type| Description
---|---|---
**eventType**|  string| A string representing the type of event that occurred.
**authCode**|  nullable string| An authorization code is a unique series of letters or numbers generated by a card issuer or bank to validate a card payment.
**cardNumber**|  nullable string| A partially masked PAN.
**cardUsage**|  nullable string| The source of funds used for a payment.
**originalPayfacReference**|  nullable string| This field indicates the payment request associated with the original payment.
**paymentMethod**|  nullable string| The payment method used in the payment.

### Request Example
```json
{
    "checkoutReference": "lmisd8b2x3wob8xknx6d18z0k46setlx0rnt4zm45a10pcwqwx",
    "payfacReference": "3R5TU6ANXRUPA0YP",
    "merchantReference": "68699506042896",
    "amount": "50000",
    "currency": "ISK",
    "reason": "",
    "success": "true",
    "hmacSignature": "Fp/Jt3waPZq1cv1L2GScRWs9gOpcsLF9zOW/WKzi4s8=",
    "additionalData": {
        "eventType": "Capture",
        "authCode": "123457",
        "cardNumber": "411111******1111",
        "cardUsage": "Debit",
        "originalPayfacReference": "OOJWITWVQV42PSE8",
        "paymentMethod": "VI"
    }
}
```
```

--------------------------------

### Request Example - Card Tokenization for Future Use

Source: https://docs.straumur.is/payment-gateway/components/adyen-components/optional-parameters/recurring-processing-model

Example of a request body for card tokenization for future use, utilizing the CardOnFile recurringProcessingModel.

```APIDOC
## Request Example - Card Tokenization for Future Use
```json
{
  "terminalIdentifier": "1adfe4a1",
  "amount": 0,
  "currency": "ISK",
  "reference": "9990QQAZ1221",
  "channel": "Web",
  "origin": "https://www.your-ecommerce-website.com",
  "threeDsReturnUrl": "https://your-ecommerce-website.com/straumur_redirect",
  "recurringProcessingModel": "CardOnFile"
}
```
```

--------------------------------

### Install Adyen Web NPM Package

Source: https://docs.straumur.is/payment-gateway/components/adyen-components/web-integration

Install the recommended version of the Adyen Web npm package. This includes the latest features and bug fixes.

```bash
npm install @adyen/adyen-web@"^6.23.0" --save
```

--------------------------------

### Configuration with Placeholders

Source: https://docs.straumur.is/payment-gateway/components/straumur-components/web-component?parameter=localizations

Example demonstrating how to override default placeholder values within the payment fields using the `placeholders` parameter.

```APIDOC
## Configuration with Placeholders

### Description
This configuration extends the basic setup by including the `placeholders` object, which allows you to customize the default text or values displayed within various input fields of the payment form. For a comprehensive list of overridable placeholders, refer to the component's types on NPM.

### Parameters

- **environment** (string) - Required - Specifies the payment environment ('test' or 'live').
- **sessionId** (string) - Required - The payment session identifier obtained from the `/embeddedcheckout/session` endpoint.
- **onPaymentCompleted** (function) - Optional - A callback function executed when the payment is successfully completed.
- **onPaymentFailed** (function) - Optional - A callback function executed when the payment fails.
- **placeholders** (object) - Optional - An object used to override default placeholder values within the payment fields. Example: `{{cardNumber: "1234 5678 9012 3456"}}`.

### Request Example
```javascript
const paymentConfiguration = {
    environment: "test", // Change to 'live' for the live environment.
    // Use sessionId from /embeddedcheckout/session response
    sessionId: "ftsdre3h...e5h5as2q4",
    onPaymentCompleted: () => {
        console.info("onPaymentCompleted");
    },
    onPaymentFailed: () => {
        console.info("onPaymentFailed");
    },
    placeholders: {
      cardNumber: "1234 5678 9012 3456",
    },
};
```
```

--------------------------------

### Example Payment Gateway Response

Source: https://docs.straumur.is/payment-gateway/payments/external-3d-secure

This is an example of a successful payment response from the gateway, indicating an 'Authorised' status. The 'action' field is null when third-party 3DS is provided.

```json
{
  "checkoutReference": "fp3afbpdtsw3jw1br7lxi0lcd4gnfq6wxdrueeq2cwlks5vahj",
  "payfacReference": "T3WJMB84TFCCJ875",
  "reference": "9990QQAZ1221",
  "resultCode": "Authorised", 
  "action": null,  
  "responseDateTime": "2025-01-04T09:50:14.343503Z",
  "responseIdentifier": "e3605f81-6b09-4ce1-83ad-5a8d49f3cd44"
}
```

--------------------------------

### Authorised Response Example

Source: https://docs.straumur.is/payment-gateway/payments/additional-details

This is an example of a successful (Authorised) response from the /payment/details endpoint. It contains Straumur and merchant references, the result code, and timestamps.

```json
{
  "payfacReference": "T3WJMB84TFCCJ875",
  "reference": "9990QQAZ1221",
  "resultCode": "Authorised",
  "responseDateTime": "2025-01-04T09:50:14.343503Z",
  "responseIdentifier": "e3605f81-6b09-4ce1-83ad-5a8d49f3cd44"
}
```

--------------------------------

### Received Response Example

Source: https://docs.straumur.is/payment-gateway/modifications/adjust

This is an example of a successful 'Received' response. The system acknowledges the request and will process it, with final confirmation via webhook.

```json
{
  "status": "Received",
  "payfacReference": "ASDAKOS125152",
  "responseDateTime": "2024-09-04T09:50:14.343503Z",
  "responseIdentifier": "e3605f81-6b09-4ce1-83ad-5a8d49f3cd44"
}
```

--------------------------------

### Example Response - Pay by Link

Source: https://docs.straumur.is/payment-gateway/payment-links/api/get-payment-link-details

This JSON object represents the detailed information returned for a 'Pay by Link' payment.

```json
{
  "paymentLink": {
    "terminalIdentifier": "1adfe4a1",
    "paymentLinkReference": "30001aylo2a",
    "themeKey": "441368-7a47f",
    "description": "Payment for PlayStation 2 HDMI Adapter.",
    "amount": 20000,
    "currency": "ISK",
    "returnUrl": null,
    "status": "Active",
    "culture": "is",
    "type": "PayByLink",
    "url": "https://pay.example.com/link/30001aylo2a",
    "createdAt": "2025-01-01T09:50:14.343503Z",
    "validUntil": null,
    "recurringProcessingModel": null,
    "visitCount": 69,
    "salesCount": 1,
    "maxSalesCount": null,
    "items": [
      {
        "name": "Playstation 2 Analog RCA/SCART to HDMI Adapter Low Latency",
        "quantity": 1,
        "amountWithoutDiscount": 25000,
        "amount": 20000,
        "unitPrice": 20000
      }
    ],
    "shopperInfos": [
      {
        "field": "Ssn",
        "requirementType": "Required",
        "prefilledValue": null
      }
    ],
    "submissions": [
      {
        "answers": [
          {
            "field": "Ssn",
            "value": "1111111119"
          }
        ],
        "completed": true,
        "amount": 20000,
        "currency": "ISK",
        "token": null
      }
    ]
  },
  "responseDateTime": "2025-01-04T09:50:14.343503Z",
  "responseIdentifier": "e3605f81-6b09-4ce1-83ad-5a8d49f3cd44"
}
```

--------------------------------

### Additional Details Request Example

Source: https://docs.straumur.is/payment-gateway/payments/additional-details

This is an example of the request body sent to the /payment/details endpoint. It includes the checkout reference and the redirect result from the 3DS authentication.

```json
{
  "checkoutReference": "fp3afbpdtsw3jw1br7lxi0lcd4gnfq6wxdrueeq2cwlks5vahj",
  "redirectResult": "Ab02b4c0..."
}
```

--------------------------------

### Terminal Added Event Webhook Example

Source: https://docs.straumur.is/webhooks/merchant-management/terminal-added-event

This example demonstrates the structure of the JSON payload received when a new terminal is added to a merchant account. It includes essential identification details and additional event-specific data.

```APIDOC
## Terminal Added Event

This webhook event is triggered when a new terminal has been added to a merchant account, indicating that a new payment terminal is now available for processing transactions. The event provides terminal identification details, merchant information, and contract references for proper terminal management and integration.

### Webhook Example

```json
{
    "partnerContractNumber": "73538280",
    "ssn": "1111111119",
    "merchantNumber": "7366746",
    "contractNumber": "32305",
    "mid": "2913122972",
    "tid": "3fdd19ef",
    "terminalIdentifier": "3703ed39e197",
    "hmacSignature": "Z3FZxGhaGu0w9tm+xBEtw/laiXr4QPRQMn0YWERrjOs=",
    "additionalData": {
        "eventType": "TerminalAdded",
        "eventTime": "2025-09-19T10:14:46.6730082Z",
        "street": "Borgartún 25",
        "city": "Reykjavík",
        "postalCode": "105",
        "state": "IS",
        "country": "ISL",
        "mcc": "5411",
        "shopperStatement": "Example Store",
        "terminalType": "Cards"
    }
}
```

### Headers

In the Authorization header, we will set the matching Api key for your webhook.

### Fields

You will always get these fields.

Field| Type| Description
---|---|---
**partnerContractNumber**|  string| Unique identifier of partner contract that links the terminal to a specific partner agreement.
**ssn**|  string| The merchant SSN.
**merchantNumber**|  string| Unique identifier for the merchant account to which the terminal is being added.
**contractNumber**|  string| Unique identifier of the merchant contract associated with the terminal.
**mid**|  string| Unique identifier assigned to the store.
**tid**|  string| Unique indetifier assigned to the added terminal device.
**terminalIdentifier**|  nullable string| Unique terminal identifier used in payment gateway API calls to identify terminal.
**hmacSignature**|  string| A cryptographic signature generated using a secret, enabling verification of the message authenticity and ensuring it hasn’t been tampered with.
**additionalData**|  object| An object for the additional details included in the event.

#### Additional Data Fields

Fields you will get depend on the event type of the webhook.

Field| Type| Description
---|---|---
**eventType**|  string| A string representing the type of event that occurred.
**eventTime**|  string| ISO 8601 timestamp indicating when the terminal addition event occurred.
**street**|  nullable string| The street address of the store.
**city**|  nullable string| The city of the store.
**postalCode**|  nullable string| The postal code of the store.
**state**|  nullable string| The ISO 3166-1 alpha-2 country code of the store.
**country**|  nullable string| The ISO 3166-1 alpha-3 country identifier of the store.
**mcc**|  nullable string| The Merchant Category Code (MCC) of the store.
**shopperStatement**|  nullable string| The shopper statement (DBA name) displayed on cardholder statements.
**terminalType**|  nullable string| The type of terminal. Possible values: `Aur`, `Cards`.
```

--------------------------------

### Updating Component Configuration

Source: https://docs.straumur.is/payment-gateway/components/straumur-components/web-component?parameter=locale

Shows how to initialize the Straumur checkout and update its configuration after mounting, for example, to change the locale.

```APIDOC
## Updating Component Configuration

### Description
This example illustrates how to initialize the Straumur checkout component with an initial configuration and subsequently update its configuration after the component has been mounted. This is particularly useful for dynamic changes, such as updating the locale or other settings without re-initializing the entire component.

### Method
- **StraumurCheckout(configuration)**: Constructor to initialize the payment component.
- **mount(selector)**: Method to mount the checkout component into a specified DOM element.
- **updateConfig(newConfiguration)**: Method to update the component's configuration and re-render.

### Request Example
```javascript
// Initialize with basic configuration
const paymentConfiguration = {
    environment: "test", // Change to 'live' for the live environment.
    // Use sessionId from /embeddedcheckout/session response
    sessionId: "ftsdre3h...e5h5as2q4",
    onPaymentCompleted: () => {
        console.info("onPaymentCompleted");
    },
    onPaymentFailed: () => {
        console.info("onPaymentFailed");
    },
};

const paymentCheckout = new StraumurCheckout(paymentConfiguration);

// Mount the checkout component into a container
paymentCheckout.mount("#paymentContainer");

// Update configuration (e.g., change locale)
paymentCheckout.updateConfig({ locale: "en-US" });

// Update configuration with locale and custom localizations
paymentCheckout.updateConfig({ locale: "en-US", customLocalizations: { "en-US": { "cards.title": "My Card Title" } } });
```
```

--------------------------------

### Configuration with Instant Payments

Source: https://docs.straumur.is/payment-gateway/components/straumur-components/web-component?parameter=localizations

Example showing how to configure which instant payment methods (like Google Pay or Apple Pay) to display using the `instantPayments` parameter.

```APIDOC
## Configuration with Instant Payments

### Description
This configuration demonstrates the use of the `instantPayments` parameter to specify which digital wallet buttons (e.g., Google Pay, Apple Pay) should be displayed to the user and in what order. This enhances the checkout experience by offering quick payment options.

### Parameters

- **environment** (string) - Required - Specifies the payment environment ('test' or 'live').
- **sessionId** (string) - Required - The payment session identifier obtained from the `/embeddedcheckout/session` endpoint.
- **onPaymentCompleted** (function) - Optional - A callback function executed when the payment is successfully completed.
- **onPaymentFailed** (function) - Optional - A callback function executed when the payment fails.
- **instantPayments** (array) - Optional - An array of strings specifying the instant payment methods to display, such as `"googlepay"` and/or `"applepay"`.

### Request Example
```javascript
const paymentConfiguration = {
    environment: "test", // Change to 'live' for the live environment.
    // Use sessionId from /embeddedcheckout/session response
    sessionId: "ftsdre3h...e5h5as2q4",
    onPaymentCompleted: () => {
        console.info("onPaymentCompleted");
    },
    onPaymentFailed: () => {
        console.info("onPaymentFailed");
    },
    instantPayments: ["applepay", "googlepay"],
};
```
```

--------------------------------

### Basic Checkout Request Example

Source: https://docs.straumur.is/hosted-checkout/basic-checkout-request

This JSON object represents a basic checkout request. Ensure the amount is in minor units and the currency code is valid. The returnUrl must start with http:// or https://.

```json
{
  "amount": 48900,
  "currency": "ISK",
  "returnUrl": "https://your-ecommerce-website.com/straumur_redirect",
  "reference": "9990QQAZ1221",
  "terminalIdentifier": "1adfe4a1"
}
```

--------------------------------

### Configuration with Instant Payments

Source: https://docs.straumur.is/payment-gateway/components/straumur-components/web-component

This example shows how to configure the Straumur Web Component to display specific instant payment wallet buttons.

```APIDOC
## Configuration with Instant Payments

### Description
This configuration utilizes the `instantPayments` parameter to specify which digital wallet buttons (e.g., Google Pay, Apple Pay) should be displayed and in what order on the payment interface.

### Parameters
- **environment** (string) - Required - Specifies the payment environment ('test' or 'live').
- **sessionId** (string) - Required - The unique identifier for the payment session.
- **onPaymentCompleted** (function) - Optional - A callback function executed when the payment is successfully completed.
- **onPaymentFailed** (function) - Optional - A callback function executed when the payment fails.
- **instantPayments** (array) - Optional - An array of strings specifying the instant payment wallets to display (e.g., `["googlepay", "applepay"]`).

### Request Example
```javascript
const paymentConfiguration = {
    environment: "test", // Change to 'live' for the live environment.
    // Use sessionId from /embeddedcheckout/session response
    sessionId: "ftsdre3h...e5h5as2q4",
    onPaymentCompleted: () => {
        console.info("onPaymentCompleted");
    },
    onPaymentFailed: () => {
        console.info("onPaymentFailed");
    },
    instantPayments: ["applepay", "googlepay"],
};
```
```

--------------------------------

### Request Example with Shopper Contact

Source: https://docs.straumur.is/hosted-checkout/optional-parameters/shopper-contact

An example of a checkout request including the shopperContact field.

```APIDOC
## Request Example

```json
{
  "amount": 48900,
  "currency": "ISK",
  "returnUrl": "https://your-ecommerce-website.com/straumur_redirect",
  "reference": "9990QQAZ1221",
  "shopperContact": "shopper@example.com"
}
```
```

--------------------------------

### Instant Payments Configuration

Source: https://docs.straumur.is/payment-gateway/components/straumur-components/web-component?parameter=locale

Demonstrates how to configure which instant payment wallet buttons to display using the `instantPayments` parameter.

```APIDOC
## Instant Payments Configuration

### Description
The `instantPayments` parameter allows you to specify which instant payment wallet buttons (e.g., Google Pay, Apple Pay) should be displayed and in what order. This provides a streamlined checkout experience for users who prefer these payment methods.

### Parameters
#### Request Body
- **instantPayments** (array) - Optional - Defines which instant payment wallet buttons to display and in what order. Accepts `googlepay` and/or `applepay`.

### Request Example
```javascript
const paymentConfiguration = {
    environment: "test", // Change to 'live' for the live environment.
    // Use sessionId from /embeddedcheckout/session response
    sessionId: "ftsdre3h...e5h5as2q4",
    onPaymentCompleted: () => {
        console.info("onPaymentCompleted");
    },
    onPaymentFailed: () => {
        console.info("onPaymentFailed");
    },
    instantPayments: ["applepay", "googlepay"],
};
```
```

--------------------------------

### Mounting and Updating Configuration

Source: https://docs.straumur.is/payment-gateway/components/straumur-components/web-component?parameter=localizations

This snippet shows how to instantiate the StraumurCheckout, mount it to a DOM element, and update its configuration after initialization.

```APIDOC
## Mounting and Updating Configuration

### Description
This example illustrates the complete lifecycle of using the Straumur Web Component. It covers initializing the component with a configuration object, mounting it to a specified container in the DOM, and subsequently updating the component's configuration dynamically using the `updateConfig` method. This allows for runtime changes to parameters like locale or localizations.

### Initialization and Mounting

1.  **Instantiate `StraumurCheckout`**: Create a new instance of the checkout component, passing your `paymentConfiguration` object.
2.  **Mount the Component**: Use the `mount` method to attach the checkout interface to a specific HTML element on your page, identified by a CSS selector or a direct DOM reference.

### Updating Configuration

-   **`updateConfig()`**: This method allows you to modify the component's settings after it has been initialized and mounted. It accepts a configuration object with the parameters you wish to change.
    -   **No arguments**: Calling `updateConfig()` without arguments re-renders the component with its current configuration.
    -   **With arguments**: Passing a configuration object (e.g., `{ locale: "en-US" }`) updates the specified parameters and re-renders the component.

### Request Example
```javascript
// Initial configuration
const paymentConfiguration = {
    environment: "test", // Change to 'live' for the live environment.
    // Use sessionId from /embeddedcheckout/session response
    sessionId: "ftsdre3h...e5h5as2q4",
    onPaymentCompleted: () => {
        console.info("onPaymentCompleted");
    },
    onPaymentFailed: () => {
        console.info("onPaymentFailed");
    },
};

// Instantiate the checkout component
const paymentCheckout = new StraumurCheckout(paymentConfiguration);

// Mount the checkout component into a container element
// Use a DOM selector (e.g., '#paymentContainer') or a direct DOM reference
paymentCheckout.mount("#paymentContainer");

// Example: Re-render with the same initial configuration
paymentCheckout.updateConfig();

// Example: Update the locale and re-render
paymentCheckout.updateConfig({ locale: "en-US" });

// Example: Update locale and custom localizations, then re-render
paymentCheckout.updateConfig({
    locale: "en-US",
    customLocalizations: {
        "en-US": {
            "cards.title": "My Card Title"
        }
    }
});
```
```

--------------------------------

### Mounting and Updating the Component

Source: https://docs.straumur.is/payment-gateway/components/straumur-components/web-component

This snippet demonstrates how to instantiate the Straumur Web Component, mount it to a DOM element, and update its configuration after initialization.

```APIDOC
## Mounting and Updating the Component

### Description
This section covers the lifecycle of the Straumur Web Component, from its instantiation with a configuration object, mounting it into a specified container in the DOM, to updating its configuration dynamically after it has been rendered.

### Initialization and Mounting
1. Create a `paymentConfiguration` object with the necessary parameters.
2. Instantiate the `StraumurCheckout` with the configuration.
3. Mount the component to a DOM element using its `mount` method.

### Updating Configuration
- Use the `updateConfig()` method on the `StraumurCheckout` instance to re-render the component with new settings.
- This method can be called with no arguments to re-render with the initial configuration, or with a new configuration object to apply specific changes.

### Code Example
```javascript
// Initial configuration
const paymentConfiguration = {
    environment: "test", // Change to 'live' for the live environment.
    // Use sessionId from /embeddedcheckout/session response
    sessionId: "ftsdre3h...e5h5as2q4",
    onPaymentCompleted: () => {
        console.info("onPaymentCompleted");
    },
    onPaymentFailed: () => {
        console.info("onPaymentFailed");
    },
};

// Instantiate the checkout component
const paymentCheckout = new StraumurCheckout(paymentConfiguration);

// Mount the checkout component into a container
// Replace '#paymentContainer' with your actual DOM selector or element reference
paymentCheckout.mount("#paymentContainer");

// Example: Re-render with the same initial configuration
paymentCheckout.updateConfig();

// Example: Re-render with a new locale
paymentCheckout.updateConfig({ locale: "en-US" });

// Example: Re-render with updated locale and custom localizations
paymentCheckout.updateConfig({ locale: "en-US", customLocalizations: { "en-US": { "cards.title": "My Card Title" } } });
```
```

--------------------------------

### Delayed Capture Request Example

Source: https://docs.straumur.is/payment-gateway/payments/optional-parameters/delayed-capture

Example of a payment request including the `captureHoursDelay` field to schedule a delayed capture.

```APIDOC
## Request Example
```json
{
  "amount": 48900,
  "currency": "ISK",
  "returnUrl": "https://your-ecommerce-website.com/straumur_redirect",
  "reference": "9990QQAZ1221",
  "captureHoursDelay": 24 // Payment will be automatically captured 24 hours after authorization
}
```
```

--------------------------------

### Pre-Authorization Request Example

Source: https://docs.straumur.is/payment-gateway/components/straumur-components/optional-parameters/pre-authorization

Use this JSON payload to initiate a pre-authorization. Set `isPreAuth` to `true` to indicate a pre-authorization request. Manual capture or a capture delay must be configured if you intend to adjust the amount later.

```json
{
  "terminalIdentifier": "1adfe4a1",
  "amount": 48900,
  "currency": "ISK",
  "reference": "9990QQAZ1221",
  "origin": "https://www.your-ecommerce-website.com",
  "threeDsReturnUrl": "https://your-ecommerce-website.com/straumur_redirect",
  "isPreAuth": true
}
```

--------------------------------

### Request Example with Expiry Date

Source: https://docs.straumur.is/payment-gateway/components/straumur-components/optional-parameters/expiry-date

An example of a checkout request including the 'expiresAt' field to set a custom expiry time.

```APIDOC
## Request Example

```json
{
  "terminalIdentifier": "1adfe4a1",
  "amount": 48900,
  "currency": "ISK",
  "reference": "9990QQAZ1221",
  "origin": "https://www.your-ecommerce-website.com",
  "threeDsReturnUrl": "https://your-ecommerce-website.com/straumur_redirect",
  "expiresAt": "2023-03-15T12:00:00.000Z"
}
```
```
Tokens:
Raw