From 4701e70847397b03068382b686d094c535937c71 Mon Sep 17 00:00:00 2001 From: clywyk Date: Wed, 6 Dec 2023 18:58:47 +0100 Subject: [PATCH 1/2] Add card definitions, minor edits --- docs/glossary.mdx | 27 ++++++++++++++++--- docs/topics/cards/digital/index.mdx | 1 - .../cards/physical/guide-block-unblock.mdx | 2 +- docs/topics/cards/physical/guide-cancel.mdx | 2 +- docs/topics/cards/virtual/guide-view-info.mdx | 4 +-- docs/topics/definitions/_cards-digital.mdx | 2 ++ docs/topics/definitions/_cards-physical.mdx | 1 + docs/topics/definitions/_cards-virtual.mdx | 3 +++ 8 files changed, 33 insertions(+), 9 deletions(-) create mode 100644 docs/topics/definitions/_cards-digital.mdx create mode 100644 docs/topics/definitions/_cards-physical.mdx create mode 100644 docs/topics/definitions/_cards-virtual.mdx diff --git a/docs/glossary.mdx b/docs/glossary.mdx index d6feb890e6..a37e3229fa 100644 --- a/docs/glossary.mdx +++ b/docs/glossary.mdx @@ -12,15 +12,15 @@ import AccountHolderDefinition from './topics/definitions/_account-holder.mdx'; *** +## [Account onboarding](topics/onboarding/index.mdx) + import CompanyOnboardingDefinition from './topics/definitions/_onboarding-company.mdx'; import IndividualOnboardingDefinition from './topics/definitions/_onboarding-individual.mdx'; -## [Account onboarding](topics/onboarding/index.mdx) - -[**Company account onboarding**](topics/onboarding/company/index.mdx) +### [**Company account onboarding**](topics/onboarding/company/index.mdx) -[**Individual account onboarding**](topics/onboarding/individual/index.mdx) +### [**Individual account onboarding**](topics/onboarding/individual/index.mdx) *** @@ -32,6 +32,25 @@ import CapitalDepositDefinition from './topics/definitions/_capital-deposit.mdx' *** +## [Cards](topics/cards/index.mdx) + +import VirtualCardDefinition from './topics/definitions/_cards-virtual.mdx'; + +import PhysicalCardDefinition from './topics/definitions/_cards-physical.mdx'; + +import DigitalCardDefinition from './topics/definitions/_cards-digital.mdx'; + +### [**Virtual cards**](topics/cards/virtual/index.mdx) + + +### [**Physical cards**](topics/cards/physical/index.mdx) + + +### [**Digital cards**](topics/cards/digital/index.mdx) + + +*** + import LegalRepDefinition from './topics/definitions/_legal-rep.mdx'; ## Legal representative diff --git a/docs/topics/cards/digital/index.mdx b/docs/topics/cards/digital/index.mdx index 12eaa1470f..30381d5dfe 100644 --- a/docs/topics/cards/digital/index.mdx +++ b/docs/topics/cards/digital/index.mdx @@ -77,5 +77,4 @@ flowchart LR ## Guides {#guides} - [Add digital cards to Apple Pay and Google Pay](./guide-add.mdx) -- [Renew a digital card](#auto-renew) - [Cancel a digital card](./guide-cancel.mdx) \ No newline at end of file diff --git a/docs/topics/cards/physical/guide-block-unblock.mdx b/docs/topics/cards/physical/guide-block-unblock.mdx index b8b37ca27d..d4fe48e6f5 100644 --- a/docs/topics/cards/physical/guide-block-unblock.mdx +++ b/docs/topics/cards/physical/guide-block-unblock.mdx @@ -5,7 +5,7 @@ title: Block & unblock physical cards # Block & unblock physical cards :::caution Blocked for incorrect PIN attempts -If a card was blocked without request, it might because the cardholder made too many [incorrect attempts to enter their PIN](./index.mdx#pin-incorrect-attempts). +If a card was blocked without request, it might be because the cardholder made too many [incorrect attempts to enter their PIN](./index.mdx#pin-incorrect-attempts). In this case, you need to wait 24 hours before you can unlock the card. ::: diff --git a/docs/topics/cards/physical/guide-cancel.mdx b/docs/topics/cards/physical/guide-cancel.mdx index f8e5bcb149..244b507076 100644 --- a/docs/topics/cards/physical/guide-cancel.mdx +++ b/docs/topics/cards/physical/guide-cancel.mdx @@ -10,7 +10,7 @@ Digital and virtual cards will continue to function. Refer to guides for [digital](../digital/guide-cancel.mdx) and [virtual](../virtual/guide-cancel.mdx) cards if you need to cancel those as well. :::caution Lost or stolen cards -If the physical card was lost or stolen, ask the cardholder the following questions. +If the physical card was lost or stolen, ask the cardholder the following questions: 1. Did the cardholder digitize their physical card? 1. If so, was the cardholder's mobile device lost or stolen? diff --git a/docs/topics/cards/virtual/guide-view-info.mdx b/docs/topics/cards/virtual/guide-view-info.mdx index 422827ad1b..6d4812d550 100644 --- a/docs/topics/cards/virtual/guide-view-info.mdx +++ b/docs/topics/cards/virtual/guide-view-info.mdx @@ -6,7 +6,7 @@ title: View sensitive information ## Prepare to view sensitive information {#view-prepare} -The `cardUrl` available in the `card` query leads to website that displays the card with its design and its sensitive hidden information. +The `cardUrl` available in the `card` query leads to a website that displays the card with its design and its sensitive hidden information. Consider integrating it into your product with an iframe or a webview. This URL is available for one hour after you query it. @@ -24,7 +24,7 @@ All of this data is considered sensitive and is not directly available through t 1. When the Account member wants to display sensitive information, you must call the `viewCardNumbers` mutation which returns a consent. 1. Replace $YOUR_CARD_ID with your card ID, and $YOUR_REDIRECT_URL with the URL you want to redirect the user to after viewing the card numbers. 1. Make sure you are authenticated with a user access token using the name of the card's account member. -1. Then a consentUrl is returned which invites the user to start the Strong Customer Authentication with Swan. You need to open a native pop-up to display the consentUrl. This URL will redirect the user to a page with the card numbers displayed with the card design. +1. Then a `consentUrl` is returned which invites the user to start the Strong Customer Authentication with Swan. You need to open a native pop-up to display the `consentUrl`. This URL will redirect the user to a page with the card numbers displayed with the card design. ### Mutation diff --git a/docs/topics/definitions/_cards-digital.mdx b/docs/topics/definitions/_cards-digital.mdx new file mode 100644 index 0000000000..1816b455dc --- /dev/null +++ b/docs/topics/definitions/_cards-digital.mdx @@ -0,0 +1,2 @@ +Digital format of a virtual or physical card. +Swan cards can be digitized and added to Apple Pay and Google Pay. \ No newline at end of file diff --git a/docs/topics/definitions/_cards-physical.mdx b/docs/topics/definitions/_cards-physical.mdx new file mode 100644 index 0000000000..1c0c6765fd --- /dev/null +++ b/docs/topics/definitions/_cards-physical.mdx @@ -0,0 +1 @@ +Plastic payment card that can be used for point-of-sale transactions using swipe, chip and PIN, and contactless, as well as for online transactions. \ No newline at end of file diff --git a/docs/topics/definitions/_cards-virtual.mdx b/docs/topics/definitions/_cards-virtual.mdx new file mode 100644 index 0000000000..37ff9fb2ad --- /dev/null +++ b/docs/topics/definitions/_cards-virtual.mdx @@ -0,0 +1,3 @@ +Swan's default, dematerialized cards. +A virtual card must exist before creating a physical card or adding a card to a digital Wallet. +Virtual cards are also available in a single-use format. \ No newline at end of file From f5c36bad5bb28d5681436db2f01988b07896e1de Mon Sep 17 00:00:00 2001 From: clywyk Date: Thu, 7 Dec 2023 16:43:33 +0100 Subject: [PATCH 2/2] Edits to cards section after feedback; add cards definitions --- docs/glossary.mdx | 17 ++++++++++++----- docs/topics/cards/digital/index.mdx | 8 ++++++++ docs/topics/cards/index.mdx | 16 ++++++++++++---- docs/topics/cards/physical/index.mdx | 8 ++++++++ docs/topics/cards/virtual/index.mdx | 8 +++++++- 5 files changed, 47 insertions(+), 10 deletions(-) diff --git a/docs/glossary.mdx b/docs/glossary.mdx index a37e3229fa..89c694d023 100644 --- a/docs/glossary.mdx +++ b/docs/glossary.mdx @@ -18,9 +18,13 @@ import CompanyOnboardingDefinition from './topics/definitions/_onboarding-compan import IndividualOnboardingDefinition from './topics/definitions/_onboarding-individual.mdx'; -### [**Company account onboarding**](topics/onboarding/company/index.mdx) +### [Company account onboarding](topics/onboarding/company/index.mdx) -### [**Individual account onboarding**](topics/onboarding/individual/index.mdx) + + +### [Individual account onboarding](topics/onboarding/individual/index.mdx) + + *** @@ -40,13 +44,16 @@ import PhysicalCardDefinition from './topics/definitions/_cards-physical.mdx'; import DigitalCardDefinition from './topics/definitions/_cards-digital.mdx'; -### [**Virtual cards**](topics/cards/virtual/index.mdx) +### [Virtual cards](topics/cards/virtual/index.mdx) + -### [**Physical cards**](topics/cards/physical/index.mdx) +### [Physical cards](topics/cards/physical/index.mdx) + -### [**Digital cards**](topics/cards/digital/index.mdx) +### [Digital cards](topics/cards/digital/index.mdx) + *** diff --git a/docs/topics/cards/digital/index.mdx b/docs/topics/cards/digital/index.mdx index 30381d5dfe..488c16cf41 100644 --- a/docs/topics/cards/digital/index.mdx +++ b/docs/topics/cards/digital/index.mdx @@ -4,6 +4,14 @@ title: Digital cards # Digital cards +import DigitalCardsDefinition from '../../definitions/_cards-digital.mdx'; + +*** + +**Digital cards** ** + +*** + Swan cards are compatible with Apple Pay and Google Pay. If you choose to allow digital cards, your cardholders can add virtual and physical cards to their preferred digital wallet. diff --git a/docs/topics/cards/index.mdx b/docs/topics/cards/index.mdx index fd393d7aa7..17d301fa7a 100644 --- a/docs/topics/cards/index.mdx +++ b/docs/topics/cards/index.mdx @@ -12,11 +12,19 @@ Note that cards don't come with insurance. ## Types of cards {#types} +import VirtualCardsDefinition from '../definitions/_cards-virtual.mdx'; + +import PhysicalCardsDefinition from '../definitions/_cards-physical.mdx'; + +import DigitalCardsDefinition from '../definitions/_cards-digital.mdx'; + Swan supports three types of cards: -- [Virtual](./virtual/index.mdx): card that only exists on the computer, perfect for e-commerce transactions -- [Physical](./physical/index.mdx): classic plastic card used to complete swipe, chip and PIN, and contactless payments -- [Digital](./digital/index.mdx): virtual or physical card that's added to a digital wallet, such as Apple Pay or Google Pay +[**Virtual cards**](./virtual/index.mdx) → + +[**Physical cards**](./physical/index.mdx) → + +[**Digital cards**](./digital/index.mdx) → ### Creation order {#types-order} @@ -99,7 +107,7 @@ Your card's language (the language that will appear on payment terminals, for ex For Swan's **no-code** and **open source** Web Banking interface, the card language is determined by the default language of the browser where the card is created. -When using the **API**, the card language is the same as the Swan account language unless otherwise communicated. +When using the **API**, the default language is English. You can update the default language by calling the `bindAccountMembership` mutation and adding `accept-language` to the HTTP header. This allows the users to choose their card language. diff --git a/docs/topics/cards/physical/index.mdx b/docs/topics/cards/physical/index.mdx index 922da97814..7a550a42c0 100644 --- a/docs/topics/cards/physical/index.mdx +++ b/docs/topics/cards/physical/index.mdx @@ -4,6 +4,14 @@ title: Physical cards # Physical cards +import PhysicalCardsDefinition from '../../definitions/_cards-physical.mdx'; + +*** + +**Physical cards** ** + +*** + You can order a physical card for each virtual card. Swan physical cards are typical plastic cards that can be used for swipe, chip and PIN, contactless, and online transactions. Your [design](../design/index.mdx) will be printed on all physical cards. diff --git a/docs/topics/cards/virtual/index.mdx b/docs/topics/cards/virtual/index.mdx index 9f52e33aac..a80d96f5c4 100644 --- a/docs/topics/cards/virtual/index.mdx +++ b/docs/topics/cards/virtual/index.mdx @@ -4,7 +4,13 @@ title: Virtual cards # Virtual cards -Welcome to virtual cards, Swan's default card type. +import VirtualCardsDefinition from '../../definitions/_cards-virtual.mdx'; + +*** + +**Virtual cards** ** + +*** Whenever you issue a new card, a virtual card number is **created and enabled instantly**, and the cardholder can start using it online right away. The virtual card must exist before a physical card can be printed or a virtual card added to a digital wallet.