Skip to content

Commit

Permalink
Update transition-to-one-platform.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sopbergmann authored Jul 8, 2024
1 parent 4bde5dd commit 22cc5ab
Showing 1 changed file with 25 additions and 33 deletions.
58 changes: 25 additions & 33 deletions docs/subscriptions/transition-to-one-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,48 +38,40 @@ You'll receive an email with the required information, even if you're an existin
:::info Prepare for launch
<Launch />
:::

## **1. Agreements**
### 1.1 Agreement request expiration period
We know that you have various ways to send agreement requests to your customer, such as from your website, through customer self-service portals, by email, printed as a QR on paper invoices, and while chatting on the phone. Some of these scenarios require that the agreement request is valid for a very long time, like when it's sent by email or printed as a QR on a paper invoice. After Nordic Wallet Launch, we will reduce the agreement signing period to 10 minutes. Please note, All agreements with longer expiration time will be expired on Nordic Wallet Launch day. To ensure the security and privacy of our users' data, all user redirects within our system must utilize HTTPS.


:star: **Recommendation:** If you want to give more than 10 minutes for your customer to sign the agreement, we recommend that you create a middle layer of communication on your private infrastructure. This means that when the user initiates agreement signing from your email or scans the QR on a paper invoice, they should be redirected to your environment. At that moment, you can create the agreement request in Vipps MobilePay and redirect the customer to us. You will be in control of a bigger part of the agreement signing flow, providing more flexibility for you to manage the process. In addition, you will have no need to send us all potential agreement requests, even if they will never be initiated by the customer. This means less data send to us, and less GDPR related questions 😉

⚙️ Tech: API endpoint: `POST:/api/providers/{providerId}/agreements`

Parameter: `expiration_timeout_minutes`. The current range is from 1 to 181440 minutes, the default was 5 minutes. After Nordic Wallet Launch, the expiration time will always be 10 minutes.

### 1.2 Agreement deletion validations
No one likes when an agreement gets canceled, right? We do not like it either. The Subscriptions API offers you the option to prevent the customer from canceling an agreement for up to 24 hours from the time it's signed. From the Nordic Wallet Launch, this feature will be unavailable.

:star: **Recommendation:** We will help you to provide the best payment experience and keep the customer happy so that canceling an agreement will not come into his mind.

⚙️ Tech: API endpoint: `POST:/api/providers/{providerId}/agreements`

Parameter: `retention_period_hours` will be ignored from the Nordic Wallet Launch.

### 1.3 Agreements without amount

Current agreements where amount is not stated will be depicted as agreements with variable amount.

:star: **Recommendation:** We recommend you to update/create agreements with amount if it's known in practice.

⚙️ Tech: API endpoint: `POST /api/providers/{providerId}/agreements` or `PATCH /api/providers/{providerId}/agreements/{agreementId}` Parameter `amount`

### 1.1 Agreement Request Expiration
- **Change:** Signing period will be reduced to 10 minutes after Nordic Wallet Launch. Existing agreements with longer expiration will expire on launch day.
- **Recommendation:** Create a middle layer to handle agreement requests on your infrastructure, allowing more than 10 minutes for signing. This reduces unnecessary data and GDPR concerns.
- **Tech:**
- **API Endpoint:** `POST:/api/providers/{providerId}/agreements`
- **Parameter:** `expiration_timeout_minutes` (will always be 10 minutes post-launch).

### 1.2 Agreement Deletion Validations
- **Change:** Preventing customer cancellations within 24 hours will be unavailable after Nordic Wallet Launch.
- **Recommendation:** Provide a seamless payment experience to avoid cancellations.
- **Tech:**
- **API Endpoint:** `POST:/api/providers/{providerId}/agreements`
- **Parameter:** `retention_period_hours` (will be ignored post-launch).

### 1.3 Agreements Without Amount
- **Change:** Agreements without a stated amount will be considered variable amount agreements.
- **Recommendation:** Update/create agreements with known amounts.
- **Tech:**
- **API Endpoint:** `POST /api/providers/{providerId}/agreements` or `PATCH /api/providers/{providerId}/agreements/{agreementId}`
- **Parameter:** `amount`

![WMP Amount](path/to/img/vmpamount.png)
[<img
src={require('/img/vmpamount.png').default}
alt="WMP Amount"
width="250"
/>](/img/vmpamount.png)

*Draft version of agreement screen, not final version.*

### 1.4 Agreement cancellation by merchant

When merchant tries to cancel agreement, which has payments in reserved state - agreement gets cancelled, payments stay in reserved state. This is changing from Nordic Wallet Launch. When merchant cancels agreement all reserved payments will be canceled too.
### 1.4 Agreement Cancellation by Merchant
- **Change:** Canceling agreements will also cancel any reserved payments post-launch.
- **Recommendation:** Capture reserved payments before canceling agreements if applicable.

:star: **Recommendation:** Capture reserved payments if needed before canceling the agreement. This applies just if you have agreement cancellation implemented from your environment and you are using payments with reservation.

## **2. Recurring payments**

Expand Down

0 comments on commit 22cc5ab

Please sign in to comment.