```
### Automatic dark mode
To switch between the light and dark variants based on the user's system preference, use a `
When you specify a cart you can add one or more gift cards like the following example:
```json
[
{
"id": "10001",
"description": "Product 1",
"unitPrice": 95.0,
"quantity": 1,
"vat": 25.0
},
{
"id": "10002",
"description": "Gift Card 50",
"type": "GiftCard",
"unitPrice": -50.0,
"quantity": 1,
"vat": 0.0
},
{
"id": "10003",
"description": "Gift Card 100",
"type": "GiftCard",
"unitPrice": -100.0,
"quantity": 1,
"vat": 0.0
},
{
"id": "10004",
"description": "Gift Card 100",
"type": "GiftCard",
"unitPrice": -100.0,
"quantity": 1,
"vat": 0.0
}
]
```
If multiple giftcards are specified, the ones with the lowest amounts are used first, and the ones with higher amount can be used partly or not at all. When you [get checkout information](/docs/checkout/getcheckoutinformation) you will get a response similar to:
```json
{
"totalAmount": -155.0,
"items": [
{
"id": "10001",
"description": "Product 1",
"unitPrice": 95.0,
"quantity": 1,
"vat": 25.0
},
{
"id": "10002",
"description": "Gift Card 50",
"type": "GiftCard",
"unitPrice": -50.0,
"quantity": 1,
"vat": 0.0,
"usedAmount": 50.0
},
{
"id": "10003",
"description": "Gift Card 100",
"type": "GiftCard",
"unitPrice": -100.0,
"quantity": 1,
"vat": 0.0,
"usedAmount": 45.0
},
{
"id": "10004",
"description": "Gift Card 100",
"type": "GiftCard",
"unitPrice": -100.0,
"quantity": 1,
"vat": 0.0,
"usedAmount": 0.0
}
]
}
```
Using this information you can decide which gift cards and amounts are used by using `usedAmount`. The remaining amount is calculated by adding `unitPrice` and `usedAmount`. `totalAmount` can be negative if not all gift cards are used and reflects the total remaining amount of the gift cards.
---
# Inventory Validation and Reservation
Source: https://dev.walleypay.com/docs/checkout/common-use-cases/inventory-validation.md
Choose how to validate stock and reserve inventory during checkout, so that
you stop overselling without adding friction for the customer.
This guide compares three strategies for validating stock availability and reserving inventory during the checkout process.
## Overview of approaches
There are three main approaches to handle inventory during checkout:
| Approach | When to Validate | Best For |
|----------|------------------|----------|
| **No Validation** | After payment | Digital products, low-traffic stores |
| **Pre-Payment Validation** | Before payment | Standard e-commerce, stock checking |
| **Advanced Validation** | Before payment, Failed payment | Complex rules, Inventory reservation, Gift cards |
## Comparison matrix
Choose the right approach based on your requirements:
| Criteria | No Validation | Pre-Payment Validation | Advanced Callbacks |
|----------|--------------|----------------------|-------------------|
| **Overselling Prevention** | ❌ None | ✅ Good | ✅ Excellent |
| **Checkout Speed** | ⚡ Fastest | 🐌 Slower (+10s max) | 🐌 Slower (+10s max) |
| **Implementation Complexity** | ✅ Simple | ✅ Simple | ⚠️ Medium |
| **Conversion Rate Impact** | ✅ None | ⚠️ Potential negative | ⚠️ Potential negative |
| **Custom Validation** | ❌ No | ⚠️ Limited | ✅ Full support |
| **Rollback Support** | N/A | ❌ No | ✅ Yes (PaymentFailed) |
| **HTTP Method** | N/A | GET | POST with body |
## Approach 1: No validation (notification only)
### Overview
The simplest approach relies solely on the [notification callback](/docs/checkout/notificationcallback) to process orders after payment completion. No pre-payment validation is performed.
### Configuration
```json
{
"storeId": 123,
"countryCode": "SE",
"merchantTermsUri": "https://myshop.com/terms",
"notificationUri": "https://api.myshop.com/notifications/{checkout.id}",
"cart": {
"items": [...]
}
}
```
### When to use
- **Digital products** - No physical inventory to manage
- **Made-to-order products** - Items created after purchase
- **Low-traffic stores** - Minimal risk of simultaneous purchases
- **Services** - No stock limitations
### Pros and cons
✅ **Advantages:**
- Fastest checkout experience
- Simplest implementation
- No timeout concerns
- Highest conversion rate
❌ **Disadvantages:**
- Risk of overselling
- Customer disappointment if items unavailable
- Manual handling of out-of-stock situations
### How it works
1. Customer completes payment through Walley Checkout
2. Walley sends GET request to your `notificationUri`
3. Your backend receives the notification
4. Check if order was already processed (idempotency)
5. Retrieve checkout information using the checkout ID
6. If status is `PurchaseCompleted`:
- Deduct inventory from stock
- Create the order in your system
- Send confirmation email to customer
7. Respond with `200 OK` to confirm receipt
---
## Approach 2: Pre-payment validation
### Overview
Validate stock availability just before payment is processed using the `validationUri`. This provides a final check to ensure items are in stock before the customer's payment is authorized.
### Architecture
```
Customer completes checkout form
↓
Customer clicks "Complete Purchase"
↓
Walley calls validationUri (GET)
↓
Your backend checks stock availability
↓
Response: Success or Error
↓
If success → Process payment
↓
If payment succeeds → Notification callback
```
### Configuration
```json
{
"storeId": 123,
"countryCode": "SE",
"merchantTermsUri": "https://myshop.com/terms",
"notificationUri": "https://api.myshop.com/notifications/{checkout.id}",
"validationUri": "https://api.myshop.com/validate/{checkout.id}",
"cart": {
"items": [...]
}
}
```
### When to use
- **Standard e-commerce** - Typical online stores with inventory management
- **Medium traffic** - Moderate number of concurrent users
- **Simple validation** - Primary need is stock availability checking
- **Quick implementation** - Simpler than reservation systems
### Pros and cons
✅ **Advantages:**
- Prevents overselling at point of payment
- No reservation state to manage
- Simple to implement
- Works with existing inventory systems
❌ **Disadvantages:**
- Adds latency to checkout (up to 10 seconds)
- No rollback mechanism if payment fails
- Customer may lose item during checkout
- Multiple validation calls possible
### How it works
1. Customer completes checkout form and clicks "Complete Purchase"
2. Walley calls your `validationUri` with a GET request
3. Your validation endpoint:
- Retrieves checkout information using the checkout ID
- Checks stock availability for all items
- Returns success (200 OK) or error (400/500) response
4. If validation succeeds:
- Payment is processed
- Order can optionally be created in pending state
5. If validation fails:
- Customer sees error message
- Purchase is not completed
6. After successful payment:
- Walley sends notification to `notificationUri`
- Your backend finalizes the order
- Inventory is deducted
- Confirmation email is sent
### Key considerations
- **10-Second Timeout**: Validation must complete within 10 seconds
- **Multiple Calls**: Validation may be called multiple times if customer retries
- **Idempotency**: Handle duplicate validation requests gracefully
- **Error Messages**: Provide clear feedback about unavailable items
:::warning Important
Even if validation succeeds, the purchase may still fail due to credit checks or payment issues. Always treat the order as pending until receiving the `notificationUri` callback with `PurchaseCompleted` status.
:::
---
## Approach 3: Advanced validation with callbacks
### Overview
Use the [callback object](/docs/checkout/optional/init-checkout-features#callback-object) with `ValidateOrder` and `PaymentFailed` callback types for advanced validation scenarios with built-in rollback support.
### Configuration
```json
{
"storeId": 123,
"countryCode": "SE",
"merchantTermsUri": "https://myshop.com/terms",
"notificationUri": "https://api.myshop.com/notifications/{checkout.id}",
"callback": {
"callbackUri": "https://api.myshop.com/callbacks/{checkout.id}",
"callbackTypes": ["ValidateOrder", "PaymentFailed"]
},
"cart": {
"items": [...]
}
}
```
### When to use
- **Complex validation rules** - Multiple checks beyond stock (customer eligibility, regional restrictions)
- **Rollback requirements** - Need to handle payment failures gracefully
- **Multiple validation steps** - Customer verification, business rules, inventory reservation, gift cards
### Pros and cons
✅ **Advantages:**
- Prevents overselling
- Supports complex business logic
- Built-in rollback via PaymentFailed callback
- Structured request/response format
❌ **Disadvantages:**
- Adds latency to checkout (up to 10 seconds)
- More complex than validationUri
- Requires fast backend response
- May lower conversion rate if slow
### Callback flow
```
Customer completes checkout form
↓
Customer clicks "Complete Purchase"
↓
Walley calls ValidateOrder callback (POST)
↓
Your backend: Check stock, validate rules
↓
Response: Success or Error
↓
If success → Process payment
↓
If payment fails → PaymentFailed callback
↓
If payment succeeds → Notification callback
```
### How it works
**ValidateOrder Callback:**
1. Walley sends POST request to your `callbackUri` with type `ValidateOrder`
2. Request body includes `checkoutId` and `publicToken` for verification
3. Your backend:
- Retrieves checkout information
- Checks stock availability
- Validates customer eligibility (if needed)
- Validates business rules (regional restrictions, etc.)
- Optionally reserves inventory
- Creates pending order
4. Response options:
- **Success (200 OK)**: Return `{ orderReference: "ORDER-123" }` (optional)
- **Error (400)**: Return `{ title: "...", message: "...", clientPayload: {...} }`
- **Timeout/Error (500)**: Customer sees generic error
As shown in the diagram, the Checkout frontend identifies the customer and then asks the Checkout API for delivery methods. The API fetches them from your adapter and returns them to be rendered alongside the payment methods. Once the customer has chosen a delivery and payment option and completed the purchase, the API optionally creates an external shipment against your adapter, then notifies you so you can fetch the checkout and read the selection.
## GET delivery methods
Walley Checkout fetches the list of available delivery methods every time the customer changes any relevant information that might lead to a change in available delivery methods, e.g. the customer changes delivery address or updates the cart.
### Custom request parameters
When the Checkout sends the GET request to the delivery adapter, apart from some [default parameters](#default-request-query-parameters), a merchant can send custom parameters called `ShippingProperties` that are related to the cart.
This is done in either [Initialize checkout](/docs/checkout/initcheckout), [Update checkout](/docs/checkout/optional/updatecheckout) or [Update cart](/docs/checkout/optional/updatecart).
## POST create external shipment
Creating an external shipment is an optional step with the intent to produce an identifier that we will give to the merchant as an easier way to reference the shipment.
For each shipment on the order we will make a POST call to a configured endpoint. The data is a slimmed down version of the shipments data we received in GET delivery methods, but only containing the information selected by the customer.
### Request
### Response
```json
{
"externalShipmentId": "external-shipment-id-1"
}
```
---
# Delivery Icons
Source: https://dev.walleypay.com/docs/checkout/delivery/delivery-icons.md
When using any delivery Adapter except Ingrid then you can use Delivery Icons.
With Ingrid this is configured on Ingrid's side. There are three types of
delivery icons: [Carrier logo icons](#carrier-logo-icons), [Walley
icons](#walley-icons) and [Custom icon](#custom-icon)
## Carrier logo icons
| Value | Icon |
| --------------- | ------------------------------------------- |
| **airmee** | |
| **best** | |
| **bring** | |
| **bringred** | |
| **budbee** | |
| **citymail** | |
| **dbschenker** | |
| **dhl** | |
| **dooris** | |
| **dsv** | |
| **earlybird** | |
| **gordon** | |
| **helthjem** | |
| **instabox** | |
| **matkahuolto** | |
| **movebybike** | |
| **posti** | |
| **postnord** | |
| **wolt** | |
## Walley icons
| Value | Icon |
| ---------------- | --------------------------------------------- |
| **walley-home** | |
| **walley-mail** | |
| **walley-plane** | |
| **walley-ship** | |
| **walley-store** | |
| **walley-truck** | |
| **_default_ \*** | |
\* Default icon is used if no value is provided, or if the value mismatches with any of the available icon property values.
## Custom icon
Icon property value: `custom-
## How to get started 🚀
1. Contact [Walley Merchant Services](/support) for help with setup in our test environment and for questions regarding integration with Walley Checkout.
2. Create a nShift DeliveryCheckout configuration. Visit [nShift](https://nshift.com/products/delivery-checkout) to read more and contact nShift for questions regarding prices, configuration etc.
3. Provide Walley Merchant Services with the nShift api-credentials (`Id` and `Secret Id`) as well as the `Delivery Checkout Id` and `Quick Id` of the sender to use as well as what [fallback strategy](./introduction-delivery-module#fallback-strategy-and-shipping-fees) to use. Once a DeliveryCheckout configuration is in place and properly tested in the test environment, then you are good to go. **Note**: Once the `Quick Id` has been set it must not change.
:::info Important
During test and development, you can use the nShift DeliveryCheckout production configuration. However, this means purchases made in the Walley test environment will create [prepared shipments](/docs/checkout/delivery/get-selected-delivery-method#nshift-delivery-adapter) against your nShift production account.
Treat such prepared shipments as test.
:::
:::info
If you update the delivery configuration while running in production, read the section on how to work with [versions](https://help.unifaun.com/udc-se/en/18540-versions.html). Versions make it possible to create a [prepared shipment](/docs/checkout/delivery/get-selected-delivery-method#nshift-delivery-adapter) for customers that fetched delivery methods with the older configuration.
:::
---
# Deprecation Notice – Migration from checkout-api.collector.se to walleypay.com
Source: https://dev.walleypay.com/docs/checkout/deprecation-notice-collector-api.md
The Checkout API hosted on the collector.se domain is being retired. Move your
integration to a walleypay.com URL to keep it working.
:::warning Shutdown date: 31st of October 2026
The **Walley Checkout API** currently hosted on the `collector.se` domain is deprecated and will be permanently shut down on **31st of October 2026**. Until then, it continues to work as before.
:::
Merchants and platforms **must update their integration** to use a URL on the `walleypay.com` domain before this date.
Only the domain is being retired, the API itself is not changing. You have two migration options, described below.
## What is changing?
**Old URL (deprecated):**
```
https://checkout-api.collector.se
```
**New URL (minimal change):**
```
https://api-legacy.checkout.walleypay.com
```
**Or migrate to the current Walley API (recommended):**
```
https://api.walleypay.com
```
## Option 1: Migrate to the current Walley API (recommended)
The current version of the Checkout API is hosted on `api.walleypay.com` and uses **Bearer token authentication** instead of SharedKey. This is the version all new integrations use, and it is where the platform is actively developed.
Migrating involves:
1. Generate API credentials (client id and secret) in [Walley Merchant Hub](https://merchanthub.walleypay.com), see [Authentication](/docs/checkout/authorization).
2. Request an access token from the authentication endpoint and send it as an `Authorization: Bearer {access_token}` header on every request.
3. Use the current endpoints, e.g. `POST https://api.walleypay.com/checkouts` to initialize a checkout session, see [Endpoints](/docs/checkout/endpoints) and [Initialize Checkout](/docs/checkout/initcheckout).
The request and response payloads are the same as you use today, so for most integrations this is a change of authentication and base URL only.
## Option 2: Change the URL only (minimal change)
If you cannot make code changes right now, you can keep your existing integration exactly as it is and only replace the hostname. All request paths stay the same, whichever style your integration uses today:
**Example: initialize a checkout**
```
Old: POST https://checkout-api.collector.se/checkouts
New: POST https://api-legacy.checkout.walleypay.com/checkouts
```
**Example: update the cart (older path style)**
```
Old: PUT https://checkout-api.collector.se/merchants/{storeId}/checkouts/{checkoutId}/cart
New: PUT https://api-legacy.checkout.walleypay.com/merchants/{storeId}/checkouts/{checkoutId}/cart
```
Your existing **SharedKey authentication and request signing continue to work unchanged** on the new hostname, no code changes, no new credentials. Only the base URL in your configuration changes.
:::info Transitional domain
`api-legacy.checkout.walleypay.com` is a transitional domain for existing SharedKey integrations. It will remain available during the migration period, but new functionality is only released on the current API. We recommend planning a move to [Option 1](#option-1-migrate-to-the-current-walley-api-recommended) when possible.
:::
## Test environment
The same migration applies to the test environment:
**Old test URL (deprecated):**
```
https://checkout-api-uat.collector.se
```
**New test URL (minimal change):**
```
https://api-legacy.checkout.uat.walleydev.com
```
**Or the current Walley API (recommended):**
```
https://api.uat.walleydev.com
```
## Required action
All merchants and platform partners must, before **31st of October 2026**:
1. Choose a migration option:
- **Option 1 (recommended):** Implement the current Walley API on `api.walleypay.com` with Bearer token authentication.
- **Option 2 (minimal change):** Replace the hostname `checkout-api.collector.se` with `api-legacy.checkout.walleypay.com` in your configuration.
2. Verify that your integration continues to work as expected: initialize a checkout session and confirm that order administration flows work in your test environment before changing production.
## Questions?
If you have any questions or need assistance with the migration, please contact our support team.
---
# Deprecation Notice – Migration from collector.se to walleypay.com
Source: https://dev.walleypay.com/docs/checkout/deprecation-notice-collector-loader.md
The Collector Checkout Loader script hosted on the collector.se domain is
being retired. Move your integration to the walleypay.com URL to keep it
working.
:::warning Shutdown date: 1st of October 2026
The `collector-checkout-loader.js` script on the `collector.se` domain is deprecated and will be shut down on **1st of October 2026**.
:::
Merchants and platforms **must update their integration** to use the new URL on the `walleypay.com` domain.
## What is changing?
**Old URL (deprecated):**
```html
```
**Or (deprecated):**
```html
```
**New URL (current):**
```html
```
## Test environment
The same migration applies to the test environment:
**Old test URL (deprecated):**
```html
```
**New test URL (current):**
```html
```
## Timeline
- Current behavior: Requests to the old URL are automatically redirected (HTTP 301) to the new one.
- Deprecation period: The collector.se domain will remain online until **1st of October 2026** to allow time for migration.
- Shutdown: After this period, the old domain will be permanently shut down and no longer serve the script.
## Required action
All merchants and platform partners must:
1. Replace all references to:
```html
```
or:
```html
```
with:
```html
```
2. Verify that your integration continues to work as expected.
:::warning Important
Failure to update before the shutdown will result in checkout integrations **no longer functioning**.
:::
## Questions?
If you have any questions or need assistance with the migration, please contact our support team.
---
# Strong customer identification for all credit purchases
Source: https://dev.walleypay.com/docs/checkout/embedded/sca-on-all-purchases.md
A new law on the Swedish market to strongly identify customers when offering credit payments online expected to become final in January 2023.
The reason is to limit fraudulent behavior when using credits in online shopping.
[Read more on the Swedish Government website](https://www.regeringen.se/rattsliga-dokument/lagradsremiss/2022/07/stark-kundautentisering-vid-fakturabetalningar-online/)
## What is required
When a consumer purchases online the consumer must be strongly identified using two-factor authentication.
## Primary solution
Walley see that the best option going forward is to embed Walley on your e-commerce site.
The reason behind this is that offering end customers credits is currently under a lot of investigations from authorities in the Nordic countries.
To be future proof we encourage you to use this solution.
## Overview
These are the basic steps you need to take
### 1. Embed Walley
Embed a slim variant of Walley Checkout on your e-commerce page.
This can be mounted in any element on your page, including a modal that is only shown upon request.
### 2. We take care of strong identification
We will prompt the user for strong identification when the purchase is about to be completed
### 3. Register completed orders
You will register new orders by listening to callbacks/webhooks from us
### Basic steps
1. Acquire API keys through Merchant Hub. [https://merchanthub.walleypay.com/](https://merchanthub.walleypay.com/)
2. Use API keys to [acquire a token for authentication](/docs/checkout/authorization)
3. [Start a session](/docs/checkout/initcheckout) using the acquired token
4. [Embed Walley](/docs/checkout/renderiframe) on your page
5. [Listen for completed purchases](/docs/checkout/notificationcallback) and register them in your own system
6. [Manage your orders](/docs/checkout/orderAdministration) (in the same way you do today or through our management API)
---
# Endpoints
Source: https://dev.walleypay.com/docs/checkout/endpoints.md
The hostname in the example requests throughout this documentation should be changed to the environment currently being used.
For testing and staging purposes, Walley Merchant Services will setup an account in the UAT environment where you can test your implementation before moving to production.
## Testing endpoints 🧪
No real money will be involved in transactions.
| Environment | Checkout Environment Endpoint | Description |
| ----------------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| Backend API | https://api.uat.walleydev.com/checkouts | Called from your backend to initialize and update checkout sessions, and to obtain information about checkout sessions and completed purchases. |
| Iframe loader script | https://api.uat.walleydev.com/walley-checkout-loader.js | Used for loading the checkout iframe. |
| Authentication Endpoint | https://api.uat.walleydev.com/oauth2/v2.0/token | Read about [Authentication](/docs/checkout/authorization) |
## Production endpoints 🚀
All purchases are real and real money will be involved in transactions.
| Environment | Checkout Environment Endpoint | Description |
| ----------------------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| Backend API | https://api.walleypay.com/checkouts | Called from your backend to initialize and update checkout sessions, and to obtain information about checkout sessions and completed purchases. |
| Iframe loader script | https://api.walleypay.com/walley-checkout-loader.js | Used for loading the checkout iframe. |
| Authentication Endpoint | https://api.walleypay.com/oauth2/v2.0/token | Read about [Authentication](/docs/checkout/authorization) |
---
# Error codes
Source: https://dev.walleypay.com/docs/checkout/error-codes.md
When consuming the Checkout API, the following error codes can occur and should be handled according to the instructions
Codes 400 to 503 are standard HTTP status codes. Code 900 is a Walley-specific status code for business errors, outside the standard HTTP range. Every code is also returned in the `error.code` property of the response body, with the specific cause in `error.errors[].reason`.
| Error code | Meaning | Action |
| ---------- | :------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| 400 | Bad or faulty request. Please examine the errors property for details. | Check your request |
| 401 | The resource requested requires authentication. | Check your authentication |
| 403 | Access to the requested resource is denied. | Check that you are using the correct credentials and StoreId |
| 404 | The resource requested was not found. | See if your are using the correct route and base URL |
| 409 | The request could not be completed due to a conflict with the current state of the target resource. | Implement retry logic |
| 423 | The resource requested is currently locked for modification. Try again. | Implement retry logic |
| 500 | An unhandled exception has occurred. Please contact Walley! | Contact Walley |
| 503 | Service unavailable. | Contact Walley |
| 900 | The request was rejected by the server due to a business error. | Business error. See details in response to take action |
---
# Acquire information about a Checkout session
Source: https://dev.walleypay.com/docs/checkout/getcheckoutinformation.md
Use the privateId property, also referred to as the private Checkout Id, to
acquire information about an ongoing or completed Checkout for up to 90 days
after the session was created. If the customer does not complete a purchase
within 7 days, Walley aborts the session and requests for that private
checkout id return a 404 Not Found.
:::info Before you start
You need the `privateId` returned by [Initialize checkout](/docs/checkout/initcheckout) and an [authorization header](/docs/checkout/authorization).
:::
Acquire the information by sending a GET request to the following URI:
[https://api.uat.walleydev.com](/docs/checkout/endpoints)/checkouts/[`{privateId}`](/docs/checkout/initcheckout)
## The GET request
The GET request is always issued in the same way, but the response can differ depending on the state of the Checkout session and how the customer has been identified, as well as if it is a B2B or B2C session.
```http
GET /checkouts/1eec44b5-66d3-4058-a31f-3444229fb727 HTTP/1.1
Host: api.uat.walleydev.com
Authorization: Bearer bXlVc2VybmFtZTpmN2E1ODA4MGQzZTk0M2VmNWYyMTZlMDE...
```
## Example responses
Response for a private customer strongly identified with a national identification number:
```http
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "9eec015f-4b97-44be-a711-d22f3af75069",
"data": {
"customerType": "PrivateCustomer",
"customer": {
"email": "test@walleytest.se",
"mobilePhoneNumber": "+4670707071",
"deliveryContactInformation": {
"mobilePhoneNumber": "+46701111111"
},
"deliveryAddress": {
"firstName": "Lars-Erik Rudolf",
"lastName": "Viberg",
"coAddress": null,
"address": "Sommarstugevägen 2",
"address2": null,
"postalCode": "85353",
"city": "Sundsvall",
"country": "Sverige",
"countryCode": "SE"
},
"billingAddress": {
"firstName": "Lars-Erik Rudolf",
"lastName": "Viberg",
"coAddress": null,
"address": "Lingonstigen 10",
"address2": null,
"postalCode": "85352",
"city": "Sundsvall",
"country": "Sverige",
"countryCode": "SE"
}
},
"businessCustomer": null,
"countryCode": "SE",
"status": "PurchaseCompleted",
"reference": "123456789",
"cart": null,
"fees": null,
"purchase": {
"amountToPay": 159,
"paymentName": "Account",
"purchaseIdentifier": "640173",
"result": "Preliminary",
"decisionCategory": "Yellow"
},
"order": {
"orderId": "0466ffb4-80d8-4c55-bd74-af400166b3d7",
"totalAmount": 159,
"items": [
{
"id": "1",
"description": "Some product",
"unitPrice": 200,
"quantity": 1,
"vat": 20
},
{
"id": "998",
"description": "Shipping cost (incl. VAT)",
"unitPrice": 59,
"quantity": 1,
"vat": 25.0
},
{
"id": "10003",
"description": "Gift Card 100",
"type": "GiftCard",
"unitPrice": -100,
"usedAmount": 100,
"quantity": 1,
"vat": 0
}
]
},
"customFields": [
{
"id": "group1",
"metadata": {
"groupMeta": "content"
},
"fields": [
{
"id": "newsConsent",
"name": "I agree to receive marketing communications",
"type": "Checkbox",
"value": false,
"metadata": {
"field1Meta": "field-newsletter-consent"
}
},
{
"id": "comments",
"name": "Any additional comments?",
"type": "Text",
"value": "no nothing noteworthy"
}
]
}
],
"hasSessionExpired": false
},
"error": null
}
```
Response for a business customer:
```http
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "80a0b38b-2f8b-47db-81a5-8b56baa4ad84",
"data": {
"customerType": "BusinessCustomer",
"customer": null,
"businessCustomer": {
"invoiceTag": "Fakturamärkning: 5678",
"companyName": "Bra Byggare AB",
"organizationNumber": "620306-1400",
"invoiceReference": "Reparation dusch Walley",
"email": "bosse@brabyggare.se",
"firstName": "Bosse",
"lastName": "Byggare",
"mobilePhoneNumber": "+46730481277",
"invoiceAddress": {
"companyName": "Bra Byggare AB",
"coAddress": null,
"address": "Storgatan 1",
"address2": null,
"postalCode": "50332",
"city": "Borås",
"country": "Sverige",
"countryCode": "SE"
},
"deliveryAddress": {
"companyName": "WalleyPay AB",
"coAddress": null,
"address": "Östra Hamngatan 24",
"address2": "att: Bosse Byggare",
"postalCode": "41109",
"city": "Göteborg",
"country": "Sverige",
"countryCode": "SE"
}
},
"countryCode": "SE",
"status": "PurchaseCompleted",
"reference": "1231",
"cart": null,
"fees": {
"shipping": {
"id": "Frakt",
"description": "DHL Ombud",
"unitPrice": 19,
"vat": 25
}
},
"purchase": {
"amountToPay": 377,
"paymentName": "DirectInvoice",
"purchaseIdentifier": "33074878",
"result": "Preliminary"
},
"order": {
"orderId": "0466ffb4-80d8-4c55-bd74-af400166b3d7",
"totalAmount": 377,
"items": [
{
"id": "scap001",
"description": "Shower Cap",
"unitPrice": 10,
"quantity": 1,
"vat": 25
},
{
"id": "shipping001",
"description": "Shipping fee (incl. vat)",
"unitPrice": 59,
"quantity": 1,
"vat": 25
},
{
"id": "dirfee001",
"description": "Order administration fee (incl. vat)",
"unitPrice": 299,
"quantity": 1,
"vat": 25
}
]
},
"hasSessionExpired": false,
"metadata": {
"administrator": "John Doe",
"someOtherData": [1, { "myObj": { "key": 1 } }]
}
},
"error": null
}
```
## Faulty response
Response for an unknown, aborted or expired `privateId`:
```http
HTTP/1.1 404 Not Found
Content-Type: application/json
{
"id": "0b18555c-3c84-4bfd-901a-f15c368ba3d9",
"data": null,
"error": {
"code": 404,
"message": "The resource requested was not found.",
"errors": []
}
}
```
## Request properties
**Request headers**
| Header | Required | Explanation |
| ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| **Authorization** | Yes | See [how to generate the authorization header value](/docs/checkout/authorization). |
**Important properties in the response body**
Some of the properties listed below may have their values set to null if they are not applicable in the current state for a Checkout. For example, the customer property is set to null if the customer has not been identified yet.
| Property | Explanation |
| -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **data.countryCode** | The country code you specify in [initialize Checkout request](/docs/checkout/initcheckout) |
| **data.status** | Contains the current status of the Checkout. Possible values include `Initialized`, `CustomerIdentified`, `CommittedToPurchase`, `PurchaseCompleted`, `Aborted`. An explanation of the different statuses can be found [further down](#datastatus) in this section. |
| **data.reference** | Equal to the reference field provided in the [initialize Checkout request](/docs/checkout/initcheckout). |
| **data.cart** | Contains all items for a purchase that has not yet been completed. Once the purchase is complete, all items are moved in under the `data.order` property and the `data.cart` is set to null. |
| **data.fees** | Contains the fees, like shipping, when the purchase is not yet completed. Once the purchase is complete, the fee items are moved last in the `data.order.items` property and the `data.fees.shipping` is set to null. **Note** that if you are using [Custom Delivery Adapter](/docs/checkout/delivery/custom-adapter#get-delivery-methods) that the shipping fee is taken care of there instead. |
| **data.customerType** | Indicates what type of customer the checkout is initialized for. Values are `PrivateCustomer` or `BusinessCustomer` |
| **data.customer** | Contains all customer details for a **private customer** including the delivery address to which the order should be sent. If the customer is strongly identified with a national identification number, billing address will be included. For a private customer who is identified without a national identification number, the billing address will be the same as the delivery address. We only accept card purchase for those customers and hence a billing address is not needed. For a business customer `data.customer` is null. |
| **data.customer.deliveryContactInformation** | Only used if the contact information that has been optionally entered by the user in the delivery address view differs from billing address and will override the corresponding customer property values. |
| **data.businessCustomer** | Contains all customer details for a **business customer** including the invoice address and a delivery address to which the order should be sent. Also includes delivery contact information such as mobile phone number for delivery notification (only used if delivery address differs from invoice address). For a private customer `data.businessCustomer` is null. |
| **data.purchase** | Contains details for a completed purchase. |
| **data.purchase.paymentName** | The name of the chosen Payment option the customer used to pay for the purchase. |
| **data.purchase.amountToPay** | The total amount for the customer to pay for the purchase. This value may be greater than the `data.order.totalAmount` property due to fees issued by Walley for the chosen payment method. |
| **data.purchase.purchaseIdentifier** | Required to manage the invoice for the purchase, for example to activate or make changes to an invoice. The purchase identifier is the identifier for a purchase when interacting with the [Walley Payments API Integration](/docs/paymentsApi/paymentsapi). |
| **data.purchase.result** | The status for the purchase **at time when the purchase was made**. For details regarding different possible statuses for a purchase, see [possible values here](#datapurchaseresult). |
| **data.purchase.decisionCategory** | Credit decision outcome for the completed purchase. **Only applicable to Norwegian (`countryCode: "NO"`) checkouts**, and only included when `redirectPageUri` was set on [Initialize Checkout](/docs/checkout/optional/init-checkout-features) — i.e. the merchant displays its own thank-you page instead of Walley's hosted one. Use this value to render the appropriate purchase-outcome message to the customer on your custom thank-you page. See [possible values](#datapurchasedecisioncategory). |
| **data.purchase.externalPaymentReference** | The third party reference for the payment made with Swish or Vipps with settlements directly using your own agreement. |
| **data.purchase.card** | Contains card details for a purchase configured as a tokenized payment. |
| **data.purchase.card.lastFour** | Contains the last four digits of the card number |
| **data.purchase.card.expiryDate** | Contains the expiry date of the card. |
| **data.order** | Contains the total amount and all items for a completed purchase. |
| **data.order.orderId** | The unique identifier for the order created. This is used in calls to [manage the order](/docs/manage/getting-started/overview). |
| **data.order.totalAmount** | The total amount to be settled, i.e. the sum to be paid to you as a merchant for the purchase. |
| **data.order.customerToken** | The customer token to use for future [tokenized payments.](/docs/checkout/tokenization/introduction) (only available if configured by Walley Merchant Services) |
| **data.appliedVouchers** | Array of bonus vouchers that were applied and successfully redeemed as part of the purchase. Only present when a voucher adapter is configured for the store and the customer activated at least one voucher — otherwise the field is omitted. Each entry contains `voucherId`, `code`, `description`, and `discountAmount`. The discount is not added as a line item under `data.order.items`, and neither `data.order.totalAmount` nor `data.purchase.amountToPay` includes it. Use `appliedVouchers` to reconcile the discount. See [Voyado bonus vouchers](/docs/checkout/loyalty-booster/voyado/voyado-integration#bonus-vouchers) for details. |
| **data.hasSessionExpired** | If true, the Checkout session has expired and a new session must be initialized. |
| **data.customFields** | If there are custom fields present, the user entered data will be present in the array. The structure mirrors the configuration object with `value` holding the users submitted data. |
### data.status
Possible values for the `data.status` property:
- **Initialized** denotes that the Checkout is started but no information has been supplied by the customer.
- **CustomerIdentified** denotes that a customer has been successfully identified by the Checkout.
- **CommittedToPurchase** a customer has pressed the purchase button and the system is waiting for a successful/unsuccessful outcome, for example when waiting for a bank id session to authenticate. In this state the checkout is locked for modifications such as adding/removing from the cart.
- **PurchaseCompleted** denotes that the purchase has been completed.
- **Aborted** denotes that the session has been aborted and a purchase will not be possible for this session.
### data.purchase.paymentName
Possible values for the `data.purchase.paymentName` property:
:::info
These values are subject to change — handle them dynamically.
New payment names may emerge without notice, so design your system to accommodate unknown values.
:::
- **DirectInvoice** Purchase made with the direct invoice option. The invoice will be sent directly by email.
- **Invoice** Purchase made with Invoice option. All purchases made within a month will be aggregated into one notification that is sent to the end customer in the end of that month.
- **Account** Purchase made with Account option. All purchases made within a month will be aggregated into one notification that is sent to the end customer in the end of that month.
- **PartPayment** Purchase was made using a part payment option. For example split the payment into 36 months.
- **Campaign** Purchase was made with a Buy-Now-Pay-Later option. For example buy now - pay in August.
- **Card** Purchase was made with the card option.
- **Trustly** Purchase was made with a direct bank transfer using Trustly option.
- **Swish** Purchase was made with the Swish option.
- **MobilePay** Purchase was made with the Mobile Pay option.
- **Vipps** Purchase was made with the Vipps option.
- **PayPal** Purchase was made with the PayPal option.
### data.purchase.result
Possible values for the `data.purchase.result` property:
- **Preliminary** The purchase is pending and waiting for activation by Merchant when shipping is initiated.
- **OnHold** The purchase is under fraud investigation. Once the status changes of the purchase, a [callback will be sent](/docs/checkout/notificationcallback).
- **Activated** The purchase has been automatically activated. Auto activation is not standard. To request it contact your delivery manager.
- **Rejected** The purchase has been rejected and cannot be activated.
- **Signing** The purchase is waiting for electronic signing of a credit agreement by the end customer. Once the status changes on the purchase, a [callback will be sent](/docs/checkout/notificationcallback).
:::info
For a completed purchase, verify all details such as articles and prices before registering the order as complete on your end.
:::
### data.purchase.decisionCategory
:::info
This field is only applicable to Norwegian checkouts (`countryCode: "NO"`). It will not be returned for any other market.
:::
Possible values for the `data.purchase.decisionCategory` property:
- **Green** — purchase approved without conditions. No additional message is required on your thank-you page.
- **Yellow** — purchase approved on conditions. If you are **not** using Walley's hosted confirmation page (i.e. you set `redirectPageUri` and render your own thank-you page), you **must** display the specific text shown [below](#required-thank-you-page-copy-yellow) to the customer. Walley already renders this text on its hosted confirmation page.
The field is only present when `redirectPageUri` was set on [Initialize Checkout](/docs/checkout/optional/init-checkout-features). Merchants that use Walley's hosted thank-you page do not need to consume this field — Walley renders the required text there.
Treat unknown values as `Green` so future categories do not break your thank-you page.
#### Required thank-you page copy (Yellow)
When `decisionCategory` is `Yellow` and you are rendering your own thank-you page, the following Norwegian copy must be displayed to the customer:
| decisionCategory | Copy (NO) |
| ---------------- | ---------------------- |
| **Yellow** | **Kjøpet ditt ble godkjent med vilkår**
---
# Languages
Source: https://dev.walleypay.com/docs/checkout/languages.md
These are the available languages that can be used.
| Country | Available languages (first one is default) |
| ----------- | ------------------------------------------ |
| Sweden | sv-SE, en-SE |
| Norway | nb-NO, en-NO |
| Finland | fi-FI, sv-FI, en-FI |
| Denmark | da-DK, en-DK |
| Germany | de-DE, en-DE |
| Netherlands | nl-NL, en-NL |
| Europe | en-EU |
---
# Custom loyalty adapter
Source: https://dev.walleypay.com/docs/checkout/loyalty-booster/custom/custom-adapter.md
A custom loyalty adapter allows you to integrate Walley with your own CRM system
## Overview
The custom loyalty adapter is an API that you host on your own system. It is called by Walley Checkout when certain events occur. The adapter is used to check whether a customer is a member of your loyalty program, and to create a new membership if the customer chooses to join.
If the customer changes the toggle to apply for membership, a `walleyCheckoutCrmUpdated` JS event will be sent. When this event is received you have to [acquire checkout information](/docs/checkout/getcheckoutinformation) to know the status of the membership.
As shown in the diagram, Walley Checkout calls Get Membership once the customer has identified, and receives the membership details. Once the customer has completed the purchase, it calls Create Membership and receives `201 Created`.
:::preview Early access
This functionality is at an early stage and is not yet available for all merchants. Please contact your Walley representative for more information.
Also note that this is the version 1 of the custom loyalty adapter api, and will be deprecated as soon as version 2 is released later this year.
:::
## Authentication
All API requests require Basic Authentication and all communication is over HTTPS.
## Get Membership
### Description
Walley calls this endpoint to retrieve the loyalty membership details of a customer based on their email, phone number, and registration number.
It is typically called after a successful identification of the customer in Walley Checkout.
### Example request
```http
GET https://your-adapter.com/api/v1/membership?storeId=123&email=earl.grey@walley.se&mobilePhoneNumber=1234567890&locale=sv-SE HTTP/1.1
Authorization: Basic bXlVc2VybmFtZTpteVBhc3N3b3Jk...
```
#### Request headers
| Header | Value |
| ------------- | ----- |
| Authorization | Basic |
#### Query parameters
| Parameter | Type | Sent | Description |
| ------------------ | ------- | ----- | -------------------------------------------------------------------------------------------------------------------------------- |
| storeId | integer | Yes | The store identifier. Can be used to identify where requests came from in your CRM |
| email | string | Yes | The customer’s email address. |
| mobilePhoneNumber | string | Yes | The customer’s mobile phone number. |
| registrationNumber | string | Maybe | The customer’s registration number. Only sent if the customer has provided it. |
| locale | string | Yes | The desired locale used to localize applicationText, membershipName and termsUri [Supported languages](/docs/checkout/languages) |
### Response
#### Success (200 OK)
```http
HTTP/1.1 200 OK
Content-Type: application/json
{
"isMember": true,
"applicationText": "Yes, I would like to become a member in ABC Reward Club and confirm the member terms\n Become a member and gain access to:\n- Points on all purchases\n- Bonus checks\n- Exclusive offers",
"membershipName": "ABC Reward Club",
"termsUri": "https://merchant-url.com/terms",
"membershipDetails": {
"id": "123456",
"memberNumber": "987654"
},
"requiresRegistrationNumber": false
}
```
| Property | Type | Required | Description |
| -------------------------- | ------- | -------- | --------------------------------------------------------------------------------------------------------- |
| isMember | boolean | Yes | Indicates if the customer is a member of the loyalty program or not |
| applicationText | string | No | The text shown to the customer. [See description](#application-text) |
| membershipName | string | Yes | The name of the loyalty program. |
| termsUri | string | Yes | The URL to the terms and conditions of the loyalty program. |
| membershipDetails | object | No | The membership details of the customer. Only provided if the customer is a member of the loyalty program. |
| requiresRegistrationNumber | boolean | No | Indicates if the adapter requires the registration number to create the membership. |
#### Application text
The `applicationText` property is shown to the user if provided. It can show unique selling points if the user is not a member, or membership benefits if the user already is a member.
It supports simplified markdown, and supported formatting are:
`**bold**` **bold**
`*italic*` *italic*
`- bullet` • bullet
`\n` new line
### Errors and timeouts
If the response is not received within `10 seconds`, the request will be considered timed out.
`1 retry` will be made for server errors and http exceptions after `2 seconds back-off`.
Any non 2xx response or timeout will result in the fallback to not show the membership details to the user.
## Create Membership
### Description
After the customer completes their purchase, Walley calls this endpoint if the customer is not yet a member. The `applyMembership` property indicates whether they chose to apply for membership.
### Example request
```http
POST https://your-adapter.com/api/v1/membership HTTP/1.1
Authorization: Basic bXlVc2VybmFtZTpteVBhc3N3b3Jk...
Content-Type: application/json
{
"applyMembership": true,
"storeId": 123,
"externalStoreId": "ext-5678",
"address": {
"firstName": "John",
"lastName": "Doe",
"address": "123 Main St",
"postalCode": "416 70",
"city": "Gothenburg",
"countryCode": "SE"
},
"email": "john.doe@example.com",
"mobilePhoneNumber": "+46701234567",
"registrationNumber": "000000-0000"
}
```
#### Request headers
| Header | Value |
| ------------- | ---------------- |
| Authorization | Basic |
| Content-Type | application/json |
#### Request body
| Property | Type | Sent | Description |
| ------------------ | ------- | ----- | ---------------------------------------------------------------------------------------------- |
| applyMembership | boolean | Yes | Indicates if the customer wants to apply for membership. |
| storeId | integer | Yes | The store identifier. Can be used to identify where requests came from in your CRM |
| externalStoreId | string | Maybe | The external store identifier provided when [initializing a checkout.](/docs/checkout/initcheckout) |
| address | object | Yes | The address of the customer. |
| email | string | Yes | The customer’s email address. |
| mobilePhoneNumber | string | Yes | The customer’s mobile phone number. |
| registrationNumber | string | Maybe | The customer’s registration number. Only sent if the customer has provided it. |
### Response
#### Success (201 Created)
```http
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "123456",
"memberNumber": "987654"
}
```
| Property | Type | Required | Description |
| ------------ | ------ | -------- | ------------------------------------------ |
| id | string | No | The internal ID to identify the membership |
| memberNumber | string | No | The member number of the customer. |
### Errors and timeouts
If the response is not received within `10 seconds`, the request will be considered timed out.
`1 retry` will be made for server errors and http exceptions after `2 seconds back-off`.
Any non 2xx response or timeout will result in the membership not being created.
## Acquiring loyalty membership information
When [acquiring checkout information](/docs/checkout/getcheckoutinformation) after a customer is identified, the `data.customer.loyaltyMembership` object contains information about the outcome of the membership registration.
| Property | Type | Returned | Description |
| ------------ | ------ | -------- | -------------------------------------------------------- |
| provider | string | Yes | Always `custom` for a custom adapter. |
| success | bool | Yes | `false` if the registration of membership failed. |
| isMember | string | Maybe | Indicates membership, possible values are: yes, no, new. |
| id | string | Maybe | The internal ID to identify the membership. |
| memberNumber | string | Maybe | The member number of the customer. |
There will be four possible outcomes:
1. The customer is already a member, so no registration was performed.
2. The customer chose to apply for membership, and a membership was registered successfully.
3. The customer chose not to apply for membership.
4. The customer chose to apply for membership, but the registration failed due to technical reasons.
:::info Important
If the membership failed to register due to technical reasons, create the membership manually so the customer does not lose their points, bonus levels, or similar. To see why the registration failed, check the developer logs in the [Merchant hub](/docs/merchanthub/intro).
:::
```json
{
"data": {
"customer": {
"loyaltyMembership": {
"provider" : "custom",
"success": true,
"isMember":"yes",
"id": "9b43c86e-227b-4149-b0ee-de7f4846be26",
"memberNumber": "123456789"
}
}
}
}
```
```json
{
"data": {
"customer": {
"loyaltyMembership": {
"provider" : "custom",
"success": true,
"isMember":"new",
"id": "9b43c86e-227b-4149-b0ee-de7f4846be26",
"memberNumber": "123456789"
}
}
}
}
```
```json
{
"data": {
"customer": {
"loyaltyMembership": {
"provider" : "custom",
"success": true,
"isMember":"no"
}
}
}
}
```
```json
{
"data": {
"customer": {
"loyaltyMembership": {
"provider" : "custom",
"success": false
}
}
}
}
```
---
# Introduction
Source: https://dev.walleypay.com/docs/checkout/loyalty-booster/loyalty-booster.md
Loyalty Booster connects Walley Checkout to your CRM system or loyalty
platform, so customers do not enter their login details again. Walley
recognizes members and can show rebates, coupons, membership levels and
points, or sign new customers up during the checkout.
To maintain brand consistency and enhance the customer experience, it is possible to customize the color used in the loyalty module. This can be done by specifying the [`data-loyalty-color`](../renderiframe.mdx#script-element) attribute. If this attribute is not provided, the loyalty module will automatically fall back to the color defined in the `data-action-color` attribute.
## Supported markets
| Country | B2C | B2B |
| ----------- | --- | --- |
| Sweden | Yes | No |
| Norway | Yes | No |
| Denmark | Yes | No |
| Finland | Yes | No |
| Germany | Yes | No |
| Netherlands | Yes | No |
## Current adapters
### Voyado adapter
Our [integration with Voyado](voyado/voyado-integration) allows Walley to check if a user is a member of the loyalty program of the merchant. If the customer is not already a member of the loyalty program, Walley will ask the customer if they would like to enroll as part of the checkout journey. If so, Walley will automatically enroll the customer to the membership program after completing the purchase, all without leaving the checkout experience.
To get started, contact [Walley Merchant Services](/support). Merchant Services will need your Voyado API key and Voyado API URL, and then we will handle the rest.
### Custom loyalty adapter
You can also do a custom integration where your own custom logic can be used to onboard members or provide existing members a customized experience.
To get started, see [Custom loyalty adapter](custom/custom-adapter) for the endpoints your adapter must implement. Then contact [Walley Merchant Services](/support) and we connect your adapter to your store.
---
# Onboarding checklist
Source: https://dev.walleypay.com/docs/checkout/loyalty-booster/loyalty-onboarding.md
Everything you need to hand over to Walley in order to get the Loyalty Booster
enabled and your loyalty adapter configured.
## Overview
The Loyalty Booster is configured per store by Walley. Before it can be activated, Walley needs a set of details about your loyalty program and, if you use a [custom loyalty adapter](/docs/checkout/loyalty-booster/custom/custom-adapter), about the API you host.
Collect the information below and send it to your Walley representative or to [help@walley.se](mailto:help@walley.se). Configuration is done separately per environment, so provide the details for both test and production (share any credentials/secrets via a secure channel, not by email).
Never send credentials or other secrets, such as the Basic authentication password for your adapter, by email or chat. Ask your Walley representative for a secure channel and share them there.
:::preview Early access
This functionality is at an early stage and is not yet available for all merchants. Please contact your Walley representative for more information.
:::
## 1. Stores and markets
| Information | Required | Description |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| Store id(s) | Yes | The Walley store id(s) the loyalty adapter should be enabled for. One configuration is made per store. |
| Environment | Yes | Whether the configuration applies to test or production. Provide the details for both. |
| Markets and languages | Yes | The countries and [languages](/docs/checkout/languages) the loyalty program should be offered in. |
| B2C / B2B | Yes | Which customer types the loyalty program applies to. See the supported markets in the [introduction](/docs/checkout/loyalty-booster/loyalty-booster). |
## 2. Loyalty program details
| Information | Required | Description |
| ------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| Provider | Yes | Which adapter to use, for example [Voyado](/docs/checkout/loyalty-booster/voyado/voyado-integration) or a [custom adapter](/docs/checkout/loyalty-booster/custom/custom-adapter). |
| Membership name | Yes | The name of the loyalty program shown to the customer, for example `ABC Reward Club`. |
| Terms URL | Yes | A publicly available URL with the terms and conditions of the loyalty program, per language. |
| Application text | No | The text shown to the customer in the checkout, per language. See [application text](/docs/checkout/loyalty-booster/custom/custom-adapter#application-text) for supported formatting. |
| Registration number | Yes | Whether a registration number (for example a social security number) is required to create a membership. |
| Loyalty color | No | The color used in the loyalty module. Set with the [`data-loyalty-color`](/docs/checkout/renderiframe#script-element) attribute, and falls back to `data-action-color`. |
:::info Important
`membershipName`, `termsUri` and `applicationText` are returned by the custom adapter per request and are localized using the `locale` query parameter. If you use a custom adapter, you only need to confirm which languages you support.
:::
## 3. Custom adapter connection details
Only needed if you host your own [custom loyalty adapter](/docs/checkout/loyalty-booster/custom/custom-adapter).
| Information | Required | Description |
| ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
| Base URL | Yes | The HTTPS base URL of your adapter, for example `https://your-adapter.com/api/v1`. Provide one URL per environment. |
| Basic auth username | Yes | The username Walley uses for Basic Authentication against your adapter. |
| Basic auth password | Yes | The corresponding password. Share it through a secure channel, never by email or chat. |
| API version | Yes | The version of the custom loyalty adapter API your implementation follows. |
| Endpoints exposed | Yes | Confirmation that both `GET /membership` and `POST /membership` are implemented as described in the [custom adapter](/docs/checkout/loyalty-booster/custom/custom-adapter) documentation. |
:::warning Reachability requirements
Your adapter must be reachable from Walley over HTTPS, respond within `10 seconds`, and accept `1 retry` after a `2 seconds back-off` for server errors. Requests that time out or return a non 2xx response result in the membership not being shown or not being created.
:::
## 4. Contacts
| Information | Required | Description |
| ----------------------- | -------- | ------------------------------------------------------------------------------------------ |
| Technical contact | Yes | Name and email of the person responsible for the adapter integration. |
| Business contact | Yes | Name and email of the person responsible for the loyalty program. |
| Support contact | No | Where Walley should report incidents related to the adapter. |
| Planned go-live date | Yes | When you plan to activate the Loyalty Booster in production. |
## Checklist
{
content: <>Store id(s), environment, markets and languages are specified,
isChecked: true,
},
{
content: <>Membership name and terms URL are provided for every language,
isChecked: true,
},
{
content: <>It is decided whether a registration number is required to create a membership,
isChecked: true,
},
{
content: <>The adapter base URL is reachable over HTTPS from Walley, in both test and production,
isChecked: true,
},
{
content: <>Basic authentication credentials are shared with Walley through a secure channel,
isChecked: true,
},
{
content: <>Both the Get Membership and Create Membership endpoints are implemented and tested,
isChecked: true,
},
{
content: <>Your integration handles the walleyCheckoutCrmUpdated event and reads data.customer.loyaltyMembership from the checkout information,
isChecked: true,
},
{
content: <>A routine exists to create memberships manually if a registration fails for technical reasons,
isChecked: true,
},
{
content: <>Technical and business contacts and a planned go-live date are shared with Walley,
isChecked: true,
},
];
## Next steps
When Walley has received the information, the adapter is configured for your test store so you can verify the flow end to end. Once the integration is verified, the same configuration is applied to your production store.
For the overall integration, also go through the [go-live checklist](/docs/checkout/go-live-checklist).
---
# Voyado adapter
Source: https://dev.walleypay.com/docs/checkout/loyalty-booster/voyado/voyado-integration.md
Our integration with Voyado allows Walley to check if a user is a member of
the loyalty program of the merchant. If the customer is not already a member
of the loyalty program, Walley will ask the customer if they would like to
enroll as part of the checkout journey. If so, Walley will automatically
enroll the customer to the membership program after completing the purchase,
all without leaving the checkout experience.
When the customer identifies in Walley Checkout, a request to Voyado will be made to check if the customer is already a member based on national registration number,
email address or mobile phone number. If the customer is not already a member Walley Checkout will prompt to apply for membership.
If the customer changes the toggle to apply for membership, a `walleyCheckoutCrmUpdated` JS event will be sent.
When this event is received you have to [acquire checkout information](/docs/checkout/getcheckoutinformation) to know the status of the membership.
If the customer chose to apply for membership Walley will automatically register the customer with Voyado:
```json
{
"firstName": "First name",
"lastName": "Last name",
"street": "Address 1",
"zipCode": "12345",
"city": "City",
"email": "test@walleypay.se",
"mobilePhone": "+46701234567",
"countryCode": "SE",
"socialSecurityNumber": "510731-2323",
"preferences": {
"acceptsEmail": true,
"acceptsPostal": false,
"acceptsSms": false
}
}
```
**Note** that Walley Checkout will also provide Voyado with the following properties:
| Property | Required | Explanation |
| ------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Source** | Yes | Always set to the string "Walley". |
| **StoreExternalId** | No | Set to a value of your choosing to indicate which store in Voyado the customer registered in. Note that this store must be setup in Voyado and can be configured in our settings or as the `externalStoreId` parameter when initializing the checkout |
| **Consent** | No | If a customer chooses to be a member then we can create a consent and send them to Voyado. Contact [Walley Merchant Services](/support) to set this up. |
## Acquiring loyalty membership information
When [acquiring checkout information](/docs/checkout/getcheckoutinformation) after a customer is identified, the `data.customer.loyaltyMembership` object contains information about the outcome of the membership registration.
| Property | Type | Returned | Description |
| ------------ | ------ | -------- | -------------------------------------------------------- |
| provider | string | Yes | Always `voyado` for a the Voyado adapter. |
| success | bool | Yes | `false` if the registration of membership failed. |
| isMember | string | Maybe | Indicates membership, possible values are: yes, no, new. |
| id | string | Maybe | The Voyado `contactId` to identify the membership. |
| memberNumber | string | Maybe | The member number of the customer. |
There will be four possible outcomes:
1. The customer is already a member, so no registration was performed.
2. The customer chose to apply for membership, and a membership was registered successfully.
3. The customer chose not to apply for membership.
4. The customer chose to apply for membership, but the registration failed due to technical reasons.
:::info Important
If the membership failed to register due to technical reasons, create the membership manually so the customer does not lose their points, bonus levels, or similar. To see why the registration failed, check the developer logs in the [Merchant hub](/docs/merchanthub/intro).
:::
```json
{
"data": {
"customer": {
"loyaltyMembership": {
"provider" : "voyado",
"success": true,
"isMember":"yes",
"id": "9b43c86e-227b-4149-b0ee-de7f4846be26",
"memberNumber": "123456789"
}
}
}
}
```
```json
{
"data": {
"customer": {
"loyaltyMembership": {
"provider" : "voyado",
"success": true,
"isMember":"new",
"id": "9b43c86e-227b-4149-b0ee-de7f4846be26",
"memberNumber": "123456789"
}
}
}
}
```
```json
{
"data": {
"customer": {
"loyaltyMembership": {
"provider" : "voyado",
"success": true,
"isMember":"no"
}
}
}
}
```
```json
{
"data": {
"customer": {
"loyaltyMembership": {
"provider" : "voyado",
"success": false
}
}
}
}
```
## Bonus vouchers
walley-checkout-loader.js has been loaded it will be possible to interact with the iframe using the provided API. The API functions are exposed via the global object window.walley.checkout.api.
## Suspend and resume flow
If you call any Checkout Backend API's while the checkout is visible, you must call suspend before you make the backend call, and after retrieving the answer, call resume to enable the checkout again.
```javascript
// Suspend the Checkout, showing a spinner...
window.walley.checkout.api.suspend();
// ... then do a back end call and wait for the answer...
// ... and finally resume the Checkout.
window.walley.checkout.api.resume();
```
## API reference
| Function | Parameters | Description |
| ----------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **suspend** | `publicToken` (optional string) | Sets the Checkout iframe in suspend mode. This results in all inputs and buttons being disabled and a spinner to be shown. If `publicToken` is not specified all Checkout iframes on the page will be suspended. |
| **resume** | `publicToken` (optional string) | Resumes the Checkout to its normal state after a suspend. This results in data being loaded from the Checkout backend to stay up to date with any changes. If `publicToken` is not specified all Checkout iframes on the page will be resumed. |
---
# Client-side events
Source: https://dev.walleypay.com/docs/checkout/optional/clientevents.md
To provide a better customer experience, you can listen to custom
client-side events and take appropriate action. All events are dispatched
using the global document object as target and cannot be cancelled or
bubbled.
:::info Important
Do not rely on client-side events for business critical functionality. Use the api to retrieve information. For example:
1. Instead of relying only on `walleyCheckoutPurchaseCompleted`, listen for the Completed Purchase [callback](/docs/checkout/notificationcallback).
1. When receiving a `walleyCheckoutCustomerUpdated`, [get checkout information](/docs/checkout/getcheckoutinformation) of what has been updated.
:::
## Javascript examples
```javascript
// Start listening to the customer updated event
document.addEventListener("walleyCheckoutCustomerUpdated", listener);
// Start listening to the locked event
document.addEventListener("walleyCheckoutLocked", listener);
// Start listening to the unlocked event
document.addEventListener("walleyCheckoutUnlocked", listener);
// Start listening to the resumed event
document.addEventListener("walleyCheckoutResumed", listener);
// Start listening to the purchase completed event
document.addEventListener("walleyCheckoutPurchaseCompleted", listener);
// Start listening to the shipping updated event
document.addEventListener("walleyCheckoutShippingUpdated", listener);
// Start listening to the CRM updated event
document.addEventListener("walleyCheckoutCrmUpdated", listener);
// Start listening to the voucher updated event
document.addEventListener("walleyCheckoutVoucherUpdated", listener);
// Start listening to the validation failed event
document.addEventListener("walleyCheckoutOrderValidationFailed", listener);
// Start listening to the payment aborted event
document.addEventListener("walleyCheckoutPaymentAborted", listener);
```
## Description of available events
| Event | Description |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **walleyCheckoutCustomerUpdated** | Occurs when the Checkout client-side detects any change to customer information, such as a changed email, mobile phone number or delivery address. This event is also fired the first time the customer is identified. |
| **walleyCheckoutLocked** | Occurs when no user input should be accepted, for instance during processing of a purchase. |
| **walleyCheckoutUnlocked** | Occurs after a locked event when it is safe to allow user input again. For instance after a purchase has been processed (regardless of whether the purchase was successful or not). |
| **walleyCheckoutResumed** | Occurs when the Checkout has loaded new data and is back in its normal state after a suspend. See section [Client-side API](/docs/checkout/optional/clientapi) for more details. |
| **walleyCheckoutPurchaseCompleted** | Occurs when the purchase has been completed. |
| **walleyCheckoutShippingUpdated** | Only available when [Delivery Module](/docs/checkout/delivery/introduction-delivery-module) is used. Indicates that the delivery selection has changed. |
| **walleyCheckoutCrmUpdated** | Only available when [Loyalty Booster](/docs/checkout/loyalty-booster/loyalty-booster) is used. Occurs when the customer has changed any information for the CRM module, such as toggling to apply for membership. |
| **walleyCheckoutVoucherUpdated** | Occurs when the voucher state on the order changes, for instance when a voucher is applied, removed or fails to redeem. The event is dispatched with an empty payload, so [get checkout information](/docs/checkout/getcheckoutinformation) to retrieve the updated order state. |
| **walleyCheckoutOrderValidationFailed** | Occurs when [order validation](/docs/checkout/optional/validateorder) returns a non-2XX response. If a `clientPayload` object is returned in the validation response, it is sent as a `payload` parameter here. This can be useful if the client-side code needs information about why the validation failed. |
| **walleyCheckoutPaymentAborted** | When the payment is aborted, a payload is sent to describe the reason and, if applicable, the error code. See payload specification below. |
### walleyCheckoutPaymentAborted payload
```
{
reason: 'ERROR' | 'USER_CANCELLED',
errorCode: 'AGE_RESTRICTED_CART' | 'DENIED' | 'UNKNOWN_ERROR'
}
```
- `ERROR`: This reason could have many different causes, some of which can be identified by the error codes below:
- `AGE_RESTRICTED_CART`: The purchase has been aborted due to items in the cart having age restrictions.
- `DENIED`: The purchase cannot be completed using the selected payment method given the current conditions.
- `UNKNOWN_ERROR`: This error code will be used for all other error scenarios.
- `USER_CANCELLED`: This reason can occur when the user cancels the process. This can happen due to various reasons, such as a change of mind or an accidental click. The user can retry.
---
# Advanced initialization
Source: https://dev.walleypay.com/docs/checkout/optional/init-checkout-features.md
This page lists every property you can send when you{" "}
initialize a Checkout session,
together with the nested objects, callbacks and URI templating they support.
:::tip New to Walley Checkout?
Start with [Initialize checkout](/docs/checkout/initcheckout) for the smallest request that creates a working session. Come back here when you need the complete property list.
:::
```http
POST /checkouts HTTP/1.1
Host: api.uat.walleydev.com
Authorization: Bearer bXlVc2VybmFtZTpmN2E1ODA4MGQzZTk0M2VmNWYyMTZlMDE...
Content-Type: application/json
{
"storeId": 123,
"countryCode": "SE",
"reference": "123456789",
"redirectPageUri": "https://example.com/purchase-completed-confirmation-page",
"checkoutAbortedRedirectPageUri": "https://example.com/back-to-your-shop",
"appRedirectUri": "https://example.com/checkout?token={checkout.publictoken}",
"merchantTermsUri": "https://example.com/merchant-purchase-terms",
"notificationUri": "https://example.com/my-notification-endpoint",
"validationUri": "https://example.com/my-validation-endpoint",
"callback": {
"callbackUri": "https://example.com/my-callback-endpoint",
"callbackTypes": ["ValidateOrder", "PaymentFailed"]
},
"profileName": "MyExampleProfile",
"settlementReference": "shop1",
"externalStoreId": "shop1",
"actionReference": "MyActionReference",
"cart": {
"items": [
{
"id": "10001",
"description": "A product description",
"unitPrice": 95.0,
"unitWeight": 0.3,
"quantity": 1,
"vat": 25.0,
"requiresElectronicId": true,
"sku": "a unique alphanumeric code for article identification"
},
{
"id": "10002",
"description": "Gift Card",
"type": "GiftCard",
"unitPrice": -100.0,
"quantity": 1,
"vat": 0.0
}
],
"shippingProperties": {
"height": 10,
"width": 20,
"isBulky": true
}
},
"fees": {
"shipping": {
"id": "shipping001",
"description": "Shipping cost (incl. VAT)",
"unitPrice": 59.0,
"vat": 25.0
}
},
"privateCustomerPrefill": {
"email": "test@walleypay.se",
"mobilePhoneNumber": "+46701234567",
"nationalIdentificationNumber": "19520101-1234",
"deliveryAddress": {
"firstName": "John",
"lastName": "Doe",
"coAddress": "c/o Jane Doe",
"address": "Sunny road 2",
"address2": "Another address line if needed",
"postalCode": "12345",
"city": "Big Town",
"countryCode": "SE"
}
},
"businessCustomerPrefill": {
"organizationNumber": "5562000116",
"buyer": {
"firstName": "John",
"lastName": "Doe",
"email": "test@walleypay.se",
"mobilePhoneNumber": "+46701234567"
},
"invoiceReference": "ref",
"invoiceTag": "tag",
"deliveryAddress": {
"companyName": "No 3 mining enterprise",
"coAddress": "c/o Jane Doe",
"address": "Rosenborgsgatan 4",
"address2": "Another address line if needed",
"postalCode": "16974",
"city": "Solna"
}
},
"businessCustomerPreset": {
"organizationNumber": "5562000116",
"buyer": {
"firstName": "John",
"lastName": "Doe",
"email": "test@walleypay.se",
"mobilePhoneNumber": "+46701234567"
},
"invoiceReference": "ref",
"invoiceTag": "tag",
"deliveryAddress": {
"companyName": "No 3 mining enterprise",
"coAddress": "c/o Jane Doe",
"address": "Rosenborgsgatan 4",
"address2": "Another address line if needed",
"postalCode": "16974",
"city": "Solna"
}
},
"customFields": [
{
"id": "group1",
"metadata": {
"groupMeta": "content"
},
"fields": [
{
"id": "newsConsent",
"name": "I agree to receive marketing communications",
"type": "Checkbox",
"value": true,
"metadata": {
"field1Meta": "field-newsletter-consent"
},
"localizations": {
"fi-FI": {
"name": "Hyväksyn markkinointiviestinnän vastaanottamisen",
"value": false,
"metadata": {
"field1Meta": "fi-field-newsletter-consent"
}
}
}
},
{
"id": "comments",
"name": "Any additional comments?",
"type": "Text"
}
]
}
],
"metadata": {
"administrator": "John Doe",
"someOtherData": [1, { "myObj": { "key": 1 } }]
}
}
```
This example sends `storeId`. To select the store with `salesSegment` instead, see [Selecting a store](#selecting-a-store).
```http
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "91714012-6ae9-4780-a927-fe459bc95bf6",
"data": {
"privateId": "1eec44b5-66d3-4058-a31f-3444229fb727",
"publicToken": "public-SE-7f1b3d2a2a73d348dfbd17d3965ff1458c249f84c695eac1",
"expiresAt": "2017-12-07T07:16:49.8098107+00:00",
"paymentUri": "https://checkout.uat.walleydev.com/p/npBc87EFB",
"paymentQrCodeUri": "https://api.uat.walleydev.com/checkouts/paylinks/npBc87EFB/qrcode"
},
"error": null
}
```
Response where an invalid `storeId` was provided:
```http
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"id": "1da39a61-d3e1-4da5-a1a0-7a315ea66d2f",
"data": null,
"error": {
"code": 400,
"message": "Bad or faulty request. Please examine the errors property for details.",
"errors": [
{
"reason": "Store_Invalid",
"message": "Invalid store id or country code."
}
]
}
}
```
## Request
**Request headers**
| Header | Required | Explanation |
| ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| **Authorization** | Yes | See [how to generate the authorization header value](/docs/checkout/authorization). |
**Request Body Properties**
| Property | Required | Explanation |
| ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **countryCode** | Yes | The country code to use. `SE`, `NO`, `FI`, `DK`, `DE`, `NL` and `EU` is supported. |
| **storeId** | No `*` | Received from Walley Merchant Services. `*` Walley resolves the store from the `countryCode` and `salesSegment` in the request, so you only need `storeId` when that combination does not identify a single store. See [Selecting a store](#selecting-a-store). |
| **externalStoreId** | No | Your own id of the store. This is sent to Voyado if you use them as a CRM system. It has a 50-character limit. |
| **reference** | No | This is a reference to the order, like an order ID. The reference provided here will be shown to the customer on the invoice or receipt for the purchase. It has a 50-character limit. `**` See special note below regarding Vipps |
| **salesSegment** | No | If you have at most one B2C and/or B2B store in the selected country, then you can use this property to select the store instead of providing a `storeId`. The valid values are `B2C` and `B2B`. |
| **settlementReference** | No `*` | Set this if you would like to group your settlement reports based on this value. Can for example be used when you have several shops connected to one storeId and want purchases to be grouped by individual shops. It has a 50-character limit. `*` To use this feature you must contact Merchant Services to setup Settlement Settings on this specific Store ID |
| **actionReference** | No | A reference to this specific checkout session. This will appear as a data property on the settlement report if the order is auto captured. If you manually capture the order you should set the actionReference on the capture call. Maximum 255 characters. |
| **redirectPageUri** | No `*` | If set, the browser will redirect to this page once the purchase has been completed. Used to display a purchase confirmation page. Must be `https`. `*` Required if the Store is an [InStore type](/docs/checkout/optional/instore). |
| **checkoutAbortedRedirectPageUri** | No | If set and rendering a [Pay Link](/docs/checkout/paylink/overview), a **go back** button will appear for the customer and if clicked, the checkout session will be deleted and the browser will redirect to this page. Must be `https`. |
| **appRedirectUri** | No | Return URL for the Swedish BankID app-switch when the customer authenticates on the **same device**. Once authentication completes, the BankID app returns the customer to this URL. Accepts an absolute `https` URL or a custom app scheme (deep link), and supports the `{checkout.publictoken}` template. See [App redirect URI for BankID](#app-redirect-uri-for-bankid). |
| **merchantTermsUri** | Yes | The page to which the Checkout will include a link for customers that wish to view the merchant terms for purchase. Must be `https`. |
| **notificationUri** | Yes | The endpoint to be called whenever an event has occurred in the Walley Checkout that might be of interest. For example, this callback is typically used to create an order in the merchant's system once a purchase has been completed. Must be `https`. |
| **validationUri** | No | Specify this uri when you want us to make a GET backend call to validate the articles during purchase. Must be `https`. This method is replaced with the more generic callback functionality described below, but may still be used. **Please use only one of the validation methods** |
| **callback** | No | Specify this object when you want us to make a POST backend call for any of the specified callback types. See description below for more information. |
| **profileName** | No | A name that refers to a specific [settings profile](/docs/checkout/optional/settingsprofiles). The profiles are setup by Merchant Services, please contact them for more information [help@walley.se](mailto:help@walley.se) |
| **cart** | Yes | The initial Cart object with items to purchase. [Details below](#cart-object) |
| **fees** | No | Shipping fee. [Details below](#fees-object-optional) |
| **privateCustomerPrefill** | No | Prefilled private customer information. [Details below](#privatecustomerprefill-object-optional) |
| **businessCustomerPrefill** | No | Prefilled business customer information. [Details below](#prefill-or-preset-of-a-business-customer) |
| **businessCustomerPreset** | No | Preset business customer information. [Details below](#prefill-or-preset-of-a-business-customer) |
| **customFields** | No | Custom inputs to be rendered inside the checkout. [Details below](#customfields-optional) |
| **metadata** | No | Your own key/value data, carried with the session and returned when you [retrieve information about the checkout](/docs/checkout/getcheckoutinformation). [Details below](#metadata-object) |
| **upsell** | No | Products offered to the customer on the purchase-completed view. See [Add upsell to your store](/docs/checkout/optional/upsell). |
:::note `**` Special note regarding Vipps
For Vipps purchases with settlements directly from Vipps using your own agreement, the `reference` field can be used to match the purchase with the settlement, if a `reference` is not provided the `orderId` will be used instead.
The `reference` or `orderId` field is concatenated with a postfix of a dash `-` and 9 characters. For example a reference of `12345` might result in a settlement reference of `12345-An1c8BAlI`.
This is also returned in the `externalPaymentReference` field in the response when [retrieving information about the checkout](/docs/checkout/getcheckoutinformation).
:::
### Selecting a store
Every Checkout session belongs to one store. You can identify it in two ways.
Walley resolves the store from the `countryCode` and `salesSegment` you send. When that combination matches a single store, leave `storeId` out. A merchant with one B2C store and one B2B store in Sweden sends `countryCode: "SE"` with `salesSegment: "B2C"` or `"B2B"`, and never needs a store ID.
Send `storeId` when the combination does not identify a single store, for example when you run two B2C stores in the same market. `storeId` also takes precedence, so sending it is always unambiguous.
| You send | Store used |
| ------------------------------------- | ---------------------------------------------- |
| `storeId` | That store |
| `countryCode` and `salesSegment` | The single store matching both |
| `countryCode` only | The single store in that country |
### Callback object
The `callback` object allows you to handle certain events within the Checkout flow, for example validating the items are in stock
or that the customer is allowed to purchase the items. This callback is synchronous and has a timeout of 10 seconds.
It differs from the [notificationUri callback](/docs/checkout/notificationcallback) that is asynchronous and mainly used to notify you about completed purchases.
| Property | Required | Explanation |
| ----------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
| **callbackUri** | Yes | The endpoint to be called whenever any of the callback types occurs. Must accept POST requests. Must be `https`. |
| **callbackTypes** | Yes | Currently `ValidateOrder` and `PaymentFailed` are supported. |
The request body of the callback contains the callback type, along with the private id and public token. Use the private id to validate that the callback originates from Walley
```json
// Example of request body for a callback
{
"type": "ValidateOrder",
"body": {
"checkoutId": "3350f4f2-809e-4103-a566-85e20280b76a",
"publicToken": "public-SE-0a94436dba53edc468584935e7da524eb8d5d8feab85ed03"
}
}
```
#### ValidateOrder
This callback is called just before payment to validate the purchase. See [ValidateOrder](/docs/checkout/optional/validateorder).
#### PaymentFailed
This callback will be called if a payment was unsuccessful, for instance if there was no money on the card or the user cancelled electronic verification. You can use this callback to undo any logic on your side that you made in the `ValidateOrder` callback.
Exceptions for when we will not be sending this callback are:
- If payment fails before the `ValidateOrder` callback.
- If you respond with anything other than 2XX during the `ValidateOrder` callback.
These callbacks have a timeout of 10 seconds. Right now, the Checkout doesn't use the callback's response for anything.
### App redirect URI for BankID
When the customer authenticates with **Swedish BankID** on the **same device**, Walley passes `appRedirectUri` to BankID as the return URL. Once authentication completes, the BankID app switches the customer back to this URL, typically the page or app where the Checkout is running. They land on the confirmation page instead of being left in the BankID app.
The return URL is **only** used when the customer authenticates on the same device. When the customer scans the QR code with BankID on another device, no app-switch occurs and `appRedirectUri` is not used.
`appRedirectUri` is especially useful when the Checkout runs inside a native merchant app: a universal link (iOS), an app link (Android), or a custom app scheme such as `myapp://` lets the BankID app hand control back to your app instead of opening a new browser tab.
Follow [BankID's best practices for the return URL](https://developers.bankid.com/how-to-guides/return-url). In particular, include a nonce or session identifier to mitigate session hijacking.
### Cart object
The `cart` object contains an array of items with the following properties. At least one article must be included to initialize a checkout session.
| Property | Required | Explanation |
| ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id** | Yes | The article id or equivalent. Max 50 characters. Values are trimmed from leading and trailing white-spaces. Shown on the invoice or receipt. |
| **description** | Yes | Descriptions longer than 50 characters will be truncated. Values are trimmed from leading and trailing white-spaces. Shown on the invoice or receipt. |
| **type** | No | An optional type of the article. Currently the only valid value is `GiftCard`. If specified, `unitPrice` must be negative, `quantity` must be 1, `vat` must be 0.0. Furthermore `unitWeight`, `requiresElectronicId`, `minimumAge` and `maximumAge` cannot be specified. Read more about [Gift Cards](/docs/checkout/common-use-cases/giftcards) |
| **unitPrice** | Yes | The unit price of the article including VAT. Both positive and negative values allowed. Max 2 decimals, i.e. `100.00` |
| **unitWeight** | No | The weight of the article. Only positive values are allowed (including zero) |
| **quantity** | Yes | The quantity of the article. Allowed values are `1` to `99999999`. |
| **vat** | Yes | The VAT of the article in percent. Allowed values are `0` to `100`. Max 2 decimals, i.e. `25.00` |
| **requiresElectronicId** | No | To minimize the risk of a fraudulent purchase on credit products, it is possible to force the customer to strongly identify themselves at the point of purchase using electronic id such as Mobilt BankID. An example would be selling tickets that are delivered electronically. This feature does not validate the age of the customer and is supported for credit payments for B2C and B2B on the Swedish, Norwegian and Finnish markets. |
| **minimumAge** | No | The minimum age allowed to purchase this product. Allowed values are `1` to `120`. When this property is set, we require the user to enter a civic number and verify it with electronic id before making the payment. If multiple items has different minimumAge, we use the oldest age. This feature is supported for B2C. |
| **maximumAge** | No | The maximum age allowed to purchase this product. Allowed values are `1` to `120`. When this property is set, we require the user to enter a civic number and verify it with electronic id before making the payment. If multiple items has different maximumAge, we use the youngest age. This feature is supported for B2C. |
| **sku** | No | A stock Keeping Unit is a unique alphanumeric code that is used to identify product types and variations. Maximum allowed characters are 1024. |
The `shippingProperties` are optional and only relevant if a [Delivery Module](/docs/checkout/delivery/introduction-delivery-module) is used.
It gives flexibility to customize what delivery methods should be available based on the items in the cart.
Read more about how these properties are included when [Fetching Delivery Methods with nShift](/docs/checkout/delivery/nshift#custom-request-query-parameters), or [Fetching Delivery Methods with Custom Delivery Adapter](/docs/checkout/delivery/custom-adapter#get-delivery-methods).
### Fees object (optional)
The `Fees` object allows you to set a shipping fee.
The fee will be shown last on the receipt after all the cart items and also on the purchase confirmation page for a completed purchase.
This object is optional and can be set after initialization of the checkout through the [Update fees endpoint](/docs/checkout/optional/updatefees). **Note** that if you are using [Custom Delivery Adapter](/docs/checkout/delivery/custom-adapter#get-delivery-methods) that the shipping fee is taken care of there instead.
| Property | Required | Explanation |
| --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id** | Yes | An id of the fee item. Max 50 characters. Values are trimmed from leading and trailing white-spaces. Shown on the invoice or receipt. |
| **description** | Yes | Descriptions longer than 50 characters will be truncated. Values are trimmed from leading and trailing white-spaces. Shown on the invoice or receipt. |
| **unitPrice** | Yes | The unit price of the fee including VAT. Allowed values are `0` to `999999.99`. Max 2 decimals, i.e. `25.00` |
| **vat** | Yes | The VAT of the fee in percent. Allowed values are `0` to `100`. Max 2 decimals, i.e. `25.00` |
### PrivateCustomerPrefill object (optional)
You can use the `privateCustomerPrefill` object to share any information you have on the customer. We use this data to try and identify the customer, making their checkout faster. If we can't identify them, we'll ask the customer for more details.
However, whether we identify the customer or not doesn't change the response or status code of the Initialize Checkout Session call.
We recommend providing complete data when using prefill.
#### Examples
- If `email` and `mobilePhoneNumber` are provided and the combination is matched for a previously known customer, the user will be logged in and ready for purchase.
- If `email` and `mobilePhoneNumber` are provided but the combination does not match a previously known customer, we will prompt the user for further identification details.
- If `email` and `mobilePhoneNumber` are provided together with `nationalIdentificationNumber` we will try to identify the customer using these values by doing a lookup in an address registry.
- If a complete `deliveryAddress` is provided the address will be set as the customer's delivery address.
- If a non-complete `deliveryAddress` is provided the address will be shown upon initial identification for the customer if the customer chooses to not enter their national registration number.
| Property | Required | Explanation |
| -------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
| **email** | No `*` | The customer's email address. |
| **mobilePhoneNumber** | No `*` | The customer's mobile phone. When providing a number from a foreign country, it must have a valid prefix such as +46 or 0046. |
| **nationalIdentificationNumber** | No | The customer's national identification number. |
| **deliveryAddress** | No | Delivery Address ([see below](#deliveryaddress-object-b2c)) |
`*` email and mobilePhoneNumber are required when identifying a user using a profile with DeliveryMode: Digital
### DeliveryAddress object (B2C)
| Property | Required | Explanation |
| --------------- | -------- | --------------------------------------------- |
| **firstName** | No | First name |
| **lastName** | No | Last name |
| **coAddress** | No | Care of address |
| **address** | No | Primary address row |
| **address2** | No | Additional address row |
| **postalCode** | No | Postal code |
| **city** | No | City |
| **countryCode** | No | Only used when shipping to multiple countries |
### Prefill or preset of a business customer
You can use prefill and/or preset data to set up a business customer's details before showing the checkout page.
Prefill information is like a suggestion; customers can change it. However, preset information can't be changed by the customer, so you must ensure it's correct.
The prefill and preset objects are equal in structure and when the checkout combines the information from the two objects, the preset values are prioritized over the prefilled values.
Though all object values are optional, there are validation rules enforced at initialization.
If the combined object includes an organization number, you must also provide a full buyer's object to identify the customer. If the organization number is preset and we can't identify the business (or the buyer's object is missing), we'll give an error. However, if the organization number is prefilled and we can't identify, the customer will have to do the identification themselves.
If the values marked with a `*` in the DeliveryAddress object are provided, we'll set the customer's delivery address after identifying them. If any of these values are preset, the customer won't be able to change the delivery address later.
| Property | Required | Explanation |
| ---------------------- | -------- | ----------------------------------------------------------- |
| **organizationNumber** | No | The organization number of the company |
| **buyer** | No | Buyer information (see below) |
| **invoiceReference** | No | Shown on the invoice |
| **invoiceTag** | No | Shown on the invoice |
| **deliveryAddress** | No | Delivery Address ([see below](#deliveryaddress-object-b2b)) |
### Buyer object
A buyer is the person performing a purchase on the behalf of the company
| Property | Required | Explanation |
| --------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
| **firstName** | No | The first name of the buyer |
| **lastName** | No | The last name of the buyer |
| **email** | No | The buyer's email address. |
| **mobilePhoneNumber** | No | The buyer's mobile phone. When providing a number from a foreign country, it must have a valid prefix such as +46 or 0046. |
### DeliveryAddress object (B2B)
| Property | Required | Explanation |
| --------------- | -------- | ---------------------- |
| **companyName** | No `*` | Name of the company |
| **coAddress** | No | Care of address |
| **address** | No `*` | Primary address row |
| **address2** | No | Additional address row |
| **postalCode** | No `*` | Postal code |
| **city** | No `*` | City |
If you provide any of the values marked with `*`, you must provide all of them to have a valid address. The exception is for Norway where `address` is optional.
### CustomFields (optional)
The `customFields` array allows you to optionally provide a blueprint for fields of your choosing to be rendered inside the checkout. These can be things like consent for newsletter or comments.
It will be rendered in it's own section after the payment methods.
You can specify multiple groups that will be rendered as their own separate sections, and the `name` field will set the header. We recommend not to have a name present if you only have one group.
Each group can contain fields. We currently support checkboxes, toggles and text fields. They may have a default value.
Every group and field can also contain overriding localization information for markets with multiple languages, or to simplify with one configuration regardless of the current session language.
Every level also supports a metadata object (see below for more information).
suspend before your operation and resume
afterward.
:::info Important
This operation is only available while the purchase is still in progress.
:::
While the checkout is suspended, the cart can be updated by calling the Checkout API from your backend:
```http
PUT /checkouts/{checkoutId}/cart HTTP/1.1
```
:::note[API Reference]
See **Update cart** for the request schema, property descriptions, examples and error reasons.
:::
## Cart items
The request replaces the whole cart, so send the complete set of items rather than a delta. The `id` and `description` values are trimmed of leading and trailing white-space before they are stored.
:::note Cart Validation
The cart cannot consist entirely of items with negative `unitPrice` values. At least one item in the cart must have a non-negative unit price.
:::
**Gift cards.** Set `type` to `GiftCard` to add a gift card to the cart. Give it a negative `unitPrice`, a `quantity` of `1` and a `vat` of `0.0`. Leave out `unitWeight`, `shipping`, `requiresElectronicId`, `minimumAge` and `maximumAge`. A cart can hold several gift cards, but no two of them can share the same `id`, `description` and `unitPrice`, so give each gift card its own `id`. Read more about [Gift Cards](/docs/checkout/common-use-cases/giftcards).
**Strong identification.** Set `requiresElectronicId` on an item to force the customer to identify themselves with electronic id, such as Mobilt BankID, at the point of purchase. This lowers the risk of a fraudulent purchase on credit products, for example when selling tickets that are delivered electronically. It does not validate the age of the customer, and it is supported for credit payments for B2C and B2B on the Swedish, Norwegian and Finnish markets.
**Age limits.** Set `minimumAge` or `maximumAge` on an item to require the customer to enter a civic number and verify it with electronic id before paying. When items carry different limits, the oldest `minimumAge` and the youngest `maximumAge` apply. Age limits are supported for B2C.
## Shipping properties
The `shippingProperties` is optional and only relevant if a [Delivery Module](/docs/checkout/delivery/introduction-delivery-module) is used.
It consists of key-value pairs that will set shipping properties. Each key must be a string, and the value can be a string, a boolean, a number or null.
The request replaces the whole set, so omit a key to remove that property. If you send a key with a null value, the key stays and Walley stores its value as null. To remove every shipping property, send `shippingProperties` as null or as an empty object.
## Error responses
The error reasons this endpoint can return are listed per status code in the API Reference. The [Error codes](/docs/checkout/error-codes) page explains the HTTP status codes used across the Checkout API.
---
# Update checkout
Source: https://dev.walleypay.com/docs/checkout/optional/updatecheckout.md
The Update checkout request will replace the entire checkout state. If you
update the Checkout while the Checkout is visible, use the
Checkout Client API's to
invoke suspend before your operation and resume
afterward. You can also update the objects individually:
[cart](/docs/checkout/optional/updatecart), shippingProperties, [fees](/docs/checkout/optional/updatefees), [shipping](/docs/checkout/delivery/ingrid?tab=update#extending-regular-walley-api-requests), [reference](/docs/checkout/optional/updateorderreference), [metadata](/docs/checkout/optional/updatemetadata)
:::info Important
This operation is only available while the purchase is still in progress.
:::
While the checkout is suspended, the checkout can be updated by calling the Checkout API from your backend:
```http
PUT /checkouts/{checkoutId} HTTP/1.1
```
:::note[API Reference]
See **Update checkout** for the request schema, property descriptions, examples and error reasons.
:::
## Replace semantics
:::info Important
The Update checkout PUT request will replace the checkout state. Providing `null` to (or omitting) the optional properties `shippingProperties`, `shipping`, `fees` or `metadata` will remove the existing value.
`reference`, `settlementReference` and `upsell` are the exceptions. Omit them, or send `null`, and the existing values stay.
:::
Only `cart` is required for a Checkout session that results in an order. `shippingProperties`, `shipping`, `fees`, `reference`, `settlementReference`, [`upsell`](/docs/checkout/optional/upsell) and `metadata` are all optional.
## Cart
:::note Cart Validation
The cart cannot consist entirely of items with negative `unitPrice` values. At least one item in the cart must have a non-negative unit price.
:::
The item constraints are the same as for the dedicated endpoint. See [Update cart](/docs/checkout/optional/updatecart#cart-items) for gift cards, strong identification and age limits.
## Fees
:::info
If the [Delivery Module](/docs/checkout/delivery/introduction-delivery-module) is used, the customer selects delivery method inside Walley Checkout and the `fees.shipping` object is obsolete.
:::
To set the shipping fee, add a `shipping` object to the fees object of the request. The `shipping` object can be `null` to remove the shipping fee for the current Checkout. Keep the combination of `id` and `description` unique within the Checkout session, cart articles included. That keeps every line distinct on the invoice and the receipt. Walley trims leading and trailing white-space from both values.
## Shipping and shipping properties
`shippingProperties` replaces any existing value. It consists of key-value pairs that will set shipping properties. Each key must be a string but the value can be string, boolean or number.
See [Extending regular Walley API requests](/docs/checkout/delivery/ingrid?tab=update#extending-regular-walley-api-requests) to learn more about how to update checkout when using Ingrid.
## References and metadata
`reference` is a reference to the order, such as an order ID. It is not shown to the customer, but it can be correlated with the PurchaseIdentifier that the customer does see.
Set `settlementReference` if you would like to group your settlement reports based on this value. It requires Settlement Settings to be set up on the Store ID by Merchant Services. See [Init Checkout Features](/docs/checkout/optional/init-checkout-features) for details.
`metadata` replaces any existing metadata. Each key in the object must be a string but the value can be any valid JSON value.
:::info
This endpoint cannot be used to update the reference after a purchase. Use [Update order reference](/docs/checkout/optional/updateorderreference) once the purchase is completed.
:::
## Error responses
The error reasons this endpoint can return are listed per status code in the API Reference. The [Error codes](/docs/checkout/error-codes) page explains the HTTP status codes used across the Checkout API.
---
# Update fees
Source: https://dev.walleypay.com/docs/checkout/optional/updatefees.md
The Update fees request will replace the current fees.
If you update the fees while the Checkout is visible, use the Checkout Client API's to invoke suspend before your operation and resume afterward.
The fee is optional but will be shown last on the receipt after all the cart items if present and be presented separately on the thank you-page.
:::info
If the [Delivery Module](/docs/checkout/delivery/introduction-delivery-module) is used, the customer selects delivery method inside Walley Checkout and the `fees.shipping` object and this entire endpoint are obsolete.
:::
:::info Important
This operation is only available while the purchase is still in progress.
:::
While the checkout is suspended, the fees can be updated by calling the Checkout API from your backend:
```http
PUT /checkouts/{checkoutId}/fees HTTP/1.1
```
:::note[API Reference]
See **Update fees** for the request schema, property descriptions, examples and error reasons.
:::
## Setting the shipping fee
To set the shipping fee, add a `shipping` object to the fees object of the request. The shipping object can be `null` to remove the shipping fee for the current Checkout.
Keep the combination of `id` and `description` unique within the Checkout session, cart articles included. That keeps every line distinct on the invoice and the receipt. Walley trims leading and trailing white-space from both values.
## Error responses
The error reasons this endpoint can return are listed per status code in the API Reference. The [Error codes](/docs/checkout/error-codes) page explains the HTTP status codes used across the Checkout API.
---
# Update metadata
Source: https://dev.walleypay.com/docs/checkout/optional/updatemetadata.md
The Update metadata request will replace the current metadata.
:::info Important
This operation is only available while the purchase is still in progress.
:::
The metadata can be updated by calling the Checkout API from your backend:
```http
PUT /checkouts/{checkoutId}/metadata HTTP/1.1
```
:::note[API Reference]
See **Update metadata** for the request schema, examples and error reasons.
:::
## Metadata body
Each key in the object must be a string but the value can be any valid JSON value. Key casing is preserved. Providing an empty body will remove any existing metadata.
## Error responses
The error reasons this endpoint can return are listed per status code in the API Reference. The [Error codes](/docs/checkout/error-codes) page explains the HTTP status codes used across the Checkout API.
---
# Update order reference
Source: https://dev.walleypay.com/docs/checkout/optional/updateorderreference.md
In addition to update an order reference in the initialize checkout and order validation calls,
it is also possible to update the order reference for a Checkout session after a purchase has been successfully completed
:::info Important
You can only update the Order Reference once after the purchase has been completed, and it must be done before the order is captured.
:::
The order reference is updated by calling the Checkout API from your backend:
```http
PUT /checkouts/{checkoutId}/reference HTTP/1.1
```
:::note[API Reference]
See **Update order reference** for the request schema, examples and error reasons.
:::
## The reference value
This is a reference to the order, like an order ID. If you update the reference after completing the purchase, the customer might not see it. However, you can still match it with the PurchaseIdentifier the customer sees.
## Error responses
The error reasons this endpoint can return are listed per status code in the API Reference. The [Error codes](/docs/checkout/error-codes) page explains the HTTP status codes used across the Checkout API.
---
# Add upsell to your store
Source: https://dev.walleypay.com/docs/checkout/optional/upsell.md
Offer extra products to the customer once their purchase is complete. Let
Walley Checkout render the upsell inside the iframe, or build your own UI and
call Reauthorize.
:::info Important
Auto-activated invoices cannot be upsold. Custom upsell using Reauthorize works for orders with status `NotActivated` or `PartActivated`. For in-checkout upsell, see [Availability](#availability).
:::
## Choose your integration
| Option | Who renders the UI | When to pick it |
| ------------------------------------- | ------------------------- | -------------------------------------------------------------------------------- |
| [**In-checkout upsell**](#in-checkout-upsell) | Walley Checkout iframe | Sweden, credit purchases and Swish on a Walley-managed Swish account. |
| [**Custom upsell using Reauthorize**](#custom-upsell-using-reauthorize) | Your own post-checkout UI | Credit purchases. Use when you need full control or upsell is decided post-checkout. |
---
## In-checkout upsell
:::info
In-checkout upsell is only allowed for Checkout sessions that create an order, which is the default. If the session uses a [settings profile](/docs/checkout/optional/settingsprofiles) set up for another purpose, such as subscriptions or identification, sending upsell items is rejected with `400 Bad Request`.
:::
### How it works
1. Pass an `upsell.items` array on the [Initialize Checkout](/docs/checkout/optional/init-checkout-features) request. Max **10 items**.
2. The customer completes their purchase as usual.
3. On the purchase-completed view, Walley Checkout renders the items as cards (image, description, price, **Add** button) together with a countdown for the offer's [time limit](#upsell-properties).
4. When the customer taps **Add**, Walley appends the article to the order. For credit purchases the order is reauthorized automatically. For Swish, the customer approves the extra payment in the Swish app. No merchant call required.
5. Accepted items appear as extra rows with `type: "Upsell"` in the order. Read them from [Get Checkout Information](/docs/checkout/getcheckoutinformation) under `order.items` once the offer has expired.
### Availability
- **Country**: Sweden (`SE`) only.
- **Payment method**: Walley credit purchases, and Swish when the purchase is made on a Walley-managed Swish account.
- **Order state**: not activated. If the order is auto-activated, no upsell is shown.
If any of the above is not met the `upsell` block is silently omitted from the completed view — the rest of the checkout is unaffected.
If you activate the order before the time limit has expired, the customer can no longer add items and the offer closes. Wait until the time limit has expired before activating the order, fully or partly.
### Before you integrate
- **Using `redirectPageUri`?** When it is set, the customer is redirected as soon as the purchase is complete, before the upsell view is shown. The redirect cannot be delayed. To show the upsell, render the checkout again on your redirect page, or leave out `redirectPageUri`.
- **No checkout notification is sent when an item is added.** Neither the [notificationUri callback](/docs/checkout/notificationcallback) nor any checkout event fires for upsell. If you subscribe to [webhooks](/docs/webhooks/orders#walleyorderreauthorized), a `walley:order:reauthorized` webhook is sent each time an item is added. The time limit is the reliable signal: once it has expired, the order can no longer change. Fetch the final order after that.
- **The `validationUri` is not called before an upsell item is added.** Stock and price are not re-validated, so only offer items you can deliver at the price you sent.
### Adding upsell items at init
Extend your existing [Initialize Checkout](/docs/checkout/optional/init-checkout-features) request with an `upsell` object:
```http
POST /checkouts HTTP/1.1
Host: api.uat.walleydev.com
Authorization: Bearer bXlVc2VybmFtZTpmN2E1ODA4MGQzZTk0M2VmNWYyMTZlMDE...
Content-Type: application/json
{
"storeId": 123,
"countryCode": "SE",
"reference": "123456789",
"merchantTermsUri": "https://example.com/terms",
"notificationUri": "https://example.com/notifications",
"cart": {
"items": [
/* primary cart items */
]
},
"upsell": {
"timeLimitInSeconds": 300,
"items": [
{
"id": "10101",
"description": "Premium gift wrapping",
"quantity": 1,
"unitPrice": 49.0,
"vat": 25.0,
"sku": "GIFTWRAP-PREMIUM",
"imageUrl": "https://cdn.example.com/img/giftwrap.jpg"
},
{
"id": "10102",
"description": "Extended 2-year warranty",
"quantity": 1,
"unitPrice": 199.0,
"vat": 25.0,
"imageUrl": "https://cdn.example.com/img/warranty.jpg"
}
]
}
}
```
### `upsell` properties
| Property | Required | Explanation |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **items** | Yes | The products to offer. See [`upsell.items[]` properties](#upsellitems-properties). |
| **timeLimitInSeconds** | No | How long the offer stays open, counted from purchase completion. Range `60`–`300`, default `300`. The customer sees a countdown. Once it has expired, nothing more can be added. Not allowed when `items` is empty. |
### `upsell.items[]` properties
| Property | Required | Explanation |
| --------------- | -------- | ---------------------------------------------------------------------------------------------- |
| **id** | Yes | Article id. Max 50 characters. Shown on the invoice. |
| **description** | Yes | Short product description shown on the upsell card and the invoice. Truncated to 50 characters. |
| **quantity** | Yes | Allowed values `1`–`99999999`. |
| **unitPrice** | Yes | Unit price including VAT. Max 2 decimals. Range `0.01`–`999999.99`. |
| **vat** | Yes | VAT in percent. Max 2 decimals. Range `0`–`100`. |
| **imageUrl** | Yes | Absolute **HTTPS** URL to the product image. Max 2048 characters. Rendered in the upsell card. |
| **sku** | No | Stock Keeping Unit. Max 1024 characters. |
A maximum of **10** upsell items can be sent per checkout.
### Updating upsell items
Upsell items can be changed with [Update Checkout](/docs/checkout/optional/updatecheckout) until the customer commits to payment. Omit `upsell`, or send `null`, to keep the current items. Send `"items": []` to clear them. An `upsell` object without `timeLimitInSeconds` resets the time limit to `300`.
### Reading back what the customer accepted
When the customer adds an upsell item, Walley appends it to the order. Once the time limit has expired, [Get Checkout Information](/docs/checkout/getcheckoutinformation) returns the final order under `order.items` — accepted upsell rows show up alongside the original cart rows with `type` set to `Upsell`:
```json
{
"order": {
"orderId": "...",
"totalAmount": 248.0,
"items": [
/* original cart rows */
{
"id": "10101",
"description": "Premium gift wrapping",
"quantity": 1,
"unitPrice": 49.0,
"vat": 25.0,
"sku": "GIFTWRAP-PREMIUM",
"type": "Upsell"
}
]
}
}
```
- Each offered item can be bought once.
- Identical offered items (same `id`, `description`, `unitPrice`, `vat` and `sku`) are shown as separate upsell cards. If the customer adds more than one, they are merged into one row in `order.items` with the summed quantity.
- An upsell row is never merged with a cart row, even if they share the same `id`.
Accepted items are already on the Walley invoice — no further merchant call is required.
### When an upsell fails
- **Credit purchase denied**, for example by the credit check: the item is not added, the original order is unaffected and the offer closes for the rest of the checkout.
- **Swish declined or cancelled** in the Swish app: the item is not added and the customer is not charged.
No notification is sent in either case. An item missing from `order.items` is the only signal.
---
## Custom upsell using Reauthorize
It’s possible to include your own upsell functionality after the purchase is complete in the checkout. This is done with a call to [Reauthorize](/docs/manage/orders/reauthorize) with the added products of the customer's choice or a larger amount than the original.
---
# Order administration
Source: https://dev.walleypay.com/docs/checkout/orderAdministration.md
After an order has been placed, it is time to activate the order rows and perhaps perform returns and adjustments.
This is done through our Management API or manually through our Merchant Hub.
## Order administration
You use the same token for authentication when calling our Management API to administer your orders as you did to initialize and get checkout information. If the token has expired, acquire a new one.
| Call | Explanation |
| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| [Capture / Part capture orders](/docs/manage/orders/capture) | When you are ready to ship items to your customers. Results in an activated or partly activated order |
| [Refund / Part refund orders](/docs/manage/orders/refund) | When a return is made you use this call to refund money to the end customer. |
| [Cancel orders](/docs/manage/orders/cancel) | This is used to cancel all rows on an order that has not yet been activated. |
---
# Overview
Source: https://dev.walleypay.com/docs/checkout/overview.md
Walley offers several ways to accept payments, from a fully embedded
Checkout in your web shop to hosted payment pages and recurring payments.
Explore the products below and find the integration that fits your business.
Embed Walley Checkout in your web shop. Initialize a session, render the iframe and let the customer complete the purchase without leaving your site.
Send a ready-to-pay Checkout to your customer as a link or SMS. A fully hosted payment page with no integration into your own site required.
Store a payment token when the customer makes a purchase and charge it later. Built for subscriptions and recurring payments.
Boost conversion on your product pages with embeddable widgets that promote part payment options and show available payment methods.
Verify stock before the purchase is completed.
Let customers pay part of the order with a gift card.
Apply discount codes to the cart inside the Checkout.
Let customers choose shipping options directly in the Checkout, via Ingrid, nShift or a custom adapter.
Connect your loyalty program, via Voyado or a custom adapter, and reward members at purchase.
To customize the text sent to the customer, please Contact Walley Merchant Services for configuration.
## Distribute Pay Link request
To distribute a Pay Link you must first create the Checkout session as you normally do by following the [Basic Steps here](/docs/checkout/initcheckout)
Once you have created a Checkout session it can be distributed to an end customer by issuing a POST request as per below:
```http
POST /checkouts/1eec44b5-66d3-4058-a31f-3444229fb727/paylink HTTP/1.1
Host: api.uat.walleydev.com
Authorization: Bearer bXlVc2VybmFtZTpmN2E1ODA4MGQzZTk0M2VmNWYyMTZlMDE...
Content-Type: application/json
{
"destination": {
"mobilePhoneNumber": "0701740635"
}
}
```
```http
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "f5f4e86d-95b1-4c1a-8ad0-1d5907236bd7",
"data": null,
"error": null
}
```
The request body should contain a json object with the receivers mobile telephone number.
:::info
Currently the only distribution type available is by mobile phone number.
:::
## Request properties
**Request headers**
| Header | Required | Explanation |
| ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| **Authorization** | Yes | See [how to generate the authorization header value](/docs/checkout/authorization). |
**Request properties**
| Property | Required | Explanation |
| --------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **destination.mobilePhoneNumber** | Yes | The recipient's mobile phone number. Supports foreign phone numbers if country prefix is added. If no country prefix is supplied, the current countries prefix will automatically be added, i.e. `+46730` and `0730` are both accepted as start of a valid phone number in Sweden. |
## Error responses
| Error code | Error Reason | Cause |
| ---------- | ------------------------- | ----------------------------------------------------------------------------------------------- |
| **400** | Validation_Error | The request contains properties with invalid values. Details are provided in the response body. |
| **503** | Could not notify customer | The service provider to push a Pay Link returned an error or was unavailable. |
---
# Getting started
Source: https://dev.walleypay.com/docs/checkout/paylink/getting-started.md
To use the Pay Link you must first create the Checkout session as you normally do by Init Checkout session.
When the session has been created you use the `paymentUri` from the response of the initialize checkout request and redirect the user browser to that URI.
## Optional query parameters
You can add some parameters to the `paymentUri` you have received before you redirect the user. e.g. https://checkout.walleypay.com/p/bXjYxk?showCart=false&lang=en-SE
| Parameter | Type | Explanation |
| ------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **showCart** | boolean | This controls whether the cart will be shown in the paylink. Default: true |
| **lang** | string | This parameter specifies the language in which you would like to view the content. The valid language options are based on the locale, such as en-SE, sv-SE, fi-FI, etc. It is important to note that only the languages available for the [current market](/docs/checkout/languages) can be specified. If an invalid or missing value is provided, the default language for that market will be used instead. |
## Cancellation option
If providing a `checkoutAbortedRedirectPageUri` in the initialize checkout request, a **go back** button will be shown for the customer.
If pressed, the customer will be redirected to that redirect page. Once that is done, that checkout session is aborted and cannot be reused.
A [notification callback](/docs/checkout/notificationcallback) will be sent if that button is used.
When [fetching the checkout](/docs/checkout/getcheckoutinformation), the `status` will be `Aborted`.
It is also possible to use the [Abort Pay Link API](/docs/checkout/paylink/abort-paylink) to abort the current checkout session.
---
# Overview
Source: https://dev.walleypay.com/docs/checkout/paylink/overview.md
The Pay Link offers a ready-to-pay Checkout session to be presented in a fully hosted environment. The page includes the cart with a summary, and the regular Checkout iframe in one single, responsive page.
This allows you to prepare a Checkout session in advance and redirect the users browser to the Pay Link so the customer can complete their purchase there.
It's also possible to use our distribution API to push the Pay Link to a users mobile phone by SMS.
---
# Payment types
Source: https://dev.walleypay.com/docs/checkout/payment-types.md
The Checkout can be configured to offer multiple different payment types for the end customer. Below follows a brief explanation of the different possible payment types available.
| Payment Type | Description |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Direct Invoice | This payment type will send an invoice by email to the end customer. |
| Account | The end customer's aggregated purchases during a month period will be invoiced in the end of the month. Notification fees from Walley can apply to this payment option. |
| Invoice | B2B only. A pre-evaluated credit reservation has been setup in advance, like a virtual credit card. The credit can be used by pre-authorized persons either by SSN or Pin code. |
| Part Payment | Splits the payment over several months. Either interest free or annuity payments. Disabled for amounts lower than 1000 SEK for B2C customers. |
| Campaign | A Buy-Now-Pay-Later payment option. |
| Card | The end customer pays directly with VISA or MasterCard. |
| Trustly | The end customer signs into the bank to do a transfer using the Trustly user interface |
| Swish | B2C, SE only. The end customer pays directly using the Swish app. |
| MobilePay | B2C, DK/FI only. The end customer pays directly using the MobilePay app. |
| Vipps | B2C, NO only. The end customer pays directly using the Vipps app. |
| iDEAL/Wero | B2C, NL only. The end customer pays directly using iDEAL/Wero. |
| PayPal | B2C. Available in all markets where Walley Checkout is available. Enabled by default for new merchants in DE and NL and available on request in other markets. See the [PayPal guide](/docs/checkout/optional/paypal). |
| ApplePay | The end customer pays directly with using Apple Pay. For details on how to integrate Apple Pay, see the [Apple Pay integration guide](/docs/checkout/optional/apple-pay) |
---
# Prerequisites
Source: https://dev.walleypay.com/docs/checkout/prerequisites.md
First of all you will need access to our environments. Contact Walley Merchant Services to acquire access to our Merchant Hub where you can create new API credentials to get started.
To get hold of API keys - login to Merchant Hub in [Test](https://merchanthub.aks.uat.walleydev.com) or [PROD](https://merchanthub.walleypay.com) and create one [as described here](/docs/merchanthub/access/apikeys)
**[help@walley.se](mailto:help@walley.se)**
## Render the Payment method logos widget iframe
To display the widget, place the following script on the pages where you want it to appear.
By default, the widget will render as an iframe at the script’s position in the DOM.
You can also use the data-container-id attribute to target a specific element where the widget should be injected.
```html
```
## Script element attributes
| Attribute | Required | Default | Explanation |
| ------------------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **src** | Yes | - | See endpoints in [Checkout Environment Endpoints](/docs/checkout/endpoints) |
| **data-token** | Yes | - | The widget token received when initializing the widget session. **NB!** The token should be reused for all widgets until it expires. |
| **data-widget** | Yes | - | The name of the widget. In this case `payment-method-logos`. |
| **data-alignment** | No | center | The alignment of the widget. Valid values are `left`, `center`, and `right`. |
| **data-icon-size** | No | small | The size of the icons displayed in the widget. Valid values are `small`, `medium`, and `large`. |
| **data-dark-mode** | No | false | Set this to `true` to enable dark mode styling for the widget. |
---
# Widgets
Source: https://dev.walleypay.com/docs/checkout/widgets/widgets.md
Widgets are small components that can be used in any place of your website to enhance the customer experience around payments and checking out.
They can for example be used to boost sales on a specific product by showing alternatives to pay already on the product detail view.
---
# Asynchronous operations
Source: https://dev.walleypay.com/docs/manage/concepts/asynchronous-operations.md
Every write to the Management API is accepted first and applied a moment later. Build for that
and your integration stays correct under retries, timeouts, and race conditions.
## What 202 Accepted means
Capture, refund, cancel, and reauthorize answer with `202 Accepted`, an empty body, and a
`Location` header pointing at the order. Reauthorizing to a higher amount is the one exception,
and it is covered [further down](#the-one-exception-reauthorizing-to-a-higher-amount).
```http
HTTP/1.1 202 Accepted
Location: /manage/orders/1b1f5ef6-92n1-4b46-b1dc-ae2e00c4c315
```
`202` means Walley has taken the request and will apply it. It does not mean the change is live.
For a few seconds afterward, Merchant Hub, settlement data, and this API can all still show the
order as it was before your call.
So do not treat a `202` as "the order now looks like X". Treat it as "the change is on its way".
:::warning Do not read back immediately
Fetching the order right after a `202` usually returns the old version. Use one of the two
patterns below instead.
:::
## Reading the result
### If you have a correlationId
When you have the action's `correlationId` from a webhook, pass it to
[Get order](/docs/manage/orders/get). Walley returns the order only once that action has been
applied, so you never read a stale version.
```bash
curl "https://api.uat.walleydev.com/manage/orders/{{orderId}}?correlationId={{correlationId}}" \
-H "Authorization: Bearer {{accessToken}}"
```
Until the action lands, the call returns `404 Not Found`. Retry after at least 3 seconds.
### If you do not have a correlationId
Wait up to a minute before fetching, and keep the read off your customer's critical path. This
suits reporting jobs, nightly reconciliation, and anything else that is not time sensitive.
## Retrying safely
Retries are expected. Two rules keep them from doing damage.
**Send an idempotency key on every write.** Generate a UUID v4 per operation and send it as
`Walley-Idempotency`. If the response never arrives, repeat the exact same request with the same key
and Walley applies the operation once. See [Idempotency](/docs/manage/idempotency).
```http
Walley-Idempotency: 03304b06-cb33-4f78-bcea-86cb4b202ba0
```
**Know which failures are worth retrying.**
| Response | What happened | What to do |
| -------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `403` | Missing permission, or the order has not finished syncing yet. | Retry after at least 3 seconds. If it persists, check your access. |
| `404` | Order not found, it has not finished syncing, or a `correlationId` you passed has not been applied yet. | Retry after at least 3 seconds. |
| `409` | A request with the same idempotency key is already running. | Wait, then read the order back. Do not send a new key. |
| `422` | The request conflicts with the state of the order. | Do not retry. Fix the request. See [Errors](/docs/manage/errors). |
A `403` or `404` right after an order was created is usually the sync delay, not a real problem.
## The one exception: reauthorizing to a higher amount
Raising an order's total needs a fresh credit check, and that can involve the customer. So
[Reauthorize order](/docs/manage/orders/reauthorize) answers `201 Created` instead of `202`, with
a `Location` header pointing at a status resource.
```http
HTTP/1.1 201 Created
Location: /manage/orders/b6be7ec0-311b-490d-8856-af8d00c783b5/reauthorize/1b1f5ef6-92n1-4b46-b1dc-ae2e00c4c315
```
Poll that URL until `status` is `Completed` or `Failed`.
```json
{
"data": {
"id": "ca81364e-895f-4250-bdb2-a9dafa13c4bc",
"orderId": "b2be7nc0-351b-890d-8856-af8d00a783b5",
"status": "Completed",
"createdAt": "2023-01-17T12:09:27.029057+00:00"
},
"links": {},
"metaData": {}
}
```
`Failed` means the credit check was declined or Walley needed more household income data. The
order keeps its original amount, so nothing is left half applied.
Lowering the amount or keeping it the same returns `202` like every other write.
## A checklist for your integration
- Treat `202` as accepted, not applied
- Send `Walley-Idempotency` on every capture, refund, cancel, and reauthorize
- Retry `403` and `404` after at least 3 seconds, never `422`
- Reuse the same idempotency key when you retry
- Poll the status URL when a reauthorize returns `201`
- Never block a customer-facing screen on a read-back
## Next steps
- [Order lifecycle](/docs/manage/concepts/order-lifecycle) covers which actions a status allows
- [Errors](/docs/manage/errors) lists the responses and what each one calls for
---
# Order lifecycle
Source: https://dev.walleypay.com/docs/manage/concepts/order-lifecycle.md
Every order carries a status, and that status decides which actions Walley accepts. Read this
page once and the state rules on each endpoint will make sense.
## Where orders come from
An order can reach the Management API from more than one place. Whichever route created it, the
statuses and actions below work the same way.
- A customer completes a [Walley Checkout](/docs/checkout/introduction) session
- An [authorization in the tokenized flow](/docs/checkout/tokenization/authorization) succeeds
- An [AddInvoice](/docs/paymentsApi/integration/creating-purchases/addinvoice) call is made in the Payments API
Each of these raises a [`walley:order:created` webhook](/docs/webhooks/orders).
## The main path
An order starts uncaptured. You capture items as you ship them, and the order moves toward
`Activated`. If you never capture, it expires on the date in `expiresAt`.
```mermaid
stateDiagram-v2
[*] --> NotActivated: Order is created
NotActivated --> PartActivated: Capture some of the items
NotActivated --> Activated: Capture the whole order
PartActivated --> Activated: Capture what is left
NotActivated --> Expired: expiresAt passes, nothing captured
Activated --> Returned: Refund the whole order
```
Capturing is what triggers payout. Once an order is fully captured, the amount is marked for
payout to your bank account and the order joins the reconciliation report.
## Order statuses
The `status` field on the order tells you where it is.
| Status | What it means |
| ---------------- | --------------------------------------------------------------------------------------------------- |
| `NotActivated` | The order exists and nothing is captured yet. It expires at `expiresAt`. |
| `PartActivated` | Some items are captured and some are not. |
| `Activated` | Every item is captured. The amount is marked for payout. |
| `Returned` | The order has been fully refunded. |
| `Expired` | The order passed `expiresAt` without being captured. You can still cancel it. |
| `OnHold` | Walley has not yet made a decision on the order. Wait for the [`walley:order:authorized` webhook](/docs/webhooks/orders). |
| `Closed` | The order is settled and no longer open for changes. Capture and reauthorize both reject it. |
## Item statuses
Each entry in `items` carries its own status, so a `PartActivated` order holds a mix of them.
| Status | What it means |
| -------------- | ---------------------------------------------------------------- |
| `NotActivated` | Not captured yet. |
| `Activated` | Captured. `captureId` and `capturedAt` are set. |
| `Returned` | Refunded. `refundedAt` is set. |
| `Canceled` | Canceled before capture. It will not be delivered, and it is never settled or paid out. On a direct payment method, the customer is refunded for it. |
| `Expired` | The order expired before this item was captured. |
## What each status allows
Before you call an endpoint, check the order status against this table.
| Action | Allowed on | Notes |
| --------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------ |
| [Get order](/docs/manage/orders/get) | Any status | Reading is always safe. |
| [Capture order](/docs/manage/orders/capture) | `NotActivated`, `PartActivated` | Rejected on `Closed` and `Expired`. |
| [Reauthorize order](/docs/manage/orders/reauthorize) | `NotActivated`, `PartActivated` | Raising the amount works on credit payment methods only, not on prepaid. |
| [Refund order](/docs/manage/orders/refund) | `Activated`, `PartActivated` | You can only refund what has been captured. |
| [Cancel order](/docs/manage/orders/cancel) | `NotActivated`, `PartActivated`, `Expired` | Cancels every uncaptured item. This cannot be undone. |
Calling an endpoint against the wrong status returns `422` with an error code that names the
problem. See [Errors](/docs/manage/errors).
## Two things worth knowing
**Capture and cancel are one-way.** A capture settles the items you shipped and a cancel releases
the ones you did not. Neither has an undo. To give money back after a capture, refund the order.
**An order that has not been captured will expire.** Check `expiresAt` on the order and capture
before that date. An expired order can no longer be captured, only canceled.
## Next steps
- [Asynchronous operations](/docs/manage/concepts/asynchronous-operations) explains why a status change is not visible the moment you get a response
- [Errors](/docs/manage/errors) covers the responses you get when a status blocks an action
---
# Errors
Source: https://dev.walleypay.com/docs/manage/errors.md
The Management API draws its responses from one small set of HTTP status codes, and each one
means the same thing wherever you meet it. This page defines them and says what to do next, so
you can handle them in one place. Which codes a given endpoint can return is listed at the
bottom.
## Status codes
| Code | What it means | What to do |
| ----- | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
| `200` | The request succeeded and the body carries the result. | Nothing. |
| `201` | A reauthorization to a higher amount started and needs a credit check. | Poll the URL in the `Location` header. See [Asynchronous operations](/docs/manage/concepts/asynchronous-operations). |
| `202` | Walley accepted the write and will apply it shortly. | Do not read the order back immediately. See [Asynchronous operations](/docs/manage/concepts/asynchronous-operations). |
| `401` | The token is missing, expired, or invalid. | Request a new access token. See [Authentication](/docs/manage/getting-started/authentication). |
| `403` | Your credentials do not cover this store, or the order has not finished syncing. | Check the store your API key covers. If the order was just created, retry after at least 3 seconds. |
| `404` | No order matches that id, the order has not finished syncing, or you passed a `correlationId` whose action has not been applied yet. | Check the id. Otherwise retry after at least 3 seconds. See [Get order](/docs/manage/orders/get) for the `correlationId` case. |
| `409` | A request with the same idempotency key is already running. | Wait, then read the order back. Reuse the same key if you retry. See [Idempotency](/docs/manage/idempotency). |
| `422` | The request conflicts with the state of the order or breaks a validation rule. | Do not retry. Read the error code in the response and fix the request. |
:::note A 403 or 404 right after a purchase is usually the sync delay
Walley applies order changes asynchronously, so a brand new order can answer `403` or `404` for a
few seconds before it is readable. Retry once after 3 seconds before treating it as a real
failure. See [Asynchronous operations](/docs/manage/concepts/asynchronous-operations).
:::
## Handling 422
A `422` carries an error code that names the exact rule you hit. The codes are specific to the
endpoint, so look them up where you called:
- [Capture order error codes](/docs/manage/orders/capture#error-codes)
- [Refund order error codes](/docs/manage/orders/refund#error-codes)
- [Reauthorize order error codes](/docs/manage/orders/reauthorize#error-codes)
Most of them fall into three groups.
**The amount does not add up.** When you send `items`, `amount` has to equal their total.
Amounts take at most 2 decimals.
**The order is in the wrong state.** You cannot capture a captured order, refund a fully refunded
one, or touch an order that is closed or expired. Check the status first with
[Order lifecycle](/docs/manage/concepts/order-lifecycle).
**An item could not be matched.** Partial captures and refunds match the items you send against
the items on the order. Send `unitPrice` and `quantity` at minimum, and the more fields you send,
the more likely the match is unique.
## Which endpoints return what
| Endpoint | Success | Also possible |
| ---------------------------------------------------- | ------- | -------------------------------- |
| [Get order](/docs/manage/orders/get) | `200` | `401`, `403`, `404` |
| [Capture order](/docs/manage/orders/capture) | `202` | `401`, `403`, `404`, `409`, `422` |
| [Refund order](/docs/manage/orders/refund) | `202` | `401`, `403`, `404`, `409`, `422` |
| [Cancel order](/docs/manage/orders/cancel) | `202` | `401`, `403`, `404`, `409` |
| [Reauthorize order](/docs/manage/orders/reauthorize) | `202` | `201`, `401`, `403`, `404`, `409`, `422` |
## Next steps
- [Asynchronous operations](/docs/manage/concepts/asynchronous-operations) covers retries and idempotency in full
- [Order lifecycle](/docs/manage/concepts/order-lifecycle) covers which actions a status allows
---
# Auditing headers
Source: https://dev.walleypay.com/docs/manage/getting-started/auditing-headers.md
To provide more detailed auditing in our products it is possible to use optional HTTP headers to provide information about the origination of the request made towards the API.
Since the auditing information could be displayed to users of the Walley products, we recommend only posting human readable, nonsensitive information in these headers. ## Performed by To provide information identifying the user or person that performed the action resulting in the request towards the API, use the Walley-Performed-By HTTP header. The value posted could be any information identifying the user, e.g. a name, a username or an email. ```http Walley-Performed-By: firstname.lastname@walley.se ``` ## Originated from To provide information about the origin of the request towards the API, use the Walley-Originated-From HTTP header. The value posted could be any information identifying the origin of the request, e.g. the name of the system integrating with the API, an end user system, a company or store name. ```http Walley-Originated-From: Walley Checkout ``` --- # Authentication Source: https://dev.walleypay.com/docs/manage/getting-started/authentication.md To protect your data and users, Walley uses Microsoft Azure AD B2C as an authentication service provider. To gain access to the API you must identify your application against this service to obtain a token that you use to identify your application against our APIs. > Microsoft Azure AD B2C follows the OAuth2 standard. To integrate with the Walley API, you use the **Client Credentials** flow. > [Read more about the Client Credentials flow](https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/) --- # Endpoints Source: https://dev.walleypay.com/docs/manage/getting-started/endpoints.md The endpoints used throughout this documentation will point to the testing endpoints to avoid mistakes. You must make sure to use production endpoints once you move to production. ## Testing endpoints 🧪 | Product | Endpoint | Description | | ----------------------- | ----------------------------------------------- | ------------------------------------------------------------------------ | | Management API | `https://api.uat.walleydev.com/manage` | Manage orders, access control, settlements, onboarding | | Authentication Endpoint | `https://api.uat.walleydev.com/oauth2/v2.0/token` | Read about [Authentication](/docs/manage/getting-started/authentication) | ## Production endpoints 🚀 | Product | Endpoint | Description | | ----------------------- | ------------------------------------------- | ------------------------------------------------------------------------ | | Management API | `https://api.walleypay.com/manage` | Manage orders, access control, settlements, onboarding | | Authentication Endpoint | `https://api.walleypay.com/oauth2/v2.0/token` | Read about [Authentication](/docs/manage/getting-started/authentication) | --- # Overview Source: https://dev.walleypay.com/docs/manage/getting-started/overview.md The Management API is how your systems act on a Walley order once it has been created. Capture it when you ship, refund it when goods come back, change it before it leaves the warehouse, and read its current state whenever you need to. It works the same way no matter which Walley product created the order. ## What you can doRead an order and everything on it: items, addresses, invoices and current status. Start here when you need to know what an order accepts next.
Confirm what you ship, in full or item by item. Capturing is what triggers the payout and creates the invoice for the customer.
Give money back after capture, for the whole order, for single items, or as an adjustment when you only need to correct the amount.
Change the items or the amount before anything is captured. Use it to add, remove or replace rows while the order is still in the warehouse.
Release every item you have not captured. The customer is not charged and the reservation is returned.
Adjust items and amounts before delivery.
Ship what you have and keep the rest reserved.
Return goods and pay the customer back.
![Walley instore digital horisontal 16_9 fi]({require("./assets/walley-instore-digital-tablet-fi.png").default})
.default})
.default})
.default})
![Walley instore digital horisontal 16_9 no]({require("./assets/walley-instore-digital-a5-no-print.png").default})
| File type | |
| ------------- | --------------------------------------------------------------------------------------------------------------- |
| Printable PDF | Download here |
.default})
.default})
.default})
| Banner package - buy now pay later | Download here |
| Banner package - Black week 2025 | Download here |
| Banner package | FI_banners.zip |
| Banner package (monthly) | FI_banners_monthly.zip |
| Banner package (additional formats) | FI_banners_maksa_erissä_additional_formats.zip |
| Banner package - Black week 2025 | Download here |
| Banner package | Download here |
| Banner package - Black week 2025 | Download here |
| Banner package - buy now pay later | Download here |
| Banner package - buy now pay in January (kostnadsfri) | Download here |
| Banner package - buy now pay in November (kostnadsfri) | Download here |
| Banner package - buy now pay in December (kostnadsfri) | Download here |
---
# Accept
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2b/accept.md
## Accept of agreement in checkout
`[Checkbox]` Jag har læst og accepterer Walleys Almindelige Betingelser For Faktura.
### Hyperlinks
Almindelige Betingelser For Faktura: [https://cdn.walleypay.com/terms/Terms_DK.pdf](https://cdn.walleypay.com/terms/Terms_DK.pdf)
---
# Payment Information – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2b/paymentinfo/account.md
## Payment information in checkout – Aggregated invoice
`[Logo]` Når du vælger samlefaktura for virksomheder, modtager du dine varer, før du betaler.Du alle kjøp som er gjort under samme måned på en samlet faktura.
---
# Payment Information – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2b/paymentinfo/invoice.md
## Payment information in checkout - Invoice
`[Logo]` Når du vælger betaling på faktura for virksomheder, modtager du dine varer, før du betaler.
---
# Shop terms & conditions – Aggregated invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2b/terms/aggregated_invoice.md
## Shop terms & conditions – Aggregated invoice
### Samlingsfaktura for virksomheder
I samarbejde med Walley tilbyder vi betaling med samlefaktura for virksomheder. Alle dine køb foretaget i samme måned samles på en faktura, som sendes den efterfølgende måned. Faktura indebærer, at du først betaler efter at have modtaget varerne. Forfaldsdatoen kan variere og fremgår af den faktura som sendes til virksomheden. Leveringsmåden og eventuelle gebyrer, der påløber, vises i kassen, inden du bekræfter købet.Ved forsinket eller udebleven betaling debiteres et gebyr samt morarente. De fuldstændige vilkår for Walley finder du her: `Vilkår`
### Hyperlinks
Almindelige Betingelser For Faktura: [https://cdn.walleypay.com/terms/Terms_B2B_DK.pdf](https://cdn.walleypay.com/terms/Terms_B2B_DK.pdf)
---
# Shop terms & conditions – Walley Checkout
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2b/terms/checkout.md
## Shop terms & conditions – Walley Checkout
### Walley Checkout
I samarbejde med Walley tilbyder vi betaling med Walley Checkout. Walley Checkout samler alle de vigtige betalingsmåder i en og samme løsning – vælg mellem kortbetaling, faktura eller delbetaling (betalingsmulighederne kan variere over tid). Du bestemmer selv, hvilken betalingsmåde du vil bruge ved kassen, inden du bekræfter købet.
Faktura indebærer, at du først betaler efter at have modtaget varerne. Forfaldsdatoen kan variere og fremgår af den faktura som sendes til virksomheden. Leveringsmåden og eventuelle gebyrer, der påløber, vises i kassen, inden du bekræfter købet. Ved forsinket eller udebleven betaling debiteres et gebyr samt morarente. De fuldstændige vilkår for Walley finder du her: `Vilkår`
### Hyperlinks
Almindelige Betingelser For Faktura: [https://cdn.walleypay.com/terms/Terms_DK.pdf](https://cdn.walleypay.com/terms/Terms_DK.pdf)
---
# Shop terms & conditions – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2b/terms/invoice.md
## Shop terms & conditions – Invoice
### Faktura for virksomheder
I samarbejde med Walley tilbyder vi betaling på faktura for virksomheder. Faktura indebærer, at du først betaler efter at have modtaget varerne. Du kan derefter vælge enten at betale hele beløbet på en gang eller opdele det i mindre rater. Forfaldsdatoen kan variere og fremgår af den faktura som sendes til virksomheden. Leveringsmåden og eventuelle gebyrer, der påløber, vises i kassen, inden du bekræfter købet.Ved forsinket eller udebleven betaling debiteres et gebyr samt morarente. De fuldstændige vilkår for Walley finder du her: `Vilkår`
### Hyperlinks
Almindelige Betingelser For Faktura: [https://cdn.walleypay.com/terms/Terms_DK.pdf](https://cdn.walleypay.com/terms/Terms_DK.pdf)
---
# Accept
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2c/accept.md
## Accept of agreement in checkout
`[Checkbox]` Jeg har læst og accepterer Walleys almene vilkår for faktura og kontokredit, Standardiserad Europeisk Kosumentkreditinformation samt bekræfter, at jeg har læst Walleys håndtering af personoplysninger.
### Hyperlinks
Almene vilkår for faktura og kontokredit: [https://cdn.walleypay.com/terms/Terms_DK.pdf](https://cdn.walleypay.com/terms/Terms_DK.pdf)
Standardiserad Europeisk Kosumentkreditinformation: [https://cdn.walleypay.com/terms/Terms_DK.pdf](https://cdn.walleypay.com/terms/Terms_DK.pdf)
Walleys håndtering af personoplysninger: [walleypay.com/data-protection](https://walleypay.com/data-protection)
---
# Calculations
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2c/calculations.md
## Calculations
### Calculation of monthly cost for account.
You can use the following algorithm to calculate the products part payment cost (in the end customers native currency):
`(Product cost / Number of months) + (Product cost * Interest rate) + Monthly fee`
For example: A product worth 200 DKK, divided on 12 months, an interest rate of 1,6583%, and a monthly fee of 35 DKK would give the algorithm:
`(200 / 12) + (200 * 1,6583%) + 35 = 55 DKK per month`
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 50 DKK.
### Calculating monthly cost to display on the checkout page
The same algorithm can be applied on the checkout page, but the two occurrences of product cost needs to be replaced by the total purchase amount including shipping fee:
`(Total purchase amount / Number of months) + (Total purchase amount * Interest rate) + Monthly fee`
For example: The customer orders two products worth 195 DKK and a shipping fee of 59 DKK is added. This algorithm would then apply:
`(449 / 12) + (449 * 1,6583%) + 35 = 80 DKK per month`
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 50 DKK.
### Calculation of monthly cost for interest free part payment.
The formula used to calculate the cost is as follows:
`(Order sum + (Invoice fee * months)) / months`
Here's an example: if the total basket value is 3456 DKK, it would give the following calculation:
`(3456 + (35 * 12)) / 12 = 323kr/month`
Please note that an origination fee is added to the first invoice. The standard set of instalment plans and their origination fees and interest rates can be found in the table below, however, please refer to your merchant agreement with Walley to get the correct origination fee amounts.
Using the example amount above and an origination fee of 295 DKK, a first invoices lowest amount to pay would be 323 + 295 = 618 DKK.
### Calculation of monthly cost for annuity payment
The formula used to calculate the cost is the following:
`CapitalDebt * (MonthlyInterestRate / ((1 + MonthlyInterestRate) ^ Months - 1)) + CapitalDebt * MonthlyInterestRate + InvoiceFee`
Here's an example: if the total basket value is 3456 DKK, it would give the following calculation:
`3456 _ (1,6583% / ((1 + 1,6583%) ^ 24 - 1)) + 3456 _ 1,6583% +35 = 215 DKK/month`
PLEASE NOTE
Please note that an origination fee is added to the first invoice. The standard set of instalment plans and their origination fees and interest rates can be found in the table below, however, please refer to your merchant agreement with Walley to get the correct origination fee amounts.
Using the example amount above and an origination fee of 295 DKK, a first invoices lowest amount to pay would be 215 + 295 = 510 DKK.
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 50 DKK.
---
# Order Confirmation
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2c/orderconfirmation.md
## Order Confirmation
This text can be added to your order confirmation email that you distribute to the end customer
### Betaling
Information om din betaling sendes i en separat e-mail. Du kan allerede nu logge ind på [MyWalley](https://my.walley.dk/).
Med MyWalley kan du se alle dine køb og sætte en faktura på pause, hvis du ønsker at returnere eller forlænge betalingsperioden.
---
# Payment Information – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2c/paymentinfo/account.md
## Payment information in checkout - Account
`[Logo]` Når du vælger delbetaling får du dine varer hjem, inden du betaler. Alle dine køb foretaget i løbet af en måned samles på en faktura. Du kan derefter vælge at betale hele beløbet på en gang eller opdele betalingen i mindre dele.
---
# Payment Information – Campaign
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2c/paymentinfo/campaign.md
## Payment information in checkout – Campaign
`[Logo]` ### Køb nu – betal senere!
Alle køb indtil den `` foretaget i forbindelse med denne kampagne giver dig forlænget betalingstid indtil den ``.
Der beregnes et kampagnegebyr på ``.
### Placeholders
`` - The agreed campaign length, `` - The agreed due date `` - The agreed campaign fee, e.g. "39 kr"
---
# Payment Information – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2c/paymentinfo/invoice.md
## Payment information in checkout - Invoice
`[Logo]` Når du vælger faktura får du dine varer hjem, inden du betaler.
Du kan derefter vælge at betale hele beløbet på én gang eller at dele betalingen op i mindre dele.
---
# Payment Information – Fixed part payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2c/paymentinfo/partpayment.md
## Payment information in checkout – Fixed part payment
`[Logo]` Når du vælger afbetalingskampagne får du dine varer hjem, inden du betaler.
Du modtager en faktura i måneden efter du har foretaget dit køb. Overhold din afbetaling ved at betale det faste beløb, som fremgår af din faktura.
---
# Shop terms & conditions – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2c/terms/account.md
## Shop terms & conditions – Account
### Delbetaling
I samarbejde med Walley tilbyder vi delbetaling. Faktura eller delbetaling indebærer, at du først betaler efter at have modtaget varerne. Du kan derefter vælge enten at betale hele beløbet på en gang eller opdele det i mindre rater. Forfaldsdatoen kan variere og fremgår af den faktura eller delbetalingsfaktura, som sendes til dig. Leveringsmåden og eventuelle gebyrer, der påløber, vises i kassen, inden du bekræfter købet. En kreditprøvning udføres og indebærer i nogle tilfælde, at en kreditvurdering foretages. Ved forsinket eller udebleven betaling debiteres et gebyr samt morarente. De fuldstændige vilkår for Walley finder du her: `Vilkår` og `SECCI`.
På [my.walley.dk](https://my.walley.dk) kan du se alle dine fakturaer fra Walley.
### Hyperlinks
Almene vilkår for faktura og kontokredit: [https://cdn.walleypay.com/terms/Terms_DK.pdf](https://cdn.walleypay.com/terms/Terms_DK.pdf)
Standardiserad Europeisk Kosumentkreditinformation: [https://cdn.walleypay.com/terms/SECCI_DK.pdf](https://cdn.walleypay.com/terms/SECCI_DK.pdf)
---
# Shop terms & conditions – Walley Checkout
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2c/terms/checkout.md
## Shop terms & conditions – Walley Checkout
### Walley Checkout
I samarbejde med Walley tilbyder vi betaling med Walley Checkout. Walley Checkout samler alle de vigtige betalingsmåder i en og samme løsning – vælg mellem MobilePay, direkte bank- og kortbetaling, faktura eller delbetaling (betalingsmulighederne kan variere over tid). Du bestemmer selv, hvilken betalingsmåde du vil bruge ved kassen, inden du bekræfter købet.
Faktura eller delbetaling indebærer, at du først betaler efter at have modtaget varerne. Du kan derefter vælge enten at betale hele beløbet på en gang eller opdele det i mindre rater. Forfaldsdatoen kan variere og fremgår af den faktura eller delbetalingsfaktura, som sendes til dig. Leveringsmåden og eventuelle gebyrer, der påløber, vises i kassen, inden du bekræfter købet. En kreditprøvning udføres og indebærer i nogle tilfælde, at en kreditvurdering foretages. Ved forsinket eller udebleven betaling debiteres et gebyr samt morarente. De fuldstændige vilkår for Walley finder du her: `Vilkår` og `SECCI.
På [my.walley.dk](https://my.walley.dk) kan du se alle dine fakturaer fra Walley.
### Hyperlinks
Almene vilkår for faktura og kontokredit: [https://cdn.walleypay.com/terms/Terms_DK.pdf](https://cdn.walleypay.com/terms/Terms_DK.pdf)
Standardiserad Europeisk Kosumentkreditinformation: [https://cdn.walleypay.com/terms/SECCI_DK.pdf](https://cdn.walleypay.com/terms/SECCI_DK.pdf)
---
# Shop terms & conditions – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2c/terms/invoice.md
## Shop terms & conditions – Invoice
### Faktura
I samarbejde med Walley tilbyder vi faktura og delbetaling. Faktura eller delbetaling indebærer, at du først betaler efter at have modtaget varerne. Du kan derefter vælge enten at betale hele beløbet på en gang eller opdele det i mindre rater. Forfaldsdatoen kan variere og fremgår af den faktura eller delbetalingsfaktura, som sendes til dig. Leveringsmåden og eventuelle gebyrer, der påløber, vises i kassen, inden du bekræfter købet. En kreditprøvning udføres og indebærer i nogle tilfælde, at en kreditvurdering foretages. Ved forsinket eller udebleven betaling debiteres et gebyr samt morarente. De fuldstændige vilkår for Walley finder du her: `Vilkår` og `SECCI.
På [my.walley.dk](https://my.walley.dk) kan du se alle dine fakturaer fra Walley.
### Hyperlinks
Almene vilkår for faktura og kontokredit: [https://cdn.walleypay.com/terms/Terms_DK.pdf](https://cdn.walleypay.com/terms/Terms_DK.pdf)
Standardiserad Europeisk Kosumentkreditinformation: [https://cdn.walleypay.com/terms/SECCI_DK.pdf](https://cdn.walleypay.com/terms/SECCI_DK.pdf)
---
# Shop terms & conditions – Fixed Part Payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/denmark/b2c/terms/partpayment.md
## Shop terms & conditions – Fixed part payment
### Afbetalingskampagner
I samarbejde med Walley tilbyder vi faktura ved specielle afbetalingskampagner. Når du vælger denne betalingsmåde, sender Walley fakturaen til dig med forfaldstid sidst på måneden. Faktura eller delbetaling indebærer, at du først betaler efter at have modtaget varerne. Du kan derefter vælge enten at betale hele beløbet på en gang eller opdele det i mindre rater. Forfaldsdatoen kan variere og fremgår af den faktura eller delbetalingsfaktura, som sendes til dig. Leveringsmåden og eventuelle gebyrer, der påløber, vises i kassen, inden du bekræfter købet. En kreditprøvning udføres og indebærer i nogle tilfælde, at en kreditvurdering foretages. Ved forsinket eller udebleven betaling debiteres et gebyr samt morarente. De fuldstændige vilkår for Walley finder du her: `Vilkår` og `SECCI`.
På [my.walley.dk](https://my.walley.dk) kan du se alle dine fakturaer fra Walley.
### Hyperlinks
Almene vilkår for faktura og kontokredit: [https://cdn.walleypay.com/terms/Terms_DK.pdf](https://cdn.walleypay.com/terms/Terms_DK.pdf)
Standardiserad Europeisk Kosumentkreditinformation: [https://cdn.walleypay.com/terms/SECCI_DK.pdf](https://cdn.walleypay.com/terms/SECCI_DK.pdf)
---
# Accept
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2b/accept.md
## Accept of agreement in checkout
`[Checkbox]` I have read and accept Walley's General terms and conditions for invoice.
### Hyperlinks
General terms and conditions for invoice: `https://cdn.walleypay.com/terms/Terms_B2B\_{SE|NO|FI|DK}.pdf`
---
# Payment Information – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2b/paymentinfo/account.md
## Payment information in checkout – Aggregated invoice
`[Logo]` When choosing aggregated invoice for companies as the payment method, you receive your goods before you pay. All your purchases in a month will be will be gathered in one invoice.
---
# Payment Information – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2b/paymentinfo/invoice.md
## Payment information in checkout - Invoice
`[Logo]` When you select invoice for companies as the payment method, you receive your goods before you pay.
---
# Payment Information – Fixed part payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2b/paymentinfo/partpayment.md
## Payment information in checkout – Fixed part payment
`[Logo]` When choosing instalment payments via invoice for companies as the payment method, you receive your goods before you pay. Walley will send the invoice to you the following month.
---
# Shop terms & conditions – Aggregated invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2b/terms/aggregated_invoice.md
## Shop terms & conditions – Aggregated invoice
### Aggregated invoice for companies
Together with Walley, we offer an aggregated invoice solution as a payment method for companies. All your purchases during a given month will be gathered in one invoice. When selecting invoice, you receive your goods before you pay. Due date can vary and is presented on the invoice sent to you. Delivery method and possible fees added is shown in the checkout before confirming the purchase. In the event of delayed or missed payments, a penalty fee and penalty interest is charged. To see the full terms and conditions for Walley use the link: Terms & Conditions`
### Hyperlinks
General terms and conditions for invoice: `https://cdn.walleypay.com/terms/Terms_B2B\_{SE|NO|FI|DK}.pdf`
---
# Shop terms & conditions – Walley Checkout
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2b/terms/checkout.md
## Shop terms & conditions – Walley Checkout
### Walley Checkout
Together with Walley, we offer payments with Walley Checkout. Walley Checkout gives you all the desired payment methods in one solution - choose between direct bank- and card payment, invoice or payment in instalments (payment options may vary from time to time). Walley Checkout lets you decide your preferred payment method before confirming the purchase.
When selecting invoice, you receive your goods before you pay. Due date can vary and is presented on the invoice sent to you. Delivery method and possible fees added is shown in the checkout before confirming the purchase. In the event of delayed or missed payments, a penalty fee and penalty interest is charged. To see the full terms and conditions for Walley use the link: `Terms & Conditions`
### Hyperlinks
General terms and conditions for invoice: `https://cdn.walleypay.com/terms/Terms_B2B\_{SE|NO|FI|DK}.pdf`
---
# Shop terms & conditions – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2b/terms/invoice.md
## Shop terms & conditions – Invoice
### Invoice solution for companies
Together with Walley, we offer invoice as a payment method for companies. When selecting invoice, you receive your goods before you pay. Due date can vary and is presented on the invoice sent to you. Delivery method and possible fees added is shown in the checkout before confirming the purchase. In the event of delayed or missed payments, a penalty fee and penalty interest is charged. To see the full terms and conditions for Walley use the link: `Terms & Conditions`
### Hyperlinks
General terms and conditions for invoice: `https://cdn.walleypay.com/terms/Terms_B2B\_{SE|NO|FI|DK}.pdf`
---
# Shop terms & conditions – Fixed Part Payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2b/terms/partpayment.md
## Shop terms & conditions – Fixed part payment
### Instalment payments for companies
Together with Walley, we offer instalment payments via invoice as a payment method for companies. When selecting invoice, you receive your goods before you pay. Due date can vary and is presented on the invoice sent to you. Delivery method and possible fees added is shown in the checkout before confirming the purchase. In the event of delayed or missed payments, a penalty fee and penalty interest is charged. To see the full terms and conditions for Walley use the link: `Terms & Conditions
### Hyperlinks
General terms and conditions for invoice: `https://cdn.walleypay.com/terms/Terms_B2B\_{SE|NO|FI|DK}.pdf`
---
# Accept
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2c/accept.md
## Accept of agreement in checkout
`[Checkbox]` I hereby confirm that I have read and accept Walley's general terms for invoice and credit accounts, Standard European Consumer Credit Information. I have also taken part of Walley's information on data protection.
### Hyperlinks
General terms and conditions for invoice: `https://cdn.walleypay.com/terms/Terms\_{SE|NO|FI|DK}.pdf`
Standard European Consumer Credit Information: `https://cdn.walleypay.com/terms/SECCI\_{SE|NO|FI|DK}.pdf`
Walley's information on data protection: [walleypay.com/data-protection](https://walleypay.com/data-protection)
---
# Calculations
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2c/calculations.md
## Calculations
### Calculation of monthly cost for account.
You can use the following algorithm to calculate the products part payment cost (in the end customers native currency):
`(Product cost / Number of months) + (Product cost * Interest rate) + Monthly fee`
For example: A product worth 9,95 € , divided on 12 months, an interest rate of 1,6583 %, and a monthly fee of 3,00 € would give the algorithm:
`(9,95 / 12) + (9,95 * 1,6583 %) + 3,00 = 4,00 € per month`
(The actual lowest amount to pay in the example would be 4,00 € per month, but the lowest accepted payment is 5 €)
### Calculating monthly cost to display on the checkout page
The same algorithm can be applied on the checkout page, but the two occurrences of product cost needs to be replaced by the total purchase amount including shipping fee:
`(Total purchase amount / Number of months) + (Total purchase amount * Interest rate) + Monthly fee`
For example: The customer orders two products, each worth 19,90 € and a shipping fee of 5,95 € is added. This algorithm would then apply:
`(45,75 / 12) + (45,75 * 1,6583 %) + 3,00 = 7,58 € per month`
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 5 €.
### Calculation of monthly cost for annuity payment
The formula used to calculate the cost is the following:
`CapitalDebt * (MonthlyInterestRate / ((1 + MonthlyInterestRate) ^ Months - 1)) + CapitalDebt * MonthlyInterestRate + InvoiceFee`
Here's an example: if the total basket value is 321,8€, it gives the following:
`321,8 * (1,6583% / ((1 + 1,6583%) ^ 24 - 1)) + 321,8 * 1,6583% +3,00 = 19,37€ per month`
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 5 €.
---
# Order Confirmation
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2c/orderconfirmation.md
## Order Confirmation
This text can be added to your order confirmation email that you distribute to the end customer
For more information on how you can promote our app [download our app kit](https://cdn.walleypay.com/banner/walley-appkit.zip)
### Payment
Information about your payment will be sent in a separate email from Walley. You can already log in to [MyWalley](https://my.walleypay.de/) or download the Walley app on the App Store or Google Play. With the Walley app, you can quickly and easily pay, pause an invoice if you want to return or extend the payment period. If you activate notifications in the app, you will also be reminded when it's time to pay.
---
# Payment Information – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2c/paymentinfo/account.md
## Payment information in checkout - Account
`[Logo]` When you select account as the payment method, you receive your goods before you pay. All your purchases during a given month will be gathered in one invoice. You can then choose to pay the whole amount at once or to break up the payments into smaller instalments.
---
# Payment Information – Campaign
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2c/paymentinfo/campaign.md
## Payment information in checkout – Campaign
`[Logo]` ### Buy now – pay later!
All purchases up to and including `` made with this campaign give you extended payment time until the ``.
A campaign fee of `` is added.
### Placeholders
`` - The agreed campaign length, `` - The agreed due date `` - The agreed campaign fee, e.g. "3 €"
---
# Payment Information – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2c/paymentinfo/invoice.md
## Payment information in checkout - Invoice
`[Logo]` When you select invoice as the payment method, you receive your goods before you pay.
You can then choose to pay the whole amount at once or to break up the payment into smaller instalments.
---
# Payment Information – Fixed part payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2c/paymentinfo/partpayment.md
## Payment information in checkout – Fixed part payment
`[Logo]` När du väljer att dela upp din betalning får du hem dina varor innan du betalar. Du får en faktura månaden som följer efter ditt köp.
Följ din delbetalning genom att betala in det fasta beloppet som framgår på din faktura.
---
# Shop terms & conditions – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2c/terms/account.md
## Shop terms & conditions – Account
### Account
Together with Walley, we offer instalment payments via invoice. When you select this payment method, you receive your goods before you pay. All your purchases during a given month will be gathered in one invoice. You can then choose to pay the whole amount at once or to break up the payments into smaller instalments. Due date can vary and is presented on the invoice sent to you. Delivery method and possible fees added is shown in the checkout before confirming the purchase. A credit check is carried out, which in some cases requires credit information. In the event of delayed or missed payments, a penalty fee and penalty interest is charged. To see the full terms and conditions for Walley use the links: `Terms & Conditions` and `SECCI`.
### Hyperlinks
General terms and conditions for invoice: `https://cdn.walleypay.com/terms/Terms\_{SE|NO|FI|DK}.pdf`
Standard European Consumer Credit Information: `https://cdn.walleypay.com/terms/SECCI\_{SE|NO|FI|DK}.pdf`
---
# Shop terms & conditions – Walley Checkout
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2c/terms/checkout.md
## Shop terms & conditions – Walley Checkout
### Walley Checkout
Together with Walley, we offer payments with Walley Checkout. Walley Checkout gives you all the desired payment methods in one solution – choose between Swish, Vipps, Mobilepay, direct bank- and card payment, invoice or payment in instalments (payment options may vary from time to time). Walley Checkout lets you decide your preferred payment method before confirming the purchase.
When selecting invoice or instalment payments, you receive your goods before you pay. You can then choose to pay the whole amount at once or to break up the payments into smaller instalments. Due date can vary and is presented on the invoice sent to you. Delivery method and possible fees added is shown in the checkout before confirming the purchase. A credit check is carried out, which in some cases requires credit information. In the event of delayed or missed payments, a penalty fee and penalty interest is charged. To see the full terms and conditions for Walley use the links: `Terms & Conditions` and `SECCI`.
### The Walley app
With the Walley app, you get a clear overview of all your purchases and payments – right on your phone. You can manage your payments in whatever way suits you and your budget best. Move your due date, split a purchase into installments or connect your bank account to pay instantly, on the due date or by direct debit. By activating notifications, you’ll get reminders for upcoming payments. The app is free to download and free to use.
#### Download the Walley App here:
- [**App Store**](https://apps.apple.com/se/app/walley/id1569382782)
- [**Google Play**](https://play.google.com/store/apps/details?id=com.walleypay.app)
### Hyperlinks
General terms and conditions for invoice: `https://cdn.walleypay.com/terms/Terms\_{SE|NO|FI|DK}.pdf`
Standard European Consumer Credit Information: `https://cdn.walleypay.com/terms/SECCI\_{SE|NO|FI|DK}.pdf`
---
# Shop terms & conditions – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2c/terms/invoice.md
## Shop terms & conditions – Invoice
### Invoice
Together with Walley, we offer invoice and instalment payments.When selecting invoice or instalment payments, you receive your goods before you pay. You can then choose to pay the whole amount at once or to break up the payments into smaller instalments. Due date can vary and is presented on the invoice sent to you. Delivery method and possible fees added is shown in the checkout before confirming the purchase. A credit check is carried out, which in some cases requires credit information. In the event of delayed or missed payments, a penalty fee and penalty interest is charged. To see the full terms and conditions for Walley use the links: `Terms & Conditions` and `SECCI`.
### Hyperlinks
General terms and conditions for invoice: `https://cdn.walleypay.com/terms/Terms\_{SE|NO|FI|DK}.pdf`
Standard European Consumer Credit Information: `https://cdn.walleypay.com/terms/SECCI\_{SE|NO|FI|DK}.pdf`
---
# Shop terms & conditions – Fixed Part Payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/english/b2c/terms/partpayment.md
## Shop terms & conditions – Fixed part payment
### Instalment payment campaigns
Together with Walley we offer invoices for special instalment payment campaigns. When selecting invoice or instalment payments, you receive your goods before you pay. You can then choose to pay the whole amount at once or to break up the payments into smaller instalments. To follow the instalment plan you need to pay the amount stated on the invoice each month Due date can vary and is presented on the invoice sent to you. Delivery method and possible fees added is shown in the checkout before confirming the purchase. A credit check is carried out, which in some cases requires credit information. In the event of delayed or missed payments, a penalty fee and penalty interest is charged. To see the full terms and conditions for Walley use the links: `Terms & Conditions` and `SECCI`.
### Hyperlinks
General terms and conditions for invoice: `https://cdn.walleypay.com/terms/Terms\_{SE|NO|FI|DK}.pdf`
Standard European Consumer Credit Information: `https://cdn.walleypay.com/terms/SECCI\_{SE|NO|FI|DK}.pdf`
---
# Accept
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2b/accept.md
## Accept of agreement in checkout
`[Checkbox]` Olen tutustunut Walley:n laskun yleisiin ehtoihin ja hyväksyn ne.
### Hyperlinks
Laskun yleiset ehdot: [https://cdn.walleypay.com/terms/Terms_B2B_FI.pdf](https://cdn.walleypay.com/terms/Terms_B2B_FI.pdf)
---
# Payment Information – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2b/paymentinfo/account.md
## Payment information in checkout – Aggregated invoice
`[Logo]` Kun valitset Walleyin koontilaskun yrityksille, kaikki kuukauden aikana tehdyt ostot kootaan yhdelle laskulle.
---
# Payment Information – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2b/paymentinfo/invoice.md
## Payment information in checkout - Invoice
`[Logo]` Kun valitset maksutavaksi laskun, saat tuotteet itsellesi ennen maksamista. Laskutus tapahtuu yhteistyössä Walley:n kanssa.
---
# Payment Information – Fixed part payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2b/paymentinfo/partpayment.md
## Payment information in checkout – Fixed part payment
`[Logo]` Valitessanne Walley osamaksun yrityksille, saatte erillisen laskun jokaisesta ostoksesta tilausta seuraavassa kuussa.
---
# Shop terms & conditions – Aggregated invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2b/terms/aggregated_invoice.md
## Shop terms & conditions – Aggregated invoice
### Walleyin koontilasku yrityksille
Tarjoamme yhdessä Walley:n kanssa yrityksille laskutusmahdollisuutta. Kaikki saman kuukauden ostot kootaan yhdelle laskulle, joka lähetetään asiakkaalle postitse seuraavassa kuussa. Palvelusta peritään laskutuslisä. Myöhästyneestä tai maksamattomasta laskusta peritään muistutusmaksu ja viivästyskorko.
Saat näkyviin Walleyin yrityksille tarkoitetun koontilaskutuksen ehdot kokonaisuudessaan seuraavasta linkistä: `Ehdot`
### Hyperlinks
Laskun yleiset ehdot: [https://cdn.walleypay.com/terms/Terms_B2B_FI.pdf](https://cdn.walleypay.com/terms/Terms_B2B_FI.pdf)
---
# Shop terms & conditions – Walley Checkout
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2b/terms/checkout.md
## Shop terms & conditions – Walley Checkout
### Walley Checkout
Tarjoamme mahdollisuuden maksaa laskulla yhteistyössä Walley:n kanssa. Kun valitset maksutavaksi laskun ja sinulle myönnetään laskumahdollisuus, saat tilatut tavarat itsellesi ennen niiden maksamista. Myöhästyneestä tai maksamattomasta laskusta peritään muistutusmaksu ja viivästyskorko. Saat näkyviin Walleyin laskun ehdot kokonaisuudessaan seuraavasta linkistä: `Ehdot`
### Hyperlinks
Laskun yleiset ehdot: [https://cdn.walleypay.com/terms/Terms_B2B_FI.pdf](https://cdn.walleypay.com/terms/Terms_B2B_FI.pdf)
---
# Shop terms & conditions – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2b/terms/invoice.md
## Shop terms & conditions – Invoice
### Walleyin laskuratkaisu
Tarjoamme yhdessä Walley:n kanssa yrityksille mahdollisuutta maksaa laskulla.
Kun valitset maksutavaksi laskun, saat tuotteet itsellesi ennen maksamista. Myöhästyneestä tai maksamattomasta laskusta peritään muistutusmaksu ja viivästyskorko. Saat näkyviin Walleyin laskun ehdot kokonaisuudessaan seuraavasta linkistä: `Ehdot`
### Hyperlinks
Laskun yleiset ehdot: [https://cdn.walleypay.com/terms/Terms_B2B_FI.pdf](https://cdn.walleypay.com/terms/Terms_B2B_FI.pdf)
---
# Accept
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2c/accept.md
## Accept of agreement in checkout
`[Checkbox]` Hyväksyn Walley:n yleiset lasku-, tililuotto- ja osamaksuehdot itseäni sitoviksi sekä vahvistan lukeneeni Walley in henkilötietojen käsittelyä koskevan käytännön.
### Hyperlinks
Yleiset lasku-, tililuotto- ja osamaksuehdot: [https://cdn.walleypay.com/terms/Terms_FI.pdf](https://cdn.walleypay.com/terms/Terms_FI.pdf)
Vakiomuotoiset eurooppalaiset kuluttajaluottotiedot: [https://cdn.walleypay.com/terms/SECCI_FI.pdf](https://cdn.walleypay.com/terms/SECCI_FI.pdf)
Walleyin henkilötietojen käsittelystä: [walley.fi/tietosuojasta](https://walley.fi/tietosuojasta)
---
# Calculations
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2c/calculations.md
## Calculations
### Calculation of monthly cost for account.
You can use the following algorithm to calculate the products part payment cost (in the end customers native currency):
`(Product cost / Number of months) + (Product cost * Interest rate) + Monthly fee`
For example: A product worth 9,95 € , divided on 12 months, an interest rate of 1,6583 %, and a monthly fee of 3,00 € would give the algorithm:
`(9,95 / 12) + (9,95 * 1,6583 %) + 3,00 = 4,00 € per month`
(The actual lowest amount to pay in the example would be 4,00 € per month, but the lowest accepted payment is 5 €)
### Calculating monthly cost to display on the checkout page
The same algorithm can be applied on the checkout page, but the two occurrences of product cost needs to be replaced by the total purchase amount including shipping fee:
`(Total purchase amount / Number of months) + (Total purchase amount * Interest rate) + Monthly fee`
For example: The customer orders two products, each worth 19,90 € and a shipping fee of 5,95 € is added. This algorithm would then apply:
`(45,75 / 12) + (45,75 * 1,6583 %) + 3,00 = 7,58 € per month`
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 5 €.
### Calculation of monthly cost for annuity payment
The formula used to calculate the cost is the following:
`CapitalDebt * (MonthlyInterestRate / ((1 + MonthlyInterestRate) ^ Months - 1)) + CapitalDebt * MonthlyInterestRate + InvoiceFee`
Here's an example: if the total basket value is 321,8€, it gives the following:
`321,8 * (1,6583% / ((1 + 1,6583%) ^ 24 - 1)) + 321,8 * 1,6583% +3,00 = 19,37€ per month`
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 5 €.
---
# Order Confirmation
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2c/orderconfirmation.md
## Order Confirmation
This text can be added to your order confirmation email that you distribute to the end customer
For more information on how you can promote our app [download our app kit](https://cdn.walleypay.com/banner/walley-appkit.zip)
### Maksaminen
Walley lähettää tiedot ostoksesi maksamiseen liittyen erillisessä sähköpostiviestissä. Voit jo nyt kirjautua [MyWalley](https://my.walley.fi/) -sivuille, tai ladata Walley -sovelluksen [App Storesta](https://apps.apple.com/no/app/walley/id1569382782) tai [Google Playsta](https://play.google.com/store/apps/details?id=com.walleypay.app).
Walley -sovelluksessa voit nähdä yleiskatsauksen laskuistasi, siirtää eräpäiviä ja pysäyttää laskutuksen, jos olet palauttanut tuotteita. Jos otat ilmoitukset käyttöön saat myös muistutuksen, kun on aika maksaa lasku.
---
# Payment Information – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2c/paymentinfo/account.md
## Payment information in checkout - Account
`[Logo]` Kun valitset maksutavaksi laskun ja sinulle myönnetään laskumahdollisuus, saat tilatut tavarat itsellesi ennen niiden maksamista. Voit maksaa koko laskun summan kerralla tai, jos sinulle myönnetään mahdollisuus maksaa tililuotolla, jakaa maksun pienempiin osiin maksamalla vähintään laskulla näkyvän vähimmäissumman eräpäivään mennessä. Laskun osissa maksaminen edellyttää, että laskun saatuasi allekirjoitat luottosopimuksen Walley:n kanssa kirjautumalla Omille Sivuille osoitteessa [my.walley.fi](https://my.walley.fi).
---
# Payment Information – Campaign
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2c/paymentinfo/campaign.md
## Payment information in checkout – Campaign
`[Logo]`
### Placeholders
`` - The agreed campaign length, `` - The agreed due date `` - The agreed campaign fee, e.g. "3 €"
---
# Payment Information – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2c/paymentinfo/invoice.md
## Payment information in checkout - Invoice
`[Logo]` Kun valitset maksutavaksi laskun ja sinulle myönnetään laskumahdollisuus, saat tilatut tavarat itsellesi ennen niiden maksamista. Voit maksaa koko laskun summan kerralla tai, jos sinulle myönnetään mahdollisuus maksaa tililuotolla, jakaa maksun pienempiin osiin maksamalla vähintään laskulla näkyvän vähimmäissumman eräpäivään mennessä. Laskun osissa maksaminen edellyttää, että laskun saatuasi allekirjoitat luottosopimuksen Walley:n kanssa kirjautumalla Omille Sivuille osoitteessa [my.walley.fi](https://my.walley.fi).
---
# Payment Information – Fixed part payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2c/paymentinfo/partpayment.md
## Payment information in checkout – Fixed part payment
`[Logo]` Kun valitset maksutavaksi laskun ja sinulle myönnetään laskumahdollisuus, saat tilatut tavarat itsellesi ennen niiden maksamista. Voit maksaa koko laskun summan kerralla tai, jos sinulle myönnetään mahdollisuus maksaa tililuotolla, jakaa maksun pienempiin osiin maksamalla vähintään laskulla näkyvän vähimmäissumman eräpäivään mennessä. Laskun osissa maksaminen edellyttää, että laskun saatuasi allekirjoitat luottosopimuksen Walley:n kanssa kirjautumalla Omille Sivuille osoitteessa [my.walley.fi](https://my.walley.fi).
---
# Shop terms & conditions – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2c/terms/account.md
## Shop terms & conditions – Account
### Lasku ja Tililuotto
Tarjoamme mahdollisuuden maksaa laskulla yhteistyössä Walley:n kanssa. Kun valitset maksutavaksi laskun ja sinulle myönnetään laskumahdollisuus, saat tilatut tavarat itsellesi ennen niiden maksamista.
Voit maksaa koko laskun summan kerralla tai, jos sinulle myönnetään mahdollisuus maksaa tililuotolla, jakaa maksun pienempiin osiin maksamalla vähintään laskulla näkyvän vähimmäissumman eräpäivään mennessä. Laskun osissa maksaminen edellyttää, että laskun saatuasi allekirjoitat luottosopimuksen Walley:n kanssa kirjautumalla Omille Sivuille osoitteessa [my.walley.fi](https://my.walley.fi).
Kun valitset laskulla tai tililuotolla maksamisen, voit tehdä tilauksen ainoastaan väestörekisterissä olevaan vakituiseen osoitteeseesi. Sinun tulee olla vähintään 18-vuotias tilaushetkellä ja Walley tekee luottotietojesi tarkastuksen tilauksen yhteydessä. Viivästyneistä maksuista veloitetaan lainmukaiset muistutusmaksut ja perintäkulut sekä korkoa viivästyneeltä ajalta.
Saat täydelliset ehdot ja tiedot Walley Laskusta ja Tililuotosta seuraavista linkeistä:`Ehdot`ja `SECCI`
### Hyperlinks
Yleiset lasku-, tililuotto- ja osamaksuehdot: [https://cdn.walleypay.com/terms/Terms_FI.pdf](https://cdn.walleypay.com/terms/Terms_FI.pdf)
Vakiomuotoiset eurooppalaiset kuluttajaluottotiedot: [https://cdn.walleypay.com/terms/SECCI_FI.pdf](https://cdn.walleypay.com/terms/SECCI_FI.pdf)
---
# Shop terms & conditions – Walley Checkout
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2c/terms/checkout.md
## Shop terms & conditions – Walley Checkout
### Walley Checkout
Yhteistyössä Walleyn kanssa tarjoamme maksuvaihtoehdot Walley Checkoutissa. Walley Checkout kokoaa kaikki tärkeät maksutavat yhteen ja samaan ratkaisuun - valitse MobilePay, suora pankki- ja korttimaksu, lasku tai osamaksu (maksuvaihtoehdot voivat vaihdella ajan myötä). Päätät kassalla, mitä maksutapaa haluat käyttää, ennen kuin vahvistat ostoksen.
Laskulla tai osissa maksu tarkoittaa, että saat tavarat ennen maksamista. Voit joko maksaa koko summan kerralla tai jakaa sen pienempiin osiin. Eräpäivät voivat vaihdella ja ne näkyvät sinulle lähetetyllä laskulla. Toimitustavat ja mahdolliset lisämaksut näkyvät kassalla ennen ostoksen vahvistamista. Laskun hyväksymisen yhteydessä luottotietosi tarkistetaan. Jos maksu viivästyy tai jää tekemättä, peritään viivästyskorot ja muistutusmaksut ehtojen mukaisesti. Walleyn täydelliset ehdot ja SECCI löytyvät täältä: Käyttöehdot ja SECCI.
### Walley-sovellus
Walley-sovelluksella saat selkeän yleiskuvan kaikista ostoistasi ja maksuistasi – suoraan puhelimeesi. Voit hallita maksuja sinulle sopivalla tavalla ja oman budjettisi mukaan. Voit siirtää eräpäivää, jakaa ostoksen useampaan maksuerään ja päättää itse haluatko maksaa heti, eräpäivänä tai käyttää automatisoitua maksamista. Kun otat ilmoitukset käyttöön, saat muistutuksia tulevista maksuista. Sovellus on ilmainen ladata ja käyttää.
#### Lataa Walley-sovellus täältä:
- [**App Store**](https://apps.apple.com/se/app/walley/id1569382782)
- [**Google Play**](https://play.google.com/store/apps/details?id=com.walleypay.app)
### Hyperlinks
Yleiset lasku-, tililuotto- ja osamaksuehdot: [https://cdn.walleypay.com/terms/Terms_FI.pdf](https://cdn.walleypay.com/terms/Terms_FI.pdf)
Vakiomuotoiset eurooppalaiset kuluttajaluottotiedot: [https://cdn.walleypay.com/terms/SECCI_FI.pdf](https://cdn.walleypay.com/terms/SECCI_FI.pdf)
---
# Shop terms & conditions – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2c/terms/invoice.md
## Shop terms & conditions – Invoice
### Lasku ja Tililuotto
Tarjoamme mahdollisuuden maksaa laskulla yhteistyössä Walley:n kanssa. Kun valitset maksutavaksi laskun ja sinulle myönnetään laskumahdollisuus, saat tilatut tavarat itsellesi ennen niiden maksamista.
Voit maksaa koko laskun summan kerralla tai, jos sinulle myönnetään mahdollisuus maksaa tililuotolla, jakaa maksun pienempiin osiin maksamalla vähintään laskulla näkyvän vähimmäissumman eräpäivään mennessä. Laskun osissa maksaminen edellyttää, että laskun saatuasi allekirjoitat luottosopimuksen Walley:n kanssa kirjautumalla Omille Sivuille osoitteessa [my.walley.fi](https://my.walley.fi).
Kun valitset laskulla tai tililuotolla maksamisen, voit tehdä tilauksen ainoastaan väestörekisterissä olevaan vakituiseen osoitteeseesi. Sinun tulee olla vähintään 18-vuotias tilaushetkellä ja Walley tekee luottotietojesi tarkastuksen tilauksen yhteydessä. Viivästyneistä maksuista veloitetaan lainmukaiset muistutusmaksut ja perintäkulut sekä korkoa viivästyneeltä ajalta.
Saat täydelliset ehdot ja tiedot Walley Laskusta ja Tililuotosta seuraavista linkeistä:`Ehdot`ja `SECCI`
### Hyperlinks
Yleiset lasku-, tililuotto- ja osamaksuehdot: [https://cdn.walleypay.com/terms/Terms_FI.pdf](https://cdn.walleypay.com/terms/Terms_FI.pdf)
Vakiomuotoiset eurooppalaiset kuluttajaluottotiedot: [https://cdn.walleypay.com/terms/SECCI_FI.pdf](https://cdn.walleypay.com/terms/SECCI_FI.pdf)
---
# Shop terms & conditions – Fixed Part Payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/finland/b2c/terms/partpayment.md
## Shop terms & conditions – Fixed part payment
### Lasku ja Tililuotto
Tarjoamme mahdollisuuden maksaa laskulla yhteistyössä Walley:n kanssa. Kun valitset maksutavaksi laskun ja sinulle myönnetään laskumahdollisuus, saat tilatut tavarat itsellesi ennen niiden maksamista.
Voit maksaa koko laskun summan kerralla tai, jos sinulle myönnetään mahdollisuus maksaa tililuotolla, jakaa maksun pienempiin osiin maksamalla vähintään laskulla näkyvän vähimmäissumman eräpäivään mennessä. Laskun osissa maksaminen edellyttää, että laskun saatuasi allekirjoitat luottosopimuksen Walley:n kanssa kirjautumalla Omille Sivuille osoitteessa [my.walley.fi](https://my.walley.fi).
Kun valitset laskulla tai tililuotolla maksamisen, voit tehdä tilauksen ainoastaan väestörekisterissä olevaan vakituiseen osoitteeseesi. Sinun tulee olla vähintään 18-vuotias tilaushetkellä ja Walley tekee luottotietojesi tarkastuksen tilauksen yhteydessä. Viivästyneistä maksuista veloitetaan lainmukaiset muistutusmaksut ja perintäkulut sekä korkoa viivästyneeltä ajalta.
Saat täydelliset ehdot ja tiedot Walley Laskusta ja Tililuotosta seuraavista linkeistä: `Ehdot`ja `SECCI`
### Hyperlinks
Yleiset lasku-, tililuotto- ja osamaksuehdot: [https://cdn.walleypay.com/terms/Terms_FI.pdf](https://cdn.walleypay.com/terms/Terms_FI.pdf)
Vakiomuotoiset eurooppalaiset kuluttajaluottotiedot: [https://cdn.walleypay.com/terms/SECCI_FI.pdf](https://cdn.walleypay.com/terms/SECCI_FI.pdf)
---
# Accept
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2b/accept.md
## Accept of agreement in checkout
`[Checkbox]` Jeg godkjenner Walleys Alminnelige vilkår faktura.
### Hyperlinks
Alminnelige vilkår faktura: [https://cdn.walleypay.com/terms/Terms_B2B_NO.pdf](https://cdn.walleypay.com/terms/Terms_B2B_NO.pdf)
---
# Payment Information – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2b/paymentinfo/account.md
## Payment information in checkout – Aggregated invoice
`[Logo]` Når du velger samlefaktura for bedrifter får du varene levert før du gjør din betaling. Du får alle kjøp som er gjort under samme måned på en samlet faktura.
---
# Payment Information – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2b/paymentinfo/invoice.md
## Payment information in checkout - Invoice
`[Logo]` Når du velger faktura for bedrifter får du varene levert før du gjør din betaling.
---
# Payment Information – Fixed part payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2b/paymentinfo/partpayment.md
## Payment information in checkout – Fixed part payment
`[Logo]` Når dere velger delbetaling for bedrift få du varene levert før du gjør din betaling. Du får en faktura per kjøp. Fakturaen sendes måneden etter kjøpet.
---
# Shop terms & conditions – Aggregated invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2b/terms/aggregated_invoice.md
## Shop terms & conditions – Aggregated invoice
###Samlefaktura for bedrifter
I samarbeid med Walley tilbyr vi betaling via samlefaktura for bedrifter. Alle kjøp som er gjort samme måned samles på en faktura, som sendes påfølgende måned. Faktura innebærer at du får varene leverert før du betaler. Forfallsdatoen kan variere, og angis på fakturan som sendes til dere. Leveringsmåten samt eventuelle avgifter vises i kassen før du bekrefter kjøpet. Ved forsinket eller uteblitt betaling debiteres en avgift samt forsinkelsesrente. Fullstendige vilkår for Walley finner du her: `Vilkår`.
### Hyperlinks
Alminnelige vilkår faktura: [https://cdn.walleypay.com/terms/Terms_B2B_NO.pdf](https://cdn.walleypay.com/terms/Terms_B2B_NO.pdf)
---
# Shop terms & conditions – Walley Checkout
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2b/terms/checkout.md
## Shop terms & conditions – Walley Checkout
### Walley Checkout
I samarbeid med Walley tilbyr vi betaling med Walley Checkout. Walley Checkout samler alle de viktigste betalingsmåtene i en og samme løsning - velg mellom kortbetaling, faktura eller delbetaling (betalingsalternativene kan variere over tid (betalingsalternativene kan variere over tid). Dere bestemmer selv hvilken betalingsmåte dere ønsker å benytte i kassen, før dere bekrefter kjøpet.
Faktura eller delbetaling innebærer at du får varene leverert før du betaler. Forfallsdatoen kan variere, og angis på fakturan som sendes til dere. Leveringsmåten samt eventuelle avgifter vises i kassen før du bekrefter kjøpet. Ved forsinket eller uteblitt betaling debiteres en avgift samt forsinkelsesrente. Fullstendige vilkår for Walley finner du her: `Vilkår`
### Hyperlinks
Alminnelige vilkår faktura: [https://cdn.walleypay.com/terms/Terms_B2B_NO.pdf](https://cdn.walleypay.com/terms/Terms_B2B_NO.pdf)
---
# Shop terms & conditions – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2b/terms/invoice.md
## Shop terms & conditions – Invoice
###Faktura för företag
I samarbete med Walley erbjuder vi betalnig med faktura för företag. Faktura innebär att du får levererat varorna innan du betalar. Förfallodatum kan skilja sig åt och framgår på den faktura som skickas till företaget. Leveranssätt samt eventuella avgifter som tillkommer visas i kassan innan du bekräftar köpet. Vid försenad eller utebliven betalning debiteras en förseningsavgift samt dröjsmålsränta. Fullständiga villkor för Walley hittar du här: `Villkor`.
### Hyperlinks
Alminnelige vilkår faktura: [https://cdn.walleypay.com/terms/Terms_B2B_NO.pdf](https://cdn.walleypay.com/terms/Terms_B2B_NO.pdf)
---
# Shop terms & conditions – Fixed Part Payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2b/terms/partpayment.md
##Shop terms & conditions – Fixed Part Payment
### Delbetaling for bedrift
I samarbeid med Walley tilbyr vi delbetaling for bedrift. Delbetaling innebærer at du får varene leverert før du betaler. Forfallsdatoen kan variere, og angis på fakturan som sendes til dere. Leveringsmåten samt eventuelle avgifter vises i kassen før du bekrefter kjøpet. Ved forsinket eller uteblitt betaling debiteres en avgift samt forsinkelsesrente. Fullstendige vilkår for Walley finner du her: `Vilkår`
### Hyperlinks
Alminnelige vilkår faktura: [https://cdn.walleypay.com/terms/Terms_B2B_NO.pdf](https://cdn.walleypay.com/terms/Terms_B2B_NO.pdf)
---
# Accept
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2c/accept.md
## Accept of agreement in checkout
`[Checkbox]` Jeg har benyttet meg av og aksepterer Walleys Alminnelige villkår for faktura og kontokredit, standard europeisk brukerkreditinformasjon og bekrefter herved og ha lest Walleys handtering av personopplysninger.
### Hyperlinks
Alminnelige villkår for faktura og kontokredit: [https://cdn.walleypay.com/terms/Terms_NO.pdf](https://cdn.walleypay.com/terms/Terms_NO.pdf)
Standard europeisk brukerkreditinformasjon: [https://cdn.walleypay.com/terms/SECCI_NO.pdf](https://cdn.walleypay.com/terms/SECCI_NO.pdf)
Walleys handtering av personopplysninger: www.walley.no/personvern
---
# Calculations
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2c/calculations.md
## Calculations
### Calculation of monthly cost for account.
You can use the following algorithm to calculate the products part payment cost (in the end customers native currency):
`(Product cost / Number of months) + (Product cost * Interest rate) + Monthly fee`
For example: A product worth 200 NOK, divided on 12 months, an interest rate of 1,6583%, and a monthly fee of 35 NOK would give the algorithm:
`(200 / 12) + (200 * 1,6583%) + 35 = 55 NOK per month`
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 50 NOK.
### Calculating monthly cost to display on check-out page
The same algorithm can be applied on the checkout page, but the two occurrences of product cost needs to be replaced by the total purchase amount including shipping fee:
`(Total purchase amount / Number of months) + (Total purchase amount * Interest rate) + Monthly fee`
For example: The customer orders two products worth 195 NOK and a shipping fee of 59 NOK is added. This algorithm would then apply:
`(449 / 12) + (449 * 1,6583%) + 35 = 80 NOK per month`
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 50 NOK.
### Calculation of monthly cost for interest free part payment.
The formula used to calculate the cost is as follows:
`(Order sum + (Invoice fee * months)) / months`
Here's an example: if the total basket value is 3456 NOK, it would give the following calculation:
`(3456 + (35 * 12)) / 12 = 323kr/month`
Please note that an origination fee is added to the first invoice. The standard set of instalment plans and their origination fees and interest rates can be found in the table below, however, please refer to your merchant agreement with Walley to get the correct origination fee amounts.
Using the example amount above and an origination fee of 295 NOK, a first invoices lowest amount to pay would be 323 + 295 = 618 NOK.
### Calculation of monthly cost for annuity payment
The formula used to calculate the cost is the following:
`CapitalDebt * (MonthlyInterestRate / ((1 + MonthlyInterestRate) ^ Months - 1)) + CapitalDebt * MonthlyInterestRate + InvoiceFee`
Here's an example: if the total basket value is 3456 NOK, it would give the following calculation:
`3456 _ (1,6583% / ((1 + 1,6583%) ^ 24 - 1)) + 3456 _ 1,6583% +35 = 215 NOK/month`
PLEASE NOTE
Please note that an origination fee is added to the first invoice. The standard set of instalment plans and their origination fees and interest rates can be found in the table below, however, please refer to your merchant agreement with Walley to get the correct origination fee amounts.
Using the example amount above and an origination fee of 295 NOK, a first invoices lowest amount to pay would be 215 + 295 = 510 NOK.
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 50 NOK.
---
# Order Confirmation
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2c/orderconfirmation.md
## Order Confirmation
This text can be added to your order confirmation email that you distribute to the end customer
For more information on how you can promote our app [download our app kit](https://cdn.walleypay.com/banner/walley-appkit.zip)
### Betaling
Informasjon om din betaling sendes i en separat mail fra Walley.
Du kan allerede nå logge inn på [MyWalley](https://my.walley.no/) eller laste ned Walley-appen fra [App Store](https://apps.apple.com/no/app/walley/id1569382782) eller [Google Play](https://play.google.com/store/apps/details?id=com.walleypay.app).
Med Walley -appen kan du se alle dine kjøp og pause en faktura om du vil returnere en vare eller forlenge betalingstiden. Om du aktiverer notifikasjoner i appen blir du påminnet når betalingsfristen nærmer seg.
---
# Payment Information – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2c/paymentinfo/account.md
## Payment information in checkout - Account
`[Logo]` Når du velger konto får du varene tilsendt hjem før du betaler. Du får alle kjøp som er gjort under samme måned på en samlet faktura. Du kan deretter velge å betale hele beløpet med en gang eller dele opp betalingen i mindre deler. For å delbetale kjøpet kreves at du inngår en kredittavtale med Norion Bank AB (registrert innehaver av varemerket Walley) før fakturaen forfaller til betaling. Dette gjør du enkelt ved å signere og sende inn kredittavtalen, se my.walley.no.
---
# Payment Information – Campaign
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2c/paymentinfo/campaign.md
## Payment information in checkout – Campaign
`[Logo]`
### Kjøp nå – betal senere!
Alle kjøp t.o.m. `` som er utført i forbindelse med denne kampanjen gir deg betalingsutsettelse til ``. Kampanjegebyr på `` kommer i tillegg.
### Placeholders
`` - The agreed campaign length, `` - The agreed due date `` - The agreed campaign fee, e.g. "39 kr"
---
# Payment Information – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2c/paymentinfo/invoice.md
## Payment information in checkout - Invoice
`[Logo]` Når du velger faktura får du varene tilsendt hjem før du betaler. Du kan deretter velge å betale hele beløpet med en gang eller dele opp betalingen i mindre deler. For å delbetale kjøpet kreves at du inngår en kredittavtale med Norion Bank AB (registrert innehaver av varemerket Walley) før fakturaen forfaller til betaling. Dette gjør du enkelt ved å signere og sende inn kredittavtalen, se my.walley.no.
---
# Payment Information – Fixed part payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2c/paymentinfo/partpayment.md
## Payment information in checkout - Fixed part payment
`[Logo]` Når du velger delbetaling får du varene tilsendt hjem før du betaler. En faktura sendes måneden som følger etter ditt kjøp. Følg din avbetalingsplan ved å betale inn det faste beløpet som fremkommer på din faktura. For å delbetale kjøpet kreves at du inngår en kredittavtale med Norion Bank AB (registrert innehaver av varemerket Walley) før fakturaen forfaller til betaling. Dette gjør du enkelt ved å signere og sende inn kredittavtalen, se my.walley.no.
---
# Shop terms & conditions – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2c/terms/account.md
## Shop terms & conditions – Account
### Konto
I samarbeid med Walley tilbyr vi delbetaling via konto. Konto innebærer at du får varene hjem til deg før du betaler. Du kan deretter velge om du vil betale hele beløpet med en gang, eller om du ønsker å dele det opp i mindre deler. Forfallsdatoen kan variere, og angis på faktura eller delbetalingsanvisningen som sendes til deg. Leveringsmåten samt eventuelle avgifter vises i kassen før du bekrefter kjøpet. For å delbetale kjøpet kreves at du inngår en kredittavtale med Norion Bank AB (registrert innehaver av varemerket Walley) før fakturaen forfaller til betaling. Dette gjør du enkelt ved å signere og sende inn kredittavtalen, se [my.walley.no](https://my.walley.no).
En kredittvurdering vil bli utført, og dette innebærer at dine kredittopplysninger blir innhentet. Ved forsinkelser eller manglende betaling blir det bli lagt til en forsinkelsesavgift samt forsinkelsesrenter. Fullstendige vilkår for Walley finner du her: `Vilkår` og `SECCI.
På [my.walley.no](https://my.walley.no) kan du se alle fakturaene dine fra Walley.
### Hyperlinks
Alminnelige villkår for faktura og kontokredit: [https://cdn.walleypay.com/terms/Terms_NO.pdf](https://cdn.walleypay.com/terms/Terms_NO.pdf)
Standard europeisk brukerkreditinformasjon: [https://cdn.walleypay.com/terms/SECCI_NO.pdf](https://cdn.walleypay.com/terms/SECCI_NO.pdf)
---
# Shop terms & conditions – Walley Checkout
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2c/terms/checkout.md
## Shop terms & conditions – Walley Checkout
### Walley Checkout
I samarbeid med Walley tilbyr vi betaling med Walley Checkout. Walley Checkout samler alle de viktigste betalingsmåtene i en og samme løsning - velg mellom Vipps, kortbetaling, faktura eller delbetaling (betalingsalternativene kan variere over tid). Du bestemmer selv hvilken betalingsmåte du ønsker å benytte i kassen, før du bekrefter kjøpet.
Faktura eller delbetaling innebærer at du får varene hjem til deg før du betaler. Du kan deretter velge om du vil betale hele beløpet med en gang, eller om du ønsker å dele det opp i mindre deler. Forfallsdatoen kan variere, og angis på faktura eller delbetalingsanvisningen som sendes til deg. Leveringsmåten samt eventuelle avgifter vises i kassen før du bekrefter kjøpet. For å delbetale kjøpet kreves at du inngår en kredittavtale med Norion Bank AB (registrert innehaver av varemerket Walley) før fakturaen forfaller til betaling. Dette gjør du enkelt ved å signere og sende inn kredittavtalen, se [my.walley.no](https://my.walley.no).
En kredittvurdering vil bli utført, og dette innebærer at dine kredittopplysninger blir innhentet. Ved forsinkelser eller manglende betaling blir det bli lagt til en forsinkelsesavgift samt forsinkelsesrenter. Fullstendige vilkår for Walley finner du her: `Vilkår` og `SECCI`.
### Walley-appen
Med Walley-appen får du oversikt over alle kjøp og betalinger – direkte på mobiltelefonen din. Her kan du administrere betalingene dine på den måten som passer deg og lommeboken din best. Du kan flytte forfallsdatoen fremover, dele et kjøp eller koble bankkontoen din til å betale umiddelbart, på forfallsdatoen eller via AvtaleGiro. Ved å aktivere varsler vil du motta påminnelser for kommende betalinger. Appen er gratis å laste ned og bruke.
#### Last ned Walley-appen her:
- [**App Store**](https://apps.apple.com/se/app/walley/id1569382782)
- [**Google Play**](https://play.google.com/store/apps/details?id=com.walleypay.app)
### Hyperlinks
Alminnelige villkår for faktura og kontokredit: [https://cdn.walleypay.com/terms/Terms_NO.pdf](https://cdn.walleypay.com/terms/Terms_NO.pdf)
Standard europeisk brukerkreditinformasjon: [https://cdn.walleypay.com/terms/SECCI_NO.pdf](https://cdn.walleypay.com/terms/SECCI_NO.pdf)
---
# Shop terms & conditions – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2c/terms/invoice.md
## Shop terms & conditions – Invoice
### Faktura
I samarbeid med Walley, tilbyr vi faktura og delbetaling. Betale senere innebærer at du får varene hjem til deg før du betaler. Du kan deretter velge om du vil betale hele beløpet med en gang, eller om du ønsker å dele det opp i mindre deler. Forfallsdatoen kan variere, og angis på faktura eller delbetalingsanvisningen som sendes til deg. Leveringsmåten samt eventuelle avgifter vises i kassen før du bekrefter kjøpet. For å delbetale kjøpet kreves at du inngår en kredittavtale med Norion Bank AB (registrert innehaver av varemerket Walley) før fakturaen forfaller til betaling. Dette gjør du enkelt ved å signere og sende inn kredittavtalen, se [my.walley.no](https://my.walley.no).
En kredittvurdering vil bli utført, og dette innebærer at dine kredittopplysninger blir innhentet. Ved forsinkelser eller manglende betaling blir det bli lagt til en forsinkelsesavgift samt forsinkelsesrenter. Fullstendige vilkår for Walley finner du her: `Vilkår` og `SECCI`.
På [my.walley.no](https://my.walley.no) kan du se alle fakturaene dine fra Walley.
### Hyperlinks
Alminnelige villkår for faktura og kontokredit: [https://cdn.walleypay.com/terms/WALLEY/Invoice_NO.pdf](https://cdn.walleypay.com/terms/WALLEY/Invoice_NO.pdf)
Standard europeisk brukerkreditinformasjon: [https://cdn.walleypay.com/terms/SECCI_NO.pdf](https://cdn.walleypay.com/terms/SECCI_NO.pdf)
---
# Shop terms & conditions – Fixed Part Payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/norway/b2c/terms/partpayment.md
## Shop terms & conditions – Fixed Part Payment
### Delbetaling
I samarbeid med Walley tilbyr vi fast delbetaling. Dele opp innebærer at du får varene hjem til deg før du betaler. Du kan deretter velge om du vil betale hele beløpet med en gang, eller om du ønsker å dele det opp i mindre deler. Forfallsdatoen kan variere, og angis på faktura eller delbetalingsanvisningen som sendes til deg. Følg din avbetalingsplan ved å betale inn det faste beløpet som fremkommer på din faktura. Leveringsmåten samt eventuelle avgifter vises i kassen før du bekrefter kjøpet. For å delbetale kjøpet kreves at du inngår en kredittavtale med Norion Bank AB (registrert innehaver av varemerket Walley) før fakturaen forfaller til betaling. Dette gjør du enkelt ved å signere og sende inn kredittavtalen, se [my.walley.no](https://my.walley.no).
En kredittvurdering vil bli utført, og dette innebærer at dine kredittopplysninger blir innhentet. Ved forsinkelser eller manglende betaling blir det bli lagt til en forsinkelsesavgift samt forsinkelsesrenter. Fullstendige vilkår for Walley finner du her: `Vilkår` og `SECCI`.
På [my.walley.no](https://my.walley.no) kan du se alle fakturaene dine fra Walley.
### Hyperlinks
Alminnelige villkår for faktura og kontokredit: [https://cdn.walleypay.com/terms/Terms_NO.pdf](https://cdn.walleypay.com/terms/Terms_NO.pdf)
Standard europeisk brukerkreditinformasjon: [https://cdn.walleypay.com/terms/SECCI_NO.pdf](https://cdn.walleypay.com/terms/SECCI_NO.pdf)
---
# Overview
Source: https://dev.walleypay.com/docs/marketingAssets/terms/overview.md
The agreement texts should be used on your site to ensure that the customer has the possibility to read and understand the terms and how the payment option works before confirming the purchase. These texts are more detailed than the payment information descriptions
Depending on which type of products you'll use, the agreement texts are different.
In this section, you'll find all necessary agreement texts for all available languages. Please note that the agreement texts are divided into different parts and should be displayed in different ways on your site:
- Shop terms and conditions (information page) – Should be placed under the payment terms in your webshop
- Payment information in checkout – Should be places in the checkout when choosing the payment option invoice
- Accept of agreement in checkout – The text that must be used when customer accepting the agreement for invoice
---
# Accept
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2b/accept.md
## Accept of agreement in checkout
`[Checkbox]` Jag har tagit del av och accepterar Walleys Allmänna villkor för faktura.
### Hyperlinks
Allmänna villkor för faktura: [https://cdn.walleypay.com/terms/Terms_B2B_SE.pdf](https://cdn.walleypay.com/terms/Terms_B2B_SE.pdf)
---
# Payment Information – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2b/paymentinfo/account.md
## Payment information in checkout – Aggregated invoice
`[Logo]` När du väljer samlingsfaktura för företag får du dina varor levererade innan du betalar. Du får dessutom alla köp som gjorts under en månad samlade på en faktura.
---
# Payment Information – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2b/paymentinfo/invoice.md
## Payment information in checkout - Invoice
`[Logo]` När du väljer faktura för företag får du dina varor levererade innan du betalar.
---
# Payment Information – Fixed part payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2b/paymentinfo/partpayment.md
## Payment information in checkout – Fixed part payment
`[Logo]` När du väljer delbetalning för företag får du dina varor levererade innan du betalar. Du får fakturan för delbetalning månaden efter ditt köp.
---
# Shop terms & conditions – Aggregated invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2b/terms/aggregated_invoice.md
## Shop terms & conditions – Aggregated invoice
### Samlingsfaktura för företag
I samarbete med Walley erbjuder vi betalning via samlingsfaktura för företag. Alla köp under samma månad samlas på en faktura, som skickas ut månaden efter köp. Faktura innebär att du får levererat varorna innan du betalar. Förfallodatum kan skilja sig åt och framgår på den faktura som skickas till företaget. Leveranssätt samt eventuella avgifter som tillkommer visas i kassan innan du bekräftar köpet. Vid försenad eller utebliven betalning debiteras en förseningsavgift samt dröjsmålsränta. Fullständiga villkor för Walley hittar du här: `Villkor`.
### Hyperlinks
Allmänna villkor för faktura: [https://cdn.walleypay.com/terms/Terms_B2B_SE.pdf](https://cdn.walleypay.com/terms/Terms_B2B_SE.pdf)
---
# Shop terms & conditions – Walley Checkout
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2b/terms/checkout.md
## Shop terms & conditions – Walley Checkout
### Walley Checkout
I samarbete med Walley erbjuder vi betalning med Walley Checkout. Walley Checkout samlar alla de viktiga betalsätten i en och samma lösning – välj mellan kortbetalning, faktura eller delbetalning (betalningsalternativen kan variera över tid). Du bestämmer själva vilket betalsätt du vill använda i kassan, innan du bekräftar köpet.
Faktura eller delbetalning innebär att du får levererat varorna innan du betalar. Förfallodatum kan skilja sig åt och framgår på den faktura som skickas till företaget. Leveranssätt samt eventuella avgifter som tillkommer visas i kassan innan du bekräftar köpet. Vid försenad eller utebliven betalning debiteras en förseningsavgift samt dröjsmålsränta. Fullständiga villkor för Walley hittar du här: `Villkor`.
### Hyperlinks
Allmänna villkor för faktura: [https://cdn.walleypay.com/terms/Terms_B2B_SE.pdf](https://cdn.walleypay.com/terms/Terms_B2B_SE.pdf)Länk till CDN
---
# Shop terms & conditions – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2b/terms/invoice.md
## Shop terms & conditions – Invoice
### Faktura för företag
I samarbete med Walley erbjuder vi betalning med faktura för företag. Faktura innebär att du får levererat varorna innan du betalar. Förfallodatum kan skilja sig åt och framgår på den faktura som skickas till företaget. Leveranssätt samt eventuella avgifter som tillkommer visas i kassan innan du bekräftar köpet. Vid försenad eller utebliven betalning debiteras en förseningsavgift samt dröjsmålsränta. Fullständiga villkor för Walley hittar du här: `Villkor`.
### Hyperlinks
Allmänna villkor för faktura: [https://cdn.walleypay.com/terms/Terms_B2B_SE.pdf](https://cdn.walleypay.com/terms/Terms_B2B_SE.pdf)
---
# Shop terms & conditions – Fixed Part Payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2b/terms/partpayment.md
## Shop terms & conditions – Fixed part payment
### Delbetalning för företag
I samarbete med Walley erbjuder vi delbetalning för företag. Delbetalning innebär att du får levererat varorna innan du betalar. Förfallodatum kan skilja sig åt och framgår på den faktura som skickas till företaget månaden efter köpet. Leveranssätt samt eventuella avgifter som tillkommer visas i kassan innan du bekräftar köpet. Vid försenad eller utebliven betalning debiteras en förseningsavgift samt dröjsmålsränta. Fullständiga villkor för Walley hittar du här: `Villkor`.
### Hyperlinks
Allmänna villkor för faktura: [https://cdn.walleypay.com/terms/Terms_B2B_SE.pdf](https://cdn.walleypay.com/terms/Terms_B2B_SE.pdf)
---
# Accept
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2c/accept.md
## Accept of agreement in checkout
`[Checkbox]` Jag har tagit del av och accepterar Walleys Allmänna villkor för faktura och kontokredit, Standardiserad Europeisk Konsumentkreditinformation samt bekräftar att jag läst Walleys hantering av personuppgifter.
### Hyperlinks
Allmänna villkor för faktura och kontokredit: [https://cdn.walleypay.com/terms/Terms_SE.pdf](https://cdn.walleypay.com/terms/Terms_SE.pdf)
Standardiserad Europeisk Konsumentkreditinformation: [https://cdn.walleypay.com/terms/SECCI_SE.pdf](https://cdn.walleypay.com/terms/SECCI_SE.pdf)
Walleys hantering av personuppgifter: www.walley.se/dataskydd
---
# Calculations
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2c/calculations.md
## Calculations
### Calculation of monthly cost for account.
You can use the following algorithm to calculate the products part payment cost (in the end customers native currency):
`(Product cost / Number of months) + (Product cost * Interest rate) + Monthly fee`
For example: A product worth 200 SEK, divided on 12 months, an interest rate of 1,6583%, and a monthly fee of 35 SEK would give the algorithm:
`(200 / 12) + (200 * 1,6583%) + 35 = 55 SEK per month`
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 50 SEK.
### Calculating monthly cost to display on check-out page
The same algorithm can be applied on the checkout page, but the two occurrences of product cost needs to be replaced by the total purchase amount including shipping fee:
`(Total purchase amount / Number of months) + (Total purchase amount * Interest rate) + Monthly fee`
For example: The customer orders two products worth 195 SEK and a shipping fee of 59 SEK is added. This algorithm would then apply:
`(449 / 12) + (449 * 1,6583%) + 35 = 80 SEK per month`
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 50 SEK.
### Calculation of monthly cost for interest free part payment.
The formula used to calculate the cost is as follows:
`(Order sum + (Invoice fee * months)) / months`
Here's an example: if the total basket value is 3456 SEK, it would give the following calculation:
`(3456 + (35 * 12)) / 12 = 323kr/month`
Please note that an origination fee is added to the first invoice. The standard set of instalment plans and their origination fees and interest rates can be found in the table below, however, please refer to your merchant agreement with Walley to get the correct origination fee amounts.
Using the example amount above and an origination fee of 295 SEK, a first invoices lowest amount to pay would be 323 + 295 = 618 SEK.
### Calculation of monthly cost for annuity payment
The formula used to calculate the cost is the following:
`CapitalDebt * (MonthlyInterestRate / ((1 + MonthlyInterestRate) ^ Months - 1)) + CapitalDebt * MonthlyInterestRate + InvoiceFee`
Here's an example: if the total basket value is 3456 SEK, it would give the following calculation:
`3456 _ (1,6583% / ((1 + 1,6583%) ^ 24 - 1)) + 3456 _ 1,6583% +35 = 215 SEK/month`
PLEASE NOTE
Please note that an origination fee is added to the first invoice. The standard set of instalment plans and their origination fees and interest rates can be found in the table below, however, please refer to your merchant agreement with Walley to get the correct origination fee amounts.
Using the example amount above and an origination fee of 295 SEK, a first invoices lowest amount to pay would be 215 + 295 = 510 SEK.
Please note that the amount to pay per month should be rounded up to the nearest integer, and the lowest amount is always 50 SEK.
---
# Order Confirmation
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2c/orderconfirmation.md
## Order Confirmation
This text can be added to your order confirmation email that you distribute to the end customer
For more information on how you can promote our app [download our app kit](https://cdn.walleypay.com/banner/walley-appkit.zip)
### Betalning
Information om din betalning skickas i ett separat mejl från Walley.
Du kan redan nu logga in på [MyWalley](https://my.walley.se/) eller ladda ner Walley-appen på [App Store](https://apps.apple.com/se/app/walley/id1569382782) eller [Google Play](https://play.google.com/store/apps/details?id=com.walleypay.app). Med Walley-appen kan du snabbt och enkelt betala, pausa en faktura om du vill returnera eller förlänga betaltiden. Om du aktiverar notiser i appen blir du även påmind när det är dags att betala.
---
# Payment Information – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2c/paymentinfo/account.md
## Payment information in checkout - Account
`[Logo]` När du väljer konto får du hem dina varor innan du betalar. Du får dessutom alla dina köp som gjorts under en månad på en samlad faktura. Du kan sedan välja att betala hela beloppet på en gång eller dela upp betalningen i mindre delar.
---
# Payment Information – Campaign
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2c/paymentinfo/campaign.md
## Payment information in checkout – Campaign
`[Logo]`
### Köp nu – betala senare!
Alla köp t.o.m. `` gjorda med denna kampanj ger dig förlängd betaltid till ``. Kampanjavgift på `` tillkommer.
### Placeholders
`` - The agreed campaign length, `` - The agreed due date `` - The agreed campaign fee, e.g. "35 kr"
---
# Payment Information – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2c/paymentinfo/invoice.md
## Payment information in checkout - Invoice
`[Logo]` När du väljer faktura får du hem dina varor innan du betalar. Du kan sedan välja att betala hela beloppet på en gång eller dela upp betalningen i mindre delar.
---
# Payment Information – Fixed part payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2c/paymentinfo/partpayment.md
## Payment information in checkout – Fixed part payment
`[Logo]` När du väljer att dela upp din betalning får du hem dina varor innan du betalar. Du får en faktura månaden som följer efter ditt köp. Följ din delbetalning genom att betala in det fasta beloppet som framgår på din faktura.
---
# Shop terms & conditions – Account
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2c/terms/account.md
## Shop terms & conditions – Account
### Konto
I samarbete med Walley erbjuder vi delbetalning via konto. Konto innebär att alla dina köp under en månad samlas på en faktura, som skickas månaden efter dina köp. Du får hem dina varor innan du betalar. Förfallodatum kan skilja sig åt och framgår på den faktura eller delbetalningsavi som skickas till dig. Leveranssätt samt eventuella avgifter som tillkommer visas i kassan innan du bekräftar köpet. En kreditprövning görs, som i vissa fall innebär att en kreditupplysning tas. Vid försenad eller utebliven betalning debiteras en förseningsavgift samt dröjsmålsränta. Fullständiga villkor för Walley hittar du här: `Villkor` och `SECCI`.
På [my.walley.se](https://my.walley.se) kan du se och betala alla dina fakturor från Walley.
### Hyperlinks
Allmänna villkor för faktura och kontokredit: [https://cdn.walleypay.com/terms/Terms_SE.pdf](https://cdn.walleypay.com/terms/Terms_SE.pdf)
Standardiserad Europeisk Konsumentkreditinformation: [https://cdn.walleypay.com/terms/SECCI_SE.pdf](https://cdn.walleypay.com/terms/SECCI_SE.pdf)
---
# Shop terms & conditions – Walley Checkout
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2c/terms/checkout.md
## Shop terms & conditions – Walley Checkout
### Walley Checkout
I samarbete med Walley erbjuder vi betalning med Walley Checkout. Walley Checkout samlar alla de viktiga betalsätten i en och samma lösning – välj mellan Swish, direktbank- och kortbetalning, faktura eller delbetalning (betalningsalternativen kan variera över tid). Du bestämmer själv vilket betalsätt du vill använda i kassan, innan du bekräftar köpet.
Faktura eller delbetalning innebär att du får hem varorna innan du betalar. Du kan sedan välja att antingen betala hela beloppet på en gång eller dela upp det i mindre delar. Förfallodatum kan skilja sig åt och framgår på den faktura eller delbetalningsavi som skickas till dig. Leveranssätt samt eventuella avgifter som tillkommer visas i kassan innan du bekräftar köpet. En kreditprövning görs, som i vissa fall innebär att en kreditupplysning tas. Vid försenad eller utebliven betalning debiteras en förseningsavgift samt dröjsmålsränta. Fullständiga villkor för Walley hittar du här: `Villkor` och `SECCI`.
### Walley-appen
Med Walley-appen får du en samlad översikt över alla dina köp och betalningar – direkt i mobilen. Här kan du hantera dina betalningar på det sätt som passar dig och din plånbok bäst. Du kan flytta fram förfallodatum, dela upp ett köp eller ansluta ditt bankkonto för att betala direkt, på förfallodagen eller via autogiro. Genom att aktivera notiser får du påminnelser inför kommande betalningar. Appen är kostnadsfri att ladda ner och använda.
#### Ladda ner Walley-appen här:
- [**App Store**](https://apps.apple.com/se/app/walley/id1569382782)
- [**Google Play**](https://play.google.com/store/apps/details?id=com.walleypay.app)
### Hyperlinks
Allmänna villkor för faktura och kontokredit: [https://cdn.walleypay.com/terms/Terms_SE.pdf](https://cdn.walleypay.com/terms/Terms_SE.pdf)
Standardiserad Europeisk Konsumentkreditinformation: [https://cdn.walleypay.com/terms/SECCI_SE.pdf](https://cdn.walleypay.com/terms/SECCI_SE.pdf)
---
# Shop terms & conditions – Invoice
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2c/terms/invoice.md
## Shop terms & conditions – Invoice
### Faktura
I samarbete med Walley erbjuder vi faktura och delbetalning. Faktura innebär att du får hem varorna innan du betalar. Du kan sedan välja att antingen betala hela beloppet på en gång eller dela upp det i mindre delar. Förfallodatum kan skilja sig åt och framgår på den faktura eller delbetalningsavi som skickas till dig. Leveranssätt samt eventuella avgifter som tillkommer visas i kassan innan du bekräftar köpet. En kreditprövning görs, som i vissa fall innebär att en kreditupplysning tas. Vid försenad eller utebliven betalning debiteras en förseningsavgift samt dröjsmålsränta. Fullständiga villkor för Walley hittar du här: `Villkor` och `SECCI`.
På [my.walley.se](https://my.walley.se) kan du se och betala alla dina fakturor från Walley.
### Hyperlinks
Allmänna villkor för faktura och kontokredit: [https://cdn.walleypay.com/terms/Terms_SE.pdf](https://cdn.walleypay.com/terms/Terms_SE.pdf)
Standardiserad Europeisk Konsumentkreditinformation: [https://cdn.walleypay.com/terms/SECCI_SE.pdf](https://cdn.walleypay.com/terms/SECCI_SE.pdf)
---
# Shop terms & conditions – Fixed Part Payment
Source: https://dev.walleypay.com/docs/marketingAssets/terms/sweden/b2c/terms/partpayment.md
## Shop terms & conditions – Fixed part payment
### Delbetalning
I samarbete med Walley erbjuder vi faktura vid speciella delbetalningskampanjer. Delbetalningskampanj innebär att du får hem varorna innan du betalar. Du kan sedan välja att antingen betala hela beloppet på en gång eller dela upp det i mindre delar. Följ din delbetalning genom att betala in det fasta beloppet som framgår på din faktura. Förfallodatum kan skilja sig åt och framgår på den faktura eller delbetalningsavi som skickas till dig. Leveranssätt samt eventuella avgifter som tillkommer visas i kassan innan du bekräftar köpet. En kreditprövning görs, som i vissa fall innebär att en kreditupplysning tas. Vid försenad eller utebliven betalning debiteras en förseningsavgift samt dröjsmålsränta. Fullständiga villkor för Walley hittar du här: `Villkor` och `SECCI`.
På [my.walley.se](https://my.walley.se) kan du se och betala alla dina fakturor från Walley.
### Hyperlinks
Allmänna villkor för faktura och kontokredit: [https://cdn.walleypay.com/terms/Terms_SE.pdf](https://cdn.walleypay.com/terms/Terms_SE.pdf)
Standardiserad Europeisk Konsumentkreditinformation: [https://cdn.walleypay.com/terms/SECCI_SE.pdf](https://cdn.walleypay.com/terms/SECCI_SE.pdf)
---
# Authentication
Source: https://dev.walleypay.com/docs/mcp-server/authentication.md
To protect your data and users, Walley uses Microsoft Azure ADB2C as an
authentication service provider. To gain access to the API you must identify
your application against this service to obtain a token that you use to
identify your application against our APIs.
> Microsoft Azure ADB2C follows the standard OAuth2 and for integrating with Walley api you use the **Client Credentials** flow.
> [Read more about it](https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/)
---
# MCP Server
Source: https://dev.walleypay.com/docs/mcp-server/overview.md
Connect your AI assistant to Merchant Hub with the Model Context Protocol
(MCP). Search orders, look up settlements, and list transactions by asking
in plain language, from the tools you already use.
:::preview Beta
The MCP Server is in beta. Tools and endpoints may change without prior notice. Your feedback helps us shape it, so tell us what works and what doesn't.
:::
:::tip Have a use case in mind?
We want to hear how you plan to use the MCP Server. If you need more tools or a different way of working with your data, [contact us](/support) and we'll look at it together.
:::
## Why connect Merchant Hub to your AI assistant?
Today, getting the full picture of an order means logging in to Merchant Hub, then switching to your ERP, order management system, and e-commerce platform to piece it together. That takes time, and the answer lives in four places.
With MCP, your team works in one place. Connect the Merchant Hub MCP Server alongside MCP servers for your ERP, OMS, and e-commerce platform, and your assistant can pull data from all of them in the same conversation. Ask a question, compare records across systems, spot discrepancies, and get insights across your whole system landscape without leaving the chat.
Some examples of what that looks like in practice:
- Compare the payout in a Walley settlement with the corresponding invoices in your ERP.
- Find orders that are activated in Merchant Hub but still open in your OMS.
- Ask why a customer's order shows a different amount in your webshop than in Merchant Hub.
## What is MCP?
The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open standard that lets AI assistants call external systems through a defined set of capabilities called **tools**. The Walley MCP Server exposes Merchant Hub operations as MCP tools. Any MCP-compatible client, such as Microsoft 365 Copilot, GitHub Copilot in VS Code, or your own chat bot, can then work with your merchant data in a conversation.
## Before you start
You need:
- A Merchant Hub account with access to the data you want to work with. See [Permissions](#permissions).
- An MCP client that supports HTTP transport.
- Credentials for one of the [authentication methods](#authentication) below.
## Environments
| Environment | MCP endpoint |
| :---------- | :-------------------------------------------------- |
| Test | `https://merchanthub-mcp.aks.uat.walleydev.com/mcp` |
| Production | `https://mcp.merchanthub.walleypay.com/mcp` |
## Authentication
The MCP Server supports two ways to authenticate:
- **Browser flow.** For interactive use. Your MCP client opens a browser where you sign in with your Merchant Hub account. [Contact us](/support) to have this enabled for your organization.
- **Client credentials flow.** For automated integrations. Use a client ID and secret to request a Bearer token with the OAuth 2.0 Client Credentials grant.
The [Authentication](/docs/mcp-server/authentication) page describes how to request a token with the client credentials flow.
## Connecting your AI client
The MCP Server uses [Streamable HTTP](https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http) transport. The exact configuration depends on your client, but every client needs the same two values:
- **URL.** The MCP endpoint for your environment from the [Environments](#environments) table.
- **Headers.** An `Authorization` header with your Bearer token.
### Example: VS Code and GitHub Copilot
1. Open `.vscode/mcp.json` in your workspace, or your VS Code user settings.
2. Add the server configuration. Replace `YOUR_ACCESS_TOKEN` with a token from the [Authentication](/docs/mcp-server/authentication) page.
```json
{
"servers": {
"walley-merchanthub": {
"type": "http",
"url": "https://merchanthub-mcp.aks.uat.walleydev.com/mcp",
"headers": {
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
}
}
}
```
3. Start the server from VS Code. The tools listed below appear in your assistant.
## Available tools
Once connected, your AI assistant can use these tools:
| Tool | Description |
| :-------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------ |
| `SearchOrder` | Search orders with pagination, sorting, and full-text filtering. Supports date filters on `placedAt` and `expiresAt`. |
| `GetOrderById` | Fetch a single order by its ID. |
| `SearchSettlement` | Search settlements (reports) with pagination, sorting, and full-text filtering. Supports date filters on `startDate`, `endDate`, and `paidOutAt`. |
| `GetSettlementTransactions` | Fetch the transactions for a settlement by its ID, with pagination support. |
## Usage examples
Once connected, you can ask your assistant things like:
- _"Show me orders placed in the last 7 days"_
- _"Find order 12345 and show me its details"_
- _"Search for orders with status 'Activated'"_
- _"Show me settlements paid out this month"_
- _"List the transactions for settlement ABC-123"_
## Permissions
The MCP Server uses the same permissions as Merchant Hub. Which tools are available, and which data they return, depends on the permissions of the authenticated user. If a tool returns an authorization error, check the user's permissions under **Manage Organization** in Merchant Hub. See [User and group management](/docs/merchanthub/access/usersgroups) for details.
## Data security
:::warning Your data goes to the AI model
When you use the MCP Server with an AI assistant, order and settlement data is sent to the AI model for processing. This data can include personal and sensitive information.
You are responsible for making sure it is not leaked or exposed to unauthorized parties. That includes evaluating the AI tools and models you connect, complying with applicable data protection regulations such as GDPR, and restricting access to authorized personnel. Walley is not responsible for data handling that happens outside the MCP Server itself.
:::
---
# Amended regulations for credit marketing in Sweden
Source: https://dev.walleypay.com/docs/merchant-guide/credit-marketing-guidelines.md
Starting from March 1, 2025, new regulations will apply to how credit can be
marketed in Sweden. The aim is to reduce the risk of over-indebtedness by
making it clearer to customers that credit entails costs. In advertisements or
credit offers, a clear warning must be displayed in the form of text and a
warning triangle. Here we present Walley's interpretation of the directives
and how the requirements can be implemented. The information on this page is
provided for informational purposes only and does not constitute legal advice.
Always consult a qualified legal expert for advice tailored to your specific
situation.
## Which situations require a specific disclosure?
### Mandatory Disclosure
The disclosure must be present if an individual offer is presented and a effective interest rate example must be shown. Example:
- Pay 200 SEK/month for 12 months
### Non-Mandatory Disclosure
If credit is only mentioned as a payment option without being actively marketed, no disclosure is required. Example:
- Pay with Walley
- Buy now, pay later with Walley
## How Should the Disclosure Be Implemented?
### Product Listing (PLP)
On product listing pages (such as category pages and search results) where installment payment is mentioned, Walley suggests displaying the disclosure in a general manner, for example, in a banner.
### Product Page (PDP)
On product pages where installment payment is offered, there are two ways to display the disclosure:
- In connection with a complete price example.
- Via a link leading to detailed credit terms.
- Pages Marketing Credit
- If a page is about credit without being linked to a specific purchase, the disclosure must be clearly visible.
### Checkout
In the checkout, there are two options for presenting the disclosure:
- A general section applicable to all payment methods.
- A disclosure that becomes visible only when the customer selects a credit-based payment method, such as installment payment.
### Instore, telephone and physical materials
- Printed Materials
- For physical marketing, such as brochures, product sheets, and posters, the disclosure must be included.
For verbal marketing, such as telemarketing, the warning should be replaced with the word "note" to emphasize the importance of the information.
## Walley Checkout Example implementation
## Walley Part Payment Widget Example implementation
## More information
https://publikationer.konsumentverket.se/produkter-och-tjanster/finansiella-tjanster/kovfs-20251-konsumentverkets-foreskrifter-om-naringsidkares-upplysningsskyldighet-vid-marknadsforing-av-konsumentkrediter
---
# Overview
Source: https://dev.walleypay.com/docs/merchant-guide/legal-compliance-overview.md
This section provides legal and compliance documents for merchants using Walley's services.
## Ethics Policy
Below you can find the ethics policy documents in both Swedish and English:
### Swedish Version
Walley - Etisk Policy (Swedish) - PDF
### English Version
Walley - Ethics Policy (English) - PDF
---
# Overview
Source: https://dev.walleypay.com/docs/merchant-guide/merchant-guidelines-overview.md
This section provides an overview of the guidelines that merchants must follow
when using Walley's services. The guidelines cover various aspects of the
merchant's relationship with Walley
## Marketing of Credit in SE
[Amended regulations for credit marketing in Sweden](/docs/merchant-guide/credit-marketing-guidelines)
## Terms and Conditions
[General terms and conditions for merchants](/docs/marketingAssets/terms/overview)
---
# Managing API keys
Source: https://dev.walleypay.com/docs/merchanthub/access/apikeys.md
An API key is what your integration uses to get access tokens for Walley's APIs. Create and remove keys on the API keys tab in Manage Organization.
## Before you start
- You need the **Api key Management** permission.
- Open **Manage Organization**. Select your name in the top right and pick it from the menu.
- Read [Authentication](/docs/authentication) to see how the key is exchanged for an access token.
## Create an API key
By default, your organization can have up to 10 active API keys at the same time.
1. Open the **API keys** tab.
2. Select **Create new** and then **Api key**. If your organization has no keys yet, the tab shows a **Create Api key** button instead.
3. Optionally, enter a **Key label** so you can tell the key apart from the others.
4. Choose the **Expiration time**. The key stops working after that time.
5. Select **Create**.
6. Copy the **Client ID** and **Secret** from the dialog and store them in a safe location. The secret is shown only once, and you need both to get an access token.
:::warning Rotate keys before they expire
Set a short expiry and rotate keys at least once a year, more often if you can. Rotate before the expiry date so your integration never stops working.
:::
## Remove an API key
:::warning Removing a key cannot be undone
Any integration that uses the key stops working as soon as you remove it.
:::
1. Find the key in the list.
2. Select **Remove** on that row.
3. Confirm the removal.
---
# Managing users and groups
Source: https://dev.walleypay.com/docs/merchanthub/access/usersgroups.md
Invite the people in your organization to the Merchant Hub and use groups to decide which views and which stores each of them can see.
## Before you start
- Open **Manage Organization**. Select your name in the top right and pick it from the menu.
- To invite users, you need the **Access Management** permission.
## How access works
- A user belongs to one or more groups and gets the combined permissions of all of them.
- A group's permissions decide which areas its members can use. One group might have read access to orders while another has read and write access.
- A group also decides which stores its members can see. Users who need both B2C and B2B stores can be members of both groups.
The permission areas are Access Management, Order Management, Paylink Management, Report Management, Api key Management, Webhook Management, Store Management, Dashboard Management, and Developer Logs. Each page in this section says which one it needs.
## Invite a user
1. Select **Invite user**.
2. Enter the person's name and email address.
3. Choose the group the user should belong to.
4. Select **Send invite**.
The person receives an email with a link that is valid for 7 days.
## Resend or delete an invite
Pending invites are listed under **Users** on the **Pending users** tab, together with their expiry dates.
1. Open the action menu on the right side of the row.
2. Select **Resend** to send the invitation again, **Copy invite link** to share it yourself, or **Delete** to remove it.
## Create a group
1. Select **Create new** and then **Group**.
2. Enter a name for the group.
3. Select **Create Group**.
4. Select **Set Group Permission**.
5. Tick the permissions the group should have.
## Add a user to a group
Only users who have accepted their invite can be added to a group.
1. Open the **Groups** tab.
2. Select the group you want to edit.
3. Choose the user in the dropdown in the top right and select **Add user**.
## Next steps
- Create [API keys](/docs/merchanthub/access/apikeys) for your integration.
- Subscribe to order events with [webhooks](/docs/merchanthub/access/webhooks).
---
# Managing webhooks
Source: https://dev.walleypay.com/docs/merchanthub/access/webhooks.md
A webhook tells Walley where to send updates about your orders. Create, test, and manage webhooks on the Webhooks tab in Manage Organization.
## Before you start
- You need the **Webhook Management** permission.
- Open **Manage Organization**. Select your name in the top right and pick it from the menu.
- Read the [webhooks overview](/docs/webhooks/overview) for the events you can subscribe to and how to verify the signature.
## Create a webhook
1. Select **Create new** and then **Webhook**.
2. Fill in the webhook details:
- The HTTPS endpoint Walley should call
- The events you want to subscribe to
- The stores that should generate the events
- The authentication to use
3. Select **Create**.
4. Copy the HMAC key from the dialog that opens and store it safely. You need it to verify incoming webhooks.
Hover over an event or store to see more details in a tooltip.
## Test a webhook
1. Open the menu on the right side of the webhook's row.
2. Select **Test configuration**.
3. Choose the event to test.
4. Select **Test**.
A dialog shows the response code from your endpoint. A successful test returns 200.
## Disable or enable a webhook
1. Open the menu on the right side of the webhook's row.
2. Select **Disable** or **Enable**.
## Delete a webhook
:::warning Deleting a webhook cannot be undone
Walley stops sending events to the endpoint as soon as you delete it.
:::
1. Open the menu on the right side of the webhook's row.
2. Select **Delete**.
## Failed webhooks
A failed webhook is an event that Walley could not deliver to your endpoint. Review them on the **Failed webhooks** tab.
1. Tick the webhooks you want to resend or delete, or tick the checkbox in the header to select all.
2. Select **Resend** or **Delete**.
Select a row to open the details of a failed webhook.
---
# Crediting fees on a notification
Source: https://dev.walleypay.com/docs/merchanthub/account/creditfees.md
A notification is the invoice or payment notice that Walley sends to your customer. If your agreement allows it, you can credit the administrative fees Walley added to it.
## Before you start
Your organization must be allowed to credit fees. If you are unsure, contact Walley Merchant Services at help@walley.se.
## Credit fees
1. Open a notification that has fees added by Walley.
2. Select **Credit fees**.
3. In the dialog, tick the fees to credit.
4. Select **Credit**.
---
# Extending a notification
Source: https://dev.walleypay.com/docs/merchanthub/account/extendNotification.md
A notification is the invoice or payment notice that Walley sends to your customer. Extend it to give the customer more time to pay.
## Before you start
- A notification can be extended only once.
- How many days you can extend by depends on your agreement with Walley.
## Extend a notification
1. Open the notification.
2. Select **Extend**.
3. Select **Yes** to confirm.
## Next steps
- [Resend the notification](/docs/merchanthub/account/resend) if the customer did not receive it.
- [Credit fees](/docs/merchanthub/account/creditfees) that Walley added to the notification.
---
# Resending a notification
Source: https://dev.walleypay.com/docs/merchanthub/account/resend.md
A notification is the invoice or payment notice that Walley sends to your customer. Resend it when the customer did not receive the first one or has misplaced it.
:::info Postal fee
Resending by post adds an extra fee.
:::
## Resend a notification
1. Open the notification.
2. Select **Resend**.
3. Select **Send by email** or **Send by post**.
4. Select **Send**.
## Next steps
- [Extend the notification](/docs/merchanthub/account/extendNotification) if the customer needs more time to pay.
---
# Developer Logs
Source: https://dev.walleypay.com/docs/merchanthub/developerLogs/overview.md
The Developer Logs record every request your organization makes to the Walley API, together with the response. Use them to review your API traffic and track down unexpected responses.
## Before you start
The **Developer Logs** tab appears in the top menu only for users whose group has the Developer Logs permission.
1. Open **Manage Organization**. Select your name in the top right and pick it from the menu.
2. Enable the **Developer Logs** permission for the group. See [Managing users and groups](/docs/merchanthub/access/usersgroups#create-a-group).
## Read the logs
Each API call is a row in the table.
Select a row to see the full request and response.
---
# Merchant Hub environments
Source: https://dev.walleypay.com/docs/merchanthub/environments.md
The Merchant Hub runs in a test environment and a production environment. Use the test environment to try things out without touching real orders.
| Environment | URL |
| :---------- | :----------------------------------------------------------------------------- |
| Test | [merchanthub.aks.uat.walleydev.com](https://merchanthub.aks.uat.walleydev.com) |
| Production | [merchanthub.walleypay.com](https://merchanthub.walleypay.com) |
---
# Merchant Hub FAQ
Source: https://dev.walleypay.com/docs/merchanthub/faq.md
Short answers to the questions we hear most about the Merchant Hub. Each answer links to the page with the full story.
## What is the Merchant Hub?
The Merchant Hub is where you see and manage every order your customers place with Walley. You can activate, edit, return, extend, and cancel orders, handle the notifications sent to your customers, download settlements, and generate reports. The order and settlement operations are also available through the [Management API](/docs/manage/getting-started/quickstart), so you can automate those workflows.
## How do I get access?
Walley Merchant Services invites the first administrator in your organization. That administrator can then invite and manage users without contacting Walley. Contact help@walley.se if you are the administrator and have not received an invitation. See [Logging in](/docs/merchanthub/login).
## How do I change the language?
Not yet. Menus and buttons are in English. Your own data, such as article descriptions, is shown in the language it was entered in.
## How do I control who sees what?
Access is controlled by groups. A user belongs to one or more groups and gets the combined permissions of all of them. Each group has permissions for specific areas, such as read or write access to orders, and access to specific stores. A contact centre group might see only your B2C stores, for example, while another group handles B2B. See [Managing users and groups](/docs/merchanthub/access/usersgroups).
## How can I see what happened to an order?
Open the order from the order search. The timeline at the bottom of the order details lists every event, newest first, with a timestamp, who initiated it, and through which system.
The most common events are:
| Event | Description |
| -------------------- | ---------------------------------------------------------- |
| Order created | The order was created |
| Rows activated | Rows were activated, and by whom |
| Return made | A full or partial return was made |
| Rows changed | Rows on the order were changed |
| Notification created | A notification was created for the order |
| Notification sent | A notification was sent to the customer |
## What are the different order statuses?
| Status | Shown as | Description |
| -------------------- | ------------------- | ------------------------------------------------------------------------------------------------------- |
| `NotActivated` | Not activated | The order is not yet activated and is not ready to be shipped |
| `PartActivated` | Partly activated | Some rows of the order are activated and ready to be shipped, while others are not |
| `Activated` | Activated | Every row is activated and ready to be shipped. Activated orders are included in payouts |
| `Returned` | Returned | Every row of the order has been returned by the customer |
| `Expired` | Expired | The time to activate the order ran out. You can still [extend](/docs/merchanthub/orders/extendOrder) it |
| `OnHold` | On hold | The order needs signing under a credit agreement, or is under a short fraud investigation |
| `VerificationNeeded` | Verification needed | The order needs a signed credit agreement before it can be activated |
| `Closed` | Closed | The order is settled and no longer open for changes |
The first column is the name the search uses, the second is what the order list shows. See [Searching for orders](/docs/merchanthub/search#field-queries) for how to filter on status.
## What is a notification?
A notification is the invoice or payment notice that Walley sends to your customer. You can [extend](/docs/merchanthub/account/extendNotification), [resend](/docs/merchanthub/account/resend), or [credit fees on](/docs/merchanthub/account/creditfees) a notification from the Merchant Hub.
## What can I search for?
Almost anything stored on an order: order number, email address, national registration number, name, or address. You can also filter on specific fields, such as `storeId:1158 AND status:Activated`. See [Searching for orders](/docs/merchanthub/search) for the full syntax and the list of searchable fields.
## Who do I contact for help?
- Questions about the Merchant Hub and your orders: Walley Merchant Services at help@walley.se.
- Questions about getting Pay Link or new stores set up: delivery@walley.se.
---
# Walley Merchant Hub
Source: https://dev.walleypay.com/docs/merchanthub/intro.md
The Merchant Hub is where you manage your Walley orders, users, API keys,
webhooks, Pay Links, and reports. When you become a Walley customer, you are
invited with your company email address. Explore the areas below and find
what you need.
Find any order and act on it. Activate what you ship, edit or add articles, register returns, extend the activation time, or cancel.
Send a pre-filled checkout to a customer as a text message or a link. When the customer pays, the purchase becomes an order like any other.
Download settlements as CSV or PDF, follow your sales per currency, and generate custom reports for any period and set of stores.
Invite users, decide with groups who sees which stores, and create the API keys and webhooks your integration needs.
Tell Walley the goods are on their way and get paid.
Register what the customer sent back, in full or per article.
Send the invoice again by email or post.
Settlements, transactions, or orders for a period you choose.
Get the credentials your integration uses to call Walley's APIs.
Let Walley call your system when an order changes.
See every request and response in the Developer Logs.
## Reset your password
1. Select **Forgot your password?**.
2. Enter your email address.
3. Enter the verification code that Walley sends to that address and choose a new password.
## Next steps
- Take the [quick guide](/docs/merchanthub/quickguide) through the main views.
- Invite your colleagues in [Managing users and groups](/docs/merchanthub/access/usersgroups).
---
# Activating an order
Source: https://dev.walleypay.com/docs/merchanthub/orders/activation.md
Activate an order when the goods are ready to ship. Activation tells Walley that the customer will receive the goods, moves the order out of NotActivated, and includes the amount in your next payout.
## Before you start
The order must have status `NotActivated` or `PartActivated`. See [order statuses](/docs/merchanthub/faq#what-are-the-different-order-statuses).
## Activate an order
1. Find the order in the [order search](/docs/merchanthub/search) and open it.
2. Select **Activate**.
3. In the dialog, tick the articles to activate. If an article has a quantity above one, you can activate part of the quantity.
4. Select **Activate**.
The order status changes to `Activated`, or to `PartActivated` if you left some articles out.
## Part activation
If you activate only some of the articles, the order becomes `PartActivated` and you can activate the rest later. This is useful when some items are on back order and ship at a later date.
For invoice orders, Walley sends the customer a [notification](/docs/merchanthub/faq#what-is-a-notification) every time you activate.
## Next steps
- [Edit or add articles](/docs/merchanthub/orders/adjustments) before or after activation.
- [Return articles](/docs/merchanthub/orders/returns) the customer sends back.
---
# Editing and adding articles
Source: https://dev.walleypay.com/docs/merchanthub/orders/adjustments.md
After an order is created you can change its articles, add new ones, and add fees or discounts. A fee or discount is an amount on its own row, not tied to a specific article.
## Before you start
What you can do depends on the order status:
| Order status | Possible actions |
| -------------- | ------------------------------------------------- |
| `NotActivated` | Add article, fee, or discount. Edit articles |
| `Activated` | Add article, fee, or discount |
To open the editor, open the order and select **Edit**. Every procedure below starts from the editor.
## Add an article
The article's **Description** is shown on the customer's invoice.
1. Select **Add article**.
2. Fill in the article details.
3. Select **Add**.
4. When you have added all articles, select **Update Order**.
## Add a discount or fee
Enter the discount as a positive amount. It is shown as negative on the order.
1. Select **Add fee** or **Add discount**.
2. Fill in the details. The article number is set to `Fee` or `Discount` automatically.
3. Select **Add**.
4. When you are done, select **Update Order**.
## Edit an article
1. Select the pen icon on the article's row.
2. Change the details.
3. Select **Apply**.
4. When you are done, select **Update Order**.
:::info Activated orders
On an `Activated` order, changes to activated rows are recorded as an adjustment, while changes to rows that are not activated replace the row.
:::
## Next steps
- [Activate the order](/docs/merchanthub/orders/activation) when the goods are ready to ship.
- [Return articles](/docs/merchanthub/orders/returns) the customer sends back.
---
# Cancelling an order
Source: https://dev.walleypay.com/docs/merchanthub/orders/cancelOrder.md
Cancel an order when the goods will not be shipped. Cancelling releases every row that is not yet activated.
## Before you start
The order must have status `NotActivated`, `PartActivated`, `Expired`, or `OnHold`.
:::warning Cancelling cannot be undone
Cancelled rows cannot be activated later.
:::
## Cancel an order
1. Find the order in the [order search](/docs/merchanthub/search) and open it.
2. Select **Cancel**.
3. Select **Yes** to confirm. The dialog reminds you that every article that is not activated will be cancelled.
Every row that is not activated is cancelled, whatever the order status was. A `PartActivated` order keeps its activated rows and becomes `Activated`. For the other statuses, every row is cancelled and the order can no longer be activated.
---
# Extending an order
Source: https://dev.walleypay.com/docs/merchanthub/orders/extendOrder.md
Extend an order to give yourself more time to activate it. An order can be extended up to 180 days from the purchase date.
## Before you start
- The order must have status `NotActivated` or `Expired`.
- How many days you can extend by depends on your agreement with Walley.
## Extend an order
1. Find the order in the [order search](/docs/merchanthub/search) and open it.
2. Select **Extend**.
3. Select **Yes** to confirm.
The order's expiry date moves forward.
---
# Returning articles
Source: https://dev.walleypay.com/docs/merchanthub/orders/returns.md
When a customer sends back one or more articles, register a return on those articles. The return adjusts the order and refunds any money the customer has already paid.
## Before you start
The order must have status `Activated` or `PartActivated`. Find it in the [order search](/docs/merchanthub/search) and open it.
## Return specific articles
1. Select **Edit**.
2. Select the return arrow on the right side of the article's row.
3. If the article has a quantity above one, set the quantity to return and select **Return**.
4. Select **Update Order**. To reverse a return before that, select **Undo** on the row.
The order is now partly returned.
## Return the whole order
1. Select **Edit**.
2. Select **Return all** at the top of the table.
3. Select **Update Order**.
The order status changes to `Returned`.
:::info Timeline
Partly returned rows are shown in the timeline only while the order is not fully returned.
:::
---
# Partner Portal
Source: https://dev.walleypay.com/docs/merchanthub/partnerportal.md
The Walley Partner Portal has been shut down. Its successor is the Merchant Hub. If you have questions, contact Walley Merchant Services at help@walley.se.
- [Open the Merchant Hub](https://merchanthub.walleypay.com/)
- [Read the Merchant Hub FAQ](/docs/merchanthub/faq)
## Bambora and Worldline users
Log in to the Worldline merchant portal to handle your purchases, or contact Worldline support.
- [Worldline merchant portal](https://merchant.bambora.com/auth/signin)
- [Worldline support](https://www.bambora.com/sv/se/customer-service/)
---
# Creating a Pay Link
Source: https://dev.walleypay.com/docs/merchanthub/paylink/create.md
Create a Pay Link in four steps: enter the articles, review the details, send the link, and wait for the customer to pay.
## Before you start
- You need the **Paylink Management** permission.
- Your stores must be set up for Pay Link. See the [Pay Link overview](/docs/merchanthub/paylink/overview#before-you-start).
- Select **Pay Link** in the top menu. The list shows every Pay Link your permissions give you access to.
## Enter the articles
1. Select **Create new** and then **Pay Link**.
2. Choose the currency.
3. Enter the articles. The customer sees them in the checkout.
4. Select **Next**.
## Review the Pay Link details
1. Choose the store the purchase should be registered on.
2. Optionally, enter an order number so you can find the order later.
3. Choose the delivery method, [remote](#remote-delivery) or [in-store](#in-store-delivery).
4. Select **Create**.
:::info Delivery method and auto activation
The delivery method you choose overrides the store's default activation behaviour for this checkout.
:::
## Send the Pay Link to the customer
When the Pay Link is created, a dialog offers two ways to share it. Send it as a text message, or copy the link and send it by email or another channel.
To send a text message:
1. Enter the customer's mobile phone number in the **Send Pay Link** dialog.
2. Select **Send**.
## The customer completes the purchase
The customer opens the link in a browser on any device and pays. An order is created, and a link to it appears on the Pay Link details page.
:::info Refresh to see the new state
The Pay Link page does not update on its own. Select **Refresh Pay Link** to see the new state and the link to the order.
:::
## Delivery methods
### Remote delivery
Use this for distance sales, for example over the phone or by email. [Activate the order](/docs/merchanthub/orders/activation) when you ship the goods.
### In-store delivery
Use this when the customer takes the goods right away, for example in your physical store. The order is activated when the customer completes the purchase.
## Create a Pay Link from a bookmark
You can prefill fields by adding query parameters to the Pay Link URL. Save the URL as a browser bookmark for configurations you use often, or share it with colleagues.
```
https://merchanthub.walleypay.com/new-paylink?articleNumber=123&description=Item1&country=SE&deliveryMethod=Remote&lock=deliveryMethod
```
This example prefills the article number, description, country code, and delivery method, and locks the delivery method so it cannot be changed by mistake.
### Lock a field
Add `lock=FIELD_NAME` to stop a field from being changed. Repeat it to lock several fields:
```
&lock=deliveryMethod&lock=country
```
### Fields you can prefill and lock
| Field | Description |
| ---------------- | ------------------------------------------------------------------------------------- |
| `articleNumber` | The article or SKU number. |
| `description` | The article name shown to the customer in the checkout. |
| `unitPrice` | The price per unit in the selected currency, for example `99.00`. |
| `vatRate` | The VAT rate as a percentage, for example `25`. |
| `quantity` | The number of units. Defaults to 1. |
| `country` | The two-letter country code, for example `SE`, `NO`, or `FI`. |
| `deliveryMethod` | `Remote` for distance sales or `In-store` for goods handed over on the spot. |
## Next steps
- Follow the purchase in [Pay Link states](/docs/merchanthub/paylink/statuses).
---
# Pay Link overview
Source: https://dev.walleypay.com/docs/merchanthub/paylink/overview.md
A Pay Link is a pre-filled checkout you send to a customer. The customer opens the link, pays, and the purchase becomes an order in the Merchant Hub like any other.
## When to use a Pay Link
- Charge for extra services after the original purchase.
- Sell articles that are not in your web shop, such as spare parts.
- Take in-store purchases with strong customer authentication.
## Before you start
- You need the **Paylink Management** permission.
- Your stores must be set up for Pay Link. That is normally already the case if you use Walley Checkout. If not, contact delivery@walley.se.
## How it works
1. [Enter the articles](/docs/merchanthub/paylink/create#enter-the-articles).
2. [Review the Pay Link details](/docs/merchanthub/paylink/create#review-the-pay-link-details).
3. [Send the Pay Link to the customer](/docs/merchanthub/paylink/create#send-the-pay-link-to-the-customer).
4. [The customer completes the purchase](/docs/merchanthub/paylink/create#the-customer-completes-the-purchase).
5. An order is created.
See [Pay Link states](/docs/merchanthub/paylink/statuses) for what each state means for shipping the goods.
---
# Pay Link states
Source: https://dev.walleypay.com/docs/merchanthub/paylink/statuses.md
A Pay Link moves through these states. Only Completed means the customer has paid and you can hand over or ship the goods.
| State | Shown as | What it means | Can the goods be handed over? |
| -------------------- | ------------------- | ------------------------------------------------------------------------------------------ | ----------------------------- |
| `Pending` | Pending | The Pay Link is created but the customer has not opened it yet. No order exists. | No |
| `CustomerIdentified` | Customer identified | The customer has opened the Pay Link and identified themselves, but has not paid. | No |
| `CommittedToPayment` | Payment in progress | The customer has started to pay. Wait for the Pay Link to complete. | No |
| `Completed` | Completed | The customer has paid and an order is created. | Yes |
| `Expired` | Expired | The customer did not pay within the allowed time. The Pay Link can no longer be completed. | No |
| `Aborted` | Aborted | The customer or a Merchant Hub user aborted the Pay Link. | No |
The Pay Link list shows the open states by default. Use the status filter to include expired and aborted links.
---
# Quick guide to the Merchant Hub
Source: https://dev.walleypay.com/docs/merchanthub/quickguide.md
A tour of the four views you will use most. The numbers in each screenshot match the list below it.
## Order search
1. Search field with filters for date, status, store, and more. See [Searching for orders](/docs/merchanthub/search).
2. Bulk actions. Tick the checkboxes to choose which orders the action applies to.
3. Orders matching your search.
4. Column picker. Opens a side panel where you choose which columns the table shows.
5. User menu with links to **Manage Organization**, the FAQ, and log out.
## Order details
1. Order header with the status and details of the order as a whole.
2. Actions you can perform on the order. Which ones you see depends on the order status.
3. Order articles.
4. Timeline of everything that has happened to the order.
5. Order totals and how much of the order is not yet activated.
6. Customer information.
7. Buttons to change the email address on the order and to copy it to your clipboard.
8. Links to the order's invoices, if the order has any.
## Manage Organization
1. Your organization and how many users and groups it has.
2. Users or groups, depending on the selected tab. Select a row to open that user or group and change its permissions.
3. Button to invite a user to your organization.
4. Button to create a new group.
## Reports
1. Search field that works like the one in order search. Use it to choose the periods you want to see.
2. Summary cards with total sales per currency. Filter them by currency.
3. Reports matching your search.
4. Download icons for CSV and PDF.
---
# Custom reports
Source: https://dev.walleypay.com/docs/merchanthub/reports/custom-reports.md
Generate a report for a period and a set of stores of your choice, then download it as CSV.
## Before you start
- You need the **Report Management** permission with read access to settlements for the stores you include.
- Custom reports cover transactions settled by Walley only.
## Report types
| Report type | What it contains |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Settlement Summary** | Aggregated data from every settlement in the period. Can include the settlement reference. |
| **Transactions** | Every transaction in the period, including those not yet settled. Can include the settlement reference and action reference. |
| **Transaction Details** | Detailed information about purchases and returns in the period. This report contains a lot of data and takes longer to generate. |
| **Merged** | Every settlement transaction merged into one file. Can include the settlement reference and action reference. |
| **Company Customer Credit Limits**| An overview of each company customer's credit [reservation](/docs/paymentsApi/integration/reservations) and how much of it is still available. |
| **Orders** | Every order placed in the period. |
## Generate a report
1. Select **Generate report**. The **Create custom report** dialog opens.
2. Fill in the dialog:
- A name for the report
- The report type
- The period, up to one year
- Optionally, the stores to include. Leave it empty to include all stores.
3. Select **Generate report**.
4. When the status is `Done`, select **Csv** to download the report.
Generating takes a few minutes. Select **Refresh reports** to update the status. A report can be `Generating`, `Done`, or `Failed`, and stays available for 90 days. Use **Show reports from the last** to choose how far back the list goes.
---
# Reports overview
Source: https://dev.walleypay.com/docs/merchanthub/reports/overview.md
The reports page shows your settlements and a summary of your sales over any period you choose. Select Reports in the top menu to open it.
## Settlements
Each settlement in the table has a CSV and a PDF download icon in the **Download** column. Select the format you want.
The search field at the top filters the settlements. It works like the [order search](/docs/merchanthub/search).
## Summaries
The cards below the search field show total net sales, total compensation, and total adjustments, together with the total payout in each currency. Use the **Currency** filter to show one currency at a time.
## Next steps
- Generate a [custom report](/docs/merchanthub/reports/custom-reports) for a specific period and set of stores.
---
# Searching for orders
Source: https://dev.walleypay.com/docs/merchanthub/search.md
Select Orders in the top menu to search every order your groups give you access to. Type anything you know about the order, or narrow the result with filters and field queries.
## Free text search
The search field matches almost anything stored on an order, for example:
- An order number or reference
- An email address
- A customer's name or national registration number
- An address
The result is ranked, so the orders the search considers most relevant come first.
## Exact search
If a search returns more than you want, make it exact. Either tick the **Exact match** checkbox, or put quotes around the text: `"01234567"` matches that string and nothing else.
## Wildcards
Add `*` to match part of a word. `*gmail.com` finds every order with a value that ends in gmail.com.
## Search with AI
Select **Search with AI** and describe what you are looking for in plain language, in English or your own language. The search turns your description into filters and a query. AI results may be inaccurate, so check the filters it applied before you act on the result.
## Quick filters
Use the dropdown filters next to the search field to filter by created date, expiry date, notification due date, store, or order status.
## Field queries
When the filters are not enough, query a specific field in the search box. The syntax is `field:value`, and you can combine queries with `AND` and `OR`.
| Query | Finds |
| ------------------------------------ | ------------------------------------- |
| `storeId:1158` | All orders for store 1158 |
| `storeId:1158 AND status:Activated` | Activated orders for store 1158 |
| `storeId:1158 OR storeId:9664` | Orders for either store |
| `totalAmount:>2000 AND currency:SEK` | Orders in SEK with a total above 2000 |
### Searchable fields
| Field | Description |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| storeId | The id of your store. |
| orderNumber | The order number, or reference, of the order. |
| currentPurchase.purchaseId | The purchase id of the order. |
| connectedPurchases.purchaseId | The purchase id of a purchase connected to the order. |
| paymentMethod | The payment method. `Invoice` `Account` `Installment` `Swish` `Card` `MobilePay` `BankTransfer` |
| totalAmount | The total amount of the purchase. |
| notActivatedAmount | The amount that is not yet activated. |
| currency | The currency code. `SEK` `NOK` `DKK` `EUR` |
| status | The order status. `NotActivated` `Activated` `PartActivated` `Returned` `Expired` `OnHold` `VerificationNeeded` `Closed`. See [order statuses](/docs/merchanthub/faq#what-are-the-different-order-statuses). |
| placedAt | The date the order was placed. |
| expiresAt | The date the order expires if it is not activated. |
| customerDetails.name | The full name of the customer. |
| customerDetails.firstName | The first name of the customer. |
| customerDetails.lastName | The last name of the customer. |
| customerDetails.registrationNumber | The registration number of the customer. |
| customerDetails.countryCode | The country code of the customer's address. |
| customerDetails.addressLine1 | The first address line of the customer's address. |
| customerDetails.addressLine2 | The second address line of the customer's address. |
| customerDetails.city | The city of the customer's address. |
| customerDetails.postalCode | The postal code of the customer's address. |
| customerDetails.email | The email address of the customer. |
| customerDetails.mobilePhoneNumber | The mobile phone number of the customer. |
| deliveryAddress.addressLine1 | The first address line of the delivery address. |
| deliveryAddress.addressLine2 | The second address line of the delivery address. |
| deliveryAddress.coAddress | The c/o line of the delivery address. |
| deliveryAddress.receiverName | The receiver name of the delivery address. |
| deliveryAddress.city | The city of the delivery address. |
| deliveryAddress.postalCode | The postal code of the delivery address. |
| deliveryAddress.countryCode | The country code of the delivery address. |
| rows.articleNumber | The article number of a row on the order. |
| rows.description | The description of a row on the order. |
| rows.purchaseId | The purchase id that a row on the order belongs to. |
## Next steps
- Open an order to [activate it](/docs/merchanthub/orders/activation), [edit its articles](/docs/merchanthub/orders/adjustments), or [make a return](/docs/merchanthub/orders/returns).
- The same search works for settlements on the [reports page](/docs/merchanthub/reports/overview).
---
# Setup Merchant
Source: https://dev.walleypay.com/docs/onboarding/create.md
This describes the request used to create or update a Merchant and add stores to that merchant
### Example
```json
POST /manage/onboarding HTTP/1.1
Host: api.uat.walleydev.com // (Please note! Different hostname in production)
Authorization: Bearer bXlVc2VybmFtZTpmN2E1ODA4MGQzZTk0M2VmNWYyMTZlMDE...
{
"Merchant": {
"Name": "Selling Company Group",
"OrganizationNumber": "9912139814",
"VatRegistrationCode": "SE991213981401",
"CountryCode": "SE",
"ContactInformation": {
"Name": "John Doe",
"Address": {
"AddressLine1": "Street address 11",
"City": "Gothenburg",
"PostalCode": "41103",
"CountryCode": "SE"
},
"Phone": "+46730000111",
"Email": "contact@sellingcompanygroup.com",
"WebsiteUrl": "https://sellingcompanygroup.com"
},
"InvoiceInformation": {
"Address": {
"AddressLine1": "Street address",
"City": "Gothenburg",
"PostalCode": "41103",
"CountryCode": "SE"
},
"Email": "invoice@sellingcompanygroup.com"
}
},
"Stores": [
{
"Template": "Checkout",
"SalesSegment": "B2C",
"CountryCode": "SE",
"OrganizationNumber": "9912139814",
"VatRegistrationCode": "SE9912139815",
"LegalName": "Selling Company AB",
"PresentationName": "sellingthings.se",
"SalesCategory": "Retail",
"LogoUrl": "https://cdn.walleypay.com/logo/walley-black.svg",
"ContactInformation": {
"Address": {
"AddressLine1": "StreetAddress 12",
"PostalCode": "41103",
"City": "Gothenburg",
"CountryCode": "SE"
},
"WebsiteUrl": "https://sellingthings.se",
"CustomerServicePhoneNumber": "+46123456789",
"CustomerServiceEmail": "hello@sellingthings.se"
}
},
{
"Template": "Checkout",
"SalesSegment": "B2B",
"CountryCode": "NO",
"OrganizationNumber": "9912139815",
"VatRegistrationCode": "SE9912139815",
"LegalName": "Selling Company AB",
"PresentationName": "sellingthings-to-retailers.no",
"SalesCategory": "Retail",
"LogoUrl": "https://cdn.walleypay.com/logo/walley-white.svg",
"ContactInformation": {
"Address": {
"AddressLine1": "StreetAddress 12",
"PostalCode": "1110",
"City": "Oslo",
"CountryCode": "NO"
},
"WebsiteUrl": "https://sellingthings-to-retailers.no",
"CustomerServicePhoneNumber": "+479123456789",
"CustomerServiceEmail": "hello@sellingthings-to-retailers.no"
}
}
]
}
```
```json
{
"results": [
{
"id": 999998,
"salesSegment": "B2C",
"countryCode": "SE",
"status": 200
},
{
"salesSegment": "B2B",
"countryCode": "NO",
"status": 500
}
],
"data": {
"merchantId": "00000000-0000-0000-0000-000000000001",
"authentication": {
"clientId": "00000000-0000-0000-0000-000000000002",
"secretKey": "KKEuuKzybLH6WBUpHszV",
"secretExpire": "2024-02-25T09:03:13.8472589+00:00"
}
},
"links": {
"stores": {
"method": "GET",
"href": "/organizations/00000000-0000-0000-0000-000000000001/stores"
}
}
}
```
:::info Idempotency
Basically, given the same merchant OrganizationNumber and CountryCode code, stores provided in the request will be setup in addition to already existing stores.
The information on existing stores and on the merchant will NOT be updated when you call this endpoint a second time.
:::
## Data Model
### Request
##### Request headers
| Header | Required | Explanation |
| ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------- |
| **Authorization** | Yes | Instructions on how to generate the Bearer token value can be found [here](/docs/manage/getting-started/authentication) |
##### Request body
| Property | Required | Explanation |
| ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Merchant** | Yes | The [Merchant](/docs/onboarding/models/merchant-req) is the selling company. |
| **Stores** | Yes | Array of [Store](/docs/onboarding/models/merchant-req). Stores represent the selling point, e.g. B2C in SE, B2B in SE have two separate stores. One merchant can have several stores. |
| **ApiSecretExpiration** | No | Used to control how long the expiration time on the secret should be, allowed values SixMonths, OneYear, TwoYears, Unlimited. Default value is TwoYears. |
### Response
The response is wrapped in a [Response object containing data, links, results and metadata](/docs/onboarding/models/data-response)
| Property | Explanation |
| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **data.merchantId** | The MerchantId of the created or updated merchant in Walleys system |
| **data.authentication.clientId** | The ClientId part of the authentication to be used by partner to act on behalf of the create or updated merchant. Used to obtain a token from the Authentication Service.
### Setup merchant
The partner initiates the setup of a merchant by performing a request against the Onboarding API with the details needed.
Walley will automatically setup all the things needed to be able to start receiving payments from end customers.
One Merchant can have several sub-stores that is used to distinguish selling market and type of store like B2B and B2C.
---
# Auditing Headers
Source: https://dev.walleypay.com/docs/paymentsApi/getting-started/auditing-headers.md
To provide more detailed auditing in our products it is possible to use optional HTTP headers to provide information about the origination of the request made towards the API.
Since the auditing information could be displayed to users of the Walley products, we recommend only posting human readable, nonsensitive information in these headers. ### Performed By To provide information identifying the user or person that performed the action resulting in the request towards the API, use the Walley-Performed-By HTTP header. The value posted could be any information identifying the user, e.g. a name, a username or an email. ```xml Walley-Performed-By: firstname.lastname@walley.se ``` ### Originated From To provide information about the origin of the request towards the API, use the Walley-Originated-From HTTP header. The value posted could be any information identifying the origin of the request, e.g. the name of the system integrating with the API, an end user system, a company or store name. ```xml Walley-Originated-From: Walley Checkout ``` :::info Please note Please note that using the Walley-Originated-From header without the Walley-Performed-By header can result in the SOAP username being displayed in some products. To avoid this, post an empty value in the Walley-Performed-By header instead. ::: --- # Web Service Authorization Source: https://dev.walleypay.com/docs/paymentsApi/getting-started/authorization.mdIn order for the SOAP envelope to work according to the specification, it needs to be authorized using a username and a password. In addition to these two parameters, the AddInvoice request and the SetReservation request also needs the ClientIpAddress parameter to work properly. The ClientIpAddress should be the IP address of the customer performing the purchase at the partner's web shop.
You will receive a username and a password from your Partner Integration Manager at Walley after the agreement has been signed. You will receive different credentials for the test and production environment.
### Date and time formats All date and time data sent to Walley must follow the ISO 8601 standard. E.g. 2010-06-16 15:27:00. ### Text encoding The eCommerce services use UTF-8 as default encoding for all messages. ### Request parsing The API:s parse the request parameter values by node position and element name. Use the format specified by the WSDL to make sure all values are parsed correctly. ### Country code Country code follow the ISO 3166-1 alpha-2 standard, e.g. SE ### Currency code Currency code follow the ISO 4217 standard, e.g. SEK, NOK, EUR --- # Idempotent Requests Source: https://dev.walleypay.com/docs/paymentsApi/getting-started/idempotent-requests.mdThe API supports idempotency for safely retrying requests that only should be performed once. This could be useful if responses are not received due to network connectivity problems. For example, if a response for a request to add an invoice is not received, you can retry the request with the same idempotency key again and be guaranteed that no more than one invoice is added.
We recommend that idempotency key is used in all write operations that might be retried. When retrying a read operation there is no harm in reading the latest data, and therefore we do not recommend using idempotency keys in read operations. ### Idempotency key To perform an idempotent request, add a HTTP header called "Walley-Idempotency-Key" with an unique identifier for the request. Subsequent requests with the same idempotency key will return the same result, including errors. As an example, add the following HTTP header to the request: ```xml Walley-Idempotency-Key: AD9ACA8B-AD55-45F9-870D-4DA896EAEE35 ``` An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. We recommend that the key is a GUID. Keys are cached for 24 hours and new requests after that with the same key will be handled as new requests. ### Idempotency-specific errors When a subsequent request is received before the original request has been processed, the second request will result in an error with error code "IDEMPOTENCY_REQUEST_IN_PROGRESS", it is safe to retry with the same key at a later time. Responses are cached for 1 hour, after that a request with the same idempotency key will return an error "IDEMPOTENCY_RESPONSE_EXPIRED". If this happens make sure that the subsequent requests are sent within an hour. Results are only cached if the API has started processing the request. Errors while sending the request or authentication errors will not be cached, but validation errors will. If the same idempotency key is used for different type of requests then an error with error code "IDEMPOTENCY_MISS_MATCHING_REQUEST_TYPE" will be returned. If this happens, check the generation of keys to make sure that a unique key is generated and that the key is not reused for different requests. --- # General Information Source: https://dev.walleypay.com/docs/paymentsApi/getting-started/index.md The web services are implemented using Microsoft WCF and uses basic http binding for full interoperability. All communication with Walley services is encrypted using https. The Payment service is published through a web services description language (WSDL) file. The order of the parameters are of importance. Please note the order presented in each request. The parameter CountryCode must always be supplied, StoreId is optional as long as only one shop per country is used. Partners with multiple shops in the same country are required to submit the StoreId in each request. In all requests you can also send in a CorrelationId, which could be used to verify that the response is from the "correct" request. --- # Production and Test urls Source: https://dev.walleypay.com/docs/paymentsApi/getting-started/urls.md ### Production environment API URL's #### PaymentService The main API used for invoice handling (purchases, activations, returns etc.)\* https://ecommerce.collector.se/v3.0/PaymentServicev10.svc?wsdl #### InformationService API used for account & transaction information on existing invoices and customers https://eCommerce.collector.se/v3.0/informationservicev2.svc?wsdl \*For older versions of the API, please contact help@walley.se for assistance. ### Test environment API URL's #### PaymentService The main API used for invoice handling (purchases, activations, returns etc.)\* https://ecommercetest.collector.se/v3.0/PaymentServiceV10.svc?wsdl #### InformationService API used for account & transaction information on existing invoices and customers https://eCommerceTest.collector.se/v3.0/informationservicev2.svc?wsdl \*For older versions of the API, please contact help@walley.se for assistance. ### Merchant Hub URL's Production environment: https://merchanthub.walleypay.com
Here you'll find descriptions of the following requests:
SetReservation
To create a new reservation, or update an existing one.
ActivateReservation
Used for activation of a reservation in status pending or signing.
GetReservation
Fetches information on a previously made reservation.
CancelReservation
Cancels a previously approved reservation.
:::info Please Note That the StoreId parameter is mandatory to include in the request if you are selling to more than one country or having both consumers and companies as customers. This is used to distinguish between them. :::
--- # Set Reservation Source: https://dev.walleypay.com/docs/paymentsApi/integration/reservations/setreservation.md Creates a new, or modifies an existing, reservation for a customer. A reservation is a fixed credit limit that a customer can make purchases within (AddInvoice) without additional credit checks.A new reservation is created if no existing reservation is found and the customer passes the automatic credit check. An already existing reservation can be increased by requesting a higher amount, or decreased by requesting a lower. In the case of an increase a new credit check is performed and if successful the reserved amount is modified to match the new value. Decreasing the reservation amount will lower the reserved amount without triggering a new credit check.
Note that Walley's policy rules affects the lowest and highest amounts for which reservations can be created and modified. Contact Walley for details regarding these limits.
This functionality is only available in the following countries: Sweden, Norway, Finland and Denmark. The usage of this functionality must be agreed upon with Walley. Any purchases/invoices made before a reservation will be calculated into the AvailableAmount of the reservation.
This method is available in the following countries:Act on an order once it exists. Capture what you ship, refund what comes back, change it before it leaves the warehouse, and read its current state whenever you need to.
Get the payout report that explains what Walley paid you and why. Fetch it with the Reports API or download it from Merchant Hub.
Let Walley call your system when something changes: an order is updated, an authorization comes through, a settlement is ready.
Adjust items or amount before anything is captured.
Capture on shipment, in full or in parts.
Give money back, in full or per item.
Find a settlement and read the transactions on it.
Find your settlements, read the transactions on each one and download the PDF. Best fit when you want the data in your ERP or accounting system.
Download the PDF and CSV files by hand. Filter by period, payout date, currency, reference and store. No integration needed.
Subscribe to walley:settlement:created and let Walley tell you
the moment a new settlement is ready to fetch.
### Resource location
Please link directly to the Walley CDN to ensure the image stays updated. The logo is delivered in SVG format and is fully scalable.
| Badge Type | Url |
| -------------------- | ----------------------------------------------- |
| Standard | https://cdn.walleypay.com/logo/walley-black.svg |
| For dark backgrounds | https://cdn.walleypay.com/logo/walley-white.svg |
## Walley logo badge for Walley Checkout
For the Walley Checkout badge — with an interactive preview, all locale and variant options, and copy-pasteable HTML — see [Branding resources](/docs/checkout/branding-resources).
## Alternative Walley logos
### Walley Lasku/Tililuotto
When you promote the Lasku/Tililuotto payment method in Finland you may use this version of the Walley logo.
#### Resource location
Please link directly to the CDN to ensure the image stays updated. The logo is delivered in SVG format and is fully scalable.
| Badge Type | Url |
| -------------------- | ---------------------------------------------------------------- |
| Standard | https://cdn.walleypay.com/logo/walley-lasku-tililuotto-black.svg |
| For dark backgrounds | https://cdn.walleypay.com/logo/walley-lasku-tililuotto-white.svg |
---
# Walley banners
Source: https://dev.walleypay.com/docs/wallify/banners.md
We are happy to provide you these banners, for use on your website, newsletters, social media or other promotional purpose. The banners come in both static and motional versions, to fit any application.
Feel free to use these banners whenever you need to promote Walley as your preferred payment solution!
### Name change banners
Follow a stored payment token through its lifecycle: active, pending, suspended, cancelled, denied or revoked.
Track tokenized payment authorizations from created to authorized, and get the reason when an attempt is retried or fails.
Know when an order is created, authorized, captured, refunded, canceled or expired, no matter which Walley product created it.
Get notified the moment a new settlement is ready, so you can fetch the report through the Reports API right away.