Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs 4536 #3246

Merged
merged 3 commits into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/general/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hidden: false

All requests to our API require authentication.

Include your [site API key](/docs/sites#site-id-api-key-and-security-code) as an HTTP header in your request: `api_key`
Include your [website API key](/docs/sites#site-id-api-key-and-security-code) as an HTTP header in your request: `api_key`
[block:callout]
{
"type": "danger",
Expand Down
20 changes: 10 additions & 10 deletions api/general/error-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ Check that your account ID is properly formatted.
Your account ID appears in the top-right corner of your dashboard.

---
### 1004: Invalid site ID
### 1004: Invalid website ID

Deprecated: The [`site_id`](/docs/sites#site-id-api-key-and-security-code) was invalid, or doesn’t match the account ID.
Deprecated: The [`website_id`](/docs/sites#site-id-api-key-and-security-code) was invalid, or doesn’t match the account ID.

---
### 1005: Invalid security code
Expand All @@ -51,8 +51,8 @@ Deprecated: The [security code](/docs/sites#site-id-api-key-and-security-code) w

The `order_id` was invalid.

The order ID must be unique. The order ID you provided may have already been used for a completed transaction for that site ID.
Consider creating a new site profile in your dashboard.
The order ID must be unique. The order ID you provided may have already been used for a completed transaction for that website ID.
Consider creating a new website profile in your dashboard.

---
### 1007: Invalid IP address
Expand Down Expand Up @@ -93,7 +93,7 @@ The MD5 signature supplied with the message doesn’t match the message contents

- Check that the values used to calculate the MD5 signature are correct.
- Remove unnecessary blank spaces from the MD5 signature.
- Calculate the MD5 hash from the concatenation of the amount, currency, account ID, site ID, and transaction ID.
- Calculate the MD5 hash from the concatenation of the amount, currency, account ID, website ID, and transaction ID.

---
### 1014: Unspecified error
Expand All @@ -114,7 +114,7 @@ The request is missing required information.

This error most commonly occurs when the customer is directed to a payment page, or when you generate a [payment link](/docs/payment-links/).

Check that you included the [`site_id`, security code](/docs/sites#site-id-api-key-and-security-code), and transaction ID.
Check that you included the [`website_id`, security code](/docs/sites#site-id-api-key-and-security-code), and transaction ID.

---
### 1017: Insufficient funds
Expand All @@ -133,9 +133,9 @@ Check that the country code is in correct ISO3166-1 format.
---
### 1019: Site is inactive

The site is blocked in your account.
The website is blocked in your account.

[Unblock the site](/docs/sites#blockunblock-a-site) in your MultiSafepay dashboard:
[Unblock the website](/docs/sites#blockunblock-a-site) in your MultiSafepay dashboard:

---
### 1020: Account is blocked
Expand Down Expand Up @@ -165,7 +165,7 @@ The `gateway` is unavailable. This error can occur with <<glossary:direct>> requ

- Check whether the payment method supports <<glossary:direct>> requests.
- Ensure you specified a gateway in the create order request.
- Check if the site is correctly configured for <<glossary:direct>> requests.
- Check if the website is correctly configured for <<glossary:direct>> requests.
- For payment components, check if the correct API token is used. Do not use an API key.

---
Expand Down Expand Up @@ -263,7 +263,7 @@ The API key is not valid.

Check that:

- You used the correct [site API key](/docs/sites#site-id-api-key-and-security-code).
- You used the correct [website API key](/docs/sites#site-id-api-key-and-security-code).
- The API key was formatted correctly.
- You used a live key in the live environment, and a test key in the test environment.

Expand Down
2 changes: 1 addition & 1 deletion api/multisafepay-api/cancelauthorizedorder.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: cancelauthorizedorder

## How to test

1. Under **Authentication** > **Query**, enter an [API key](/docs/sites#site-id-api-key-and-security-code) from your **TEST** account.
1. Under **Authentication** > **Query**, enter a website [API key](/docs/sites#site-id-api-key-and-security-code) from your **TEST** account.
2. Under **Path params**, enter the order ID.
3. Under **Body params**, fill in the required parameters.
4. Click **Try it!**
Expand Down
2 changes: 1 addition & 1 deletion api/multisafepay-api/capturepayment.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: capturepayment

## How to test

1. Under **Authentication** > **Query**, enter an [API key](/docs/sites#site-id-api-key-and-security-code) from your **TEST** account.
1. Under **Authentication** > **Query**, enter a website [API key](/docs/sites#site-id-api-key-and-security-code) from your **TEST** account.
2. Under **Path params**, enter the order ID.
3. Under **Body params**, fill in the required parameters.
4. Click **Try it!**
Expand Down
2 changes: 1 addition & 1 deletion api/multisafepay-api/challengechargeback.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: challengechargeback

## How to test

1. Under **Authentication** > **Query**, enter an [API key](/docs/sites#site-id-api-key-and-security-code) from your **TEST** account.
1. Under **Authentication** > **Query**, enter a website [API key](/docs/sites#site-id-api-key-and-security-code) from your **TEST** account.
2. Under **Path params**, enter the order ID of the order you want to challenge a chargeback for.
3. Under **Body params**, fill in the required parameters.
4. Click **Try it!**
Expand Down
2 changes: 1 addition & 1 deletion api/multisafepay-api/createorder.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: createorder

## How to test

1. Under **Authentication** > **Query**, enter an [API key](/docs/sites#site-id-api-key-and-security-code) from your **TEST** account.
1. Under **Authentication** > **Query**, enter a website [API key](/docs/sites#site-id-api-key-and-security-code) from your **TEST** account.
2. Under **Body params**, select the type of order you want to create.
3. Either:
- Enter dummy data for relevant parameters, **or**
Expand Down
2 changes: 1 addition & 1 deletion api/multisafepay-api/deletetoken.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: deletetoken

## How to test

1. Under **Authentication** > **Query**, enter an [API key](/docs/sites#site-id-api-key-and-security-code) from your **TEST** account.
1. Under **Authentication** > **Query**, enter a [API key](/docs/sites#site-id-api-key-and-security-code) from your **TEST** account.
2. Under **Path params**, enter your customer reference and token ID.
3. Click **Try it!**

Expand Down
4 changes: 2 additions & 2 deletions api/multisafepay-api/getsite.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ slug: getsite

## How to test

1. Under **Authentication** > **Query**, enter an [API key](/docs/sites#site-id-api-key-and-security-code) from your **TEST** account.
2. Under **Path params**, enter the site ID.
1. Under **Authentication** > **Query**, enter a website [API key](/docs/sites#site-id-api-key-and-security-code) from your **TEST** account.
2. Under **Path params**, enter the website ID.
3. Click **Try it!**

❗️ Never use a live API key!
Expand Down
8 changes: 4 additions & 4 deletions content/accounting/accounting-integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To connect your Actuals account to your MultiSafepay account:
2. Go to **Configuration**.
3. Under **Payment service provider** > **MultiSafepay**, click **Add**.
4. In the **Configuration name** field, rename the configuration, if relevant.
5. In the **MultiSafepay API Key** field, enter your MultiSafepay [site API key](/docs/sites#site-id-api-key-and-security-code), and then click **Save**.
5. In the **MultiSafepay API Key** field, enter your MultiSafepay [website API key](/docs/sites#site-id-api-key-and-security-code), and then click **Save**.
6. To check the connection, go to **Configuration**.
7. Under **In-use sources**, check that the **Status** of your MultiSafepay configuration is **Live**.

Expand Down Expand Up @@ -82,7 +82,7 @@ PSP Betalingen has developed an integration that connects your MultiSafepay acco

For more information, see PSP Betalingen – <a href="https://www.webwinkelfacturen.nl/koppelingpsp.php?shopsystem=multisafepay&invoicesystem=eboekhouden" target="_blank">Koppeling MultiSafepay e-Boekhouden</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i>.

To connect your MultiSafepay account to e-Boekhouden, see PSP betalingen – <a href="https://handleidingen.pspbetalingen.nl/handleiding-multisafepay-eboekhouden" target="_blank">Handleiding: MultiSafepay e-Boekhouden</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i>. (You will need a MultiSafepay [site API key](/docs/sites#site-id-api-key-and-security-code).)
To connect your MultiSafepay account to e-Boekhouden, see PSP betalingen – <a href="https://handleidingen.pspbetalingen.nl/handleiding-multisafepay-eboekhouden" target="_blank">Handleiding: MultiSafepay e-Boekhouden</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i>. (You will need a MultiSafepay [website API key](/docs/sites#site-id-api-key-and-security-code).)

<br>

Expand Down Expand Up @@ -536,7 +536,7 @@ For more information, see Yuki - <a href="https://support.yuki.nl/nl/support/sol

To connect Duopact with your MultiSafepay account, see Duopact – <a href="https://www.duopact.nl/nl/contact/" target="_blank">Contact</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i>.

Provide Duopact with your MultiSafepay [site API key](/docs/sites#site-id-api-key-and-security-code). They will set up a Yuki account for you.
Provide Duopact with your MultiSafepay [website API key](/docs/sites#site-id-api-key-and-security-code). They will set up a Yuki account for you.

---

Expand All @@ -547,7 +547,7 @@ Provide Duopact with your MultiSafepay [site API key](/docs/sites#site-id-api-ke
<br>

1. Sign in to your <a href="https://portal.yukiconnector.nl/" target="_blank">Duopact account</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i>.
2. If you operate multiple sites, select the relevant site from the top-left menu.
2. If you operate multiple websites, select the relevant website from the top-left menu.
3. Go to **Bankmutaties** > **MultiSafepay**.
4. Click the green button under the **Status** tab.

Expand Down
24 changes: 12 additions & 12 deletions content/accounting/reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The accountant export lists all successful incoming and outgoing transactions, i
| Paymenttype | A MultiSafepay fee, or the payment method |
| Description 2-4 | Descriptions of the order |
| Tr status | The <<glossary:transaction status>> |
| Ms description | The site name, or name of the terminal group |
| Ms description | The website name, or name of the terminal group |
| Mt merchanttransactionid | Your unique identifier for the order |
| Mt cust firstname | The customer’s first name |
| Mt cust lastname | The customer’s last name |
Expand Down Expand Up @@ -110,7 +110,7 @@ This report provides an overview (in Excel or CSV format) of:
| Merchant ref | Your transaction reference number |
| Created | The date the transaction was initiated |
| Completed | The date the funds were settled in your account balance |
| Site | The site where the customer placed the order |
| Site | The website where the customer placed the order |
| First name | The customer's first name |
| Last name | The customer's last name |
| Description | A description of the order |
Expand Down Expand Up @@ -143,7 +143,7 @@ This report provides insight (in Excel format) into your conversion rate. You ca
- Customer country and device
- Day
- Payment method
- Site
- Website

<details id="how-to-generate-conversion-reports">
<summary>How to generate conversion reports</summary>
Expand All @@ -153,8 +153,8 @@ This report provides insight (in Excel format) into your conversion rate. You ca
2. Go to **Reports** > **Advanced reporting**.
- Under **Date**, select the date range you want the report to cover.
- Under **Currency**, select the relevant currency.
- Under **Site** and **Site 2**, specify one or two sites (if relevant).
3. To download, click **XLS** or **XLSX**.
- Under **Website** and **Site 2**, specify one or two websites (if relevant).
3. To download, click **XLS** or **XLSX**.
4. Click **Execute report**.

</details >
Expand Down Expand Up @@ -243,7 +243,7 @@ This report provides an overview (in Excel format) of the specific transactions
| Sub description | A description of a component of the transaction, e.g. an <<glossary:issuer>> fee or currency conversion cost |
| Sub status | The <<glossary:transaction status>> |
| Sub ID | MultiSafepay's transaction reference number |
| Ms description | The site name |
| Ms description | The website name |
| Order ID | Your unique identifier for the order |
| Var1/Var2/Var3 | Additional information |

Expand All @@ -269,16 +269,16 @@ This report provides an overview (in Excel format) of the total revenue and/or n
- Customer country and device
- Day
- Payment method
- Site
- Website

<details id="how-to-generate-sales-reports">
<summary>How to generate sales reports</summary>
<br>

1. Sign in to your <a href="https://merchant.multisafepay.com" target="_blank">MultiSafepay dashboard</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i>.
2. Go to **Reports** > **Advanced reporting** > **Site**.
2. Go to **Reports** > **Advanced reporting** > **Website**.
3. Under **Date**, select the date range you want the report to cover.
4. If relevant, specify one or two sites under **Site** and **Site 2**.
4. If relevant, specify one or two websites under **Website** and **Site 2**.
5. To download, click **XLS** or **XLSX**.

</details>
Expand Down Expand Up @@ -340,7 +340,7 @@ This report provides an overview (in Excel or PDF format) of all transactions wi

- Fees
- Amount and currency
- Sites
- Websites

<details id="how-to-generate-transaction-summaries">
<summary>How to generate transaction summaries</summary>
Expand All @@ -353,8 +353,8 @@ This report provides an overview (in Excel or PDF format) of all transactions wi
- **Currency** field: Select the relevant currency.
- **Status** field: Select the <<glossary:order status>> or <<glossary:transaction status>>, if relevant
- **Payment method** field: Select the relevant payment method.
- **Site** field: Select the relevant site.
- **Grouping method** field: Specify if you want to total fees together per **Site**, **Payment method**, or **Country**, or not at all.
- **Website** field: Select the relevant website.
- **Grouping method** field: Specify if you want to total fees together per **Website**, **Payment method**, or **Country**, or not at all.
- To group all transactions and only show the daily total, select the **Show per day** checkbox.
5. Click **Generate report**.

Expand Down
2 changes: 1 addition & 1 deletion content/checkout/fastcheckout-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: 'fastcheckout-integration'
parentDoc: 62fcc05ac034cb06771c46fc
---

This technical manual is for embedding FastCheckout into your site using JavaScript.
This technical manual is for embedding FastCheckout into your website using JavaScript.

# 1. Add the HTML elements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ items_count=2

| Parameter | Description |
|---|---|
| `notification_url` | The [webhook endpoint](/docs/webhook/) for MultiSafepay to send order updates and other notifications for this site. <br> See also [feed_url](#via-feedurl) below. |
| `notification_url` | The [webhook endpoint](/docs/webhook/) for MultiSafepay to send order updates and other notifications for this website. <br> See also [feed_url](#via-feedurl) below. |
| `identifier` | The identifier of the request. Set to `shipping`. |
| `country` | The customer's country. |
| `countrycode` | The country code. <br> Format: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2" target="_blank">ISO-3166-1 alpha-2</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i>, e.g. `NL`. |
Expand Down
10 changes: 5 additions & 5 deletions content/checkout/fastcheckout.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,9 @@ You can also include custom fields, e.g. terms and conditions, newsletter signup

# Activation

Email a request to activate FastCheckout for specific sites under your account to <sales@multisafepay.com>
Email a request to activate FastCheckout for specific websites under your account to <sales@multisafepay.com>

Specify in your request the relevant [site IDs](/docs/sites#site-id-api-key-and-security-code).
Specify in your request the relevant [website IDs](/docs/sites#site-id-api-key-and-security-code).

# Integration

Expand All @@ -103,7 +103,7 @@ To integrate FastCheckout as a hosted page via our API, see:
- API reference – [Create order](/reference/createorder) > FastCheckout order
- Recipes – <a href="https://docs.multisafepay.com/recipes/create-a-fastcheckout-page" target="_blank">Create a FastCheckout page</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i>

To embed FastCheckout into your site, see [FastCheckout JavaScript integration](/docs/fastcheckout-integration/).
To embed FastCheckout into your website, see [FastCheckout JavaScript integration](/docs/fastcheckout-integration/).

If you cannot send your available shipping options for the shipping element in your [create order](/reference/createorder) request, see [FastCheckout shipping options request](/docs/fastcheckout-shipping-options/).

Expand All @@ -121,8 +121,8 @@ You can add your brand's logo at the top of the FastCheckout page.
<br>

1. Sign in to your <a href="https://merchant.multisafepay.com" target="_blank">MultiSafepay dashboard</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i>.
2. Go to **Sites**, and then click the relevant site.
3. On the **Site profile** page, under **Functionality**, from the **FastCheckout logo** list, select the relevant logo.
2. Go to **Websites**, and then click the relevant website.
3. On the **Website profile** page, under **Functionality**, from the **FastCheckout logo** list, select the relevant logo.
4. Click **Save changes**.

---
Expand Down
4 changes: 2 additions & 2 deletions content/checkout/payment-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ These are the supported payment methods:

# Integration

- [Single payment method integration](/docs/payment-component-single/): Embed a single payment method into your site
- [Multiple payment method integration](/docs/payment-component-multiple/): Embed multiple payment methods into your site
- [Single payment method integration](/docs/payment-component-single/): Embed a single payment method into your website
- [Multiple payment method integration](/docs/payment-component-multiple/): Embed multiple payment methods into your website
- [Payment component customization manual](/docs/payment-component-customization/)
- [Previous release integration manual](/docs/payment-component-previous-release/)
<br>
Expand Down
4 changes: 2 additions & 2 deletions content/checkout/payment-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Or via your dashboard:
1. Sign in to your <a href="https://merchant.multisafepay.com" target="_blank">MultiSafepay dashboard</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i>.
2. Go to **Transactions** > **Payment links**.
3. Click **New payment link**.
4. From the **Site** list, select the relevant site.
4. From the **Website** list, select the relevant website.
5. Under **Amount**, select the currency from the list, and then enter the whole value and cents.
6. In the **Order ID** field, enter the order ID from your webshop.
**⚠️ Note:** The order ID for every payment link must be unique.
Expand Down Expand Up @@ -170,7 +170,7 @@ For an overview of all payment links:

**All** payment methods are supported.

The payment page displays **all** payment methods activated for the relevant site. If you want to display specific payment methods, you need to create a new site profile with only the relevant methods activated.
The payment page displays **all** payment methods activated for the relevant website. If you want to display specific payment methods, you need to create a new website profile with only the relevant methods activated.

</details>

Expand Down
Loading
Loading