Skip to content

Commit

Permalink
Merge pull request #24 from swan-io/143/cards-edits
Browse files Browse the repository at this point in the history
143/cards edits
  • Loading branch information
clywyk authored Dec 7, 2023
2 parents a8a49a4 + f5c36ba commit 6a9edc9
Show file tree
Hide file tree
Showing 11 changed files with 74 additions and 13 deletions.
32 changes: 29 additions & 3 deletions docs/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,19 @@ 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)

<CompanyOnboardingDefinition />

[**Company account onboarding**](topics/onboarding/company/index.mdx) <CompanyOnboardingDefinition />
### [Individual account onboarding](topics/onboarding/individual/index.mdx)

[**Individual account onboarding**](topics/onboarding/individual/index.mdx) <IndividualOnboardingDefinition />
<IndividualOnboardingDefinition />

***

Expand All @@ -32,6 +36,28 @@ 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)

<VirtualCardDefinition />

### [Physical cards](topics/cards/physical/index.mdx)

<PhysicalCardDefinition />

### [Digital cards](topics/cards/digital/index.mdx)

<DigitalCardDefinition />

***

import LegalRepDefinition from './topics/definitions/_legal-rep.mdx';

## Legal representative
Expand Down
9 changes: 8 additions & 1 deletion docs/topics/cards/digital/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ title: Digital cards

# Digital cards

import DigitalCardsDefinition from '../../definitions/_cards-digital.mdx';

***

**Digital cards** *<DigitalCardsDefinition />*

***

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.
Expand Down Expand Up @@ -77,5 +85,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)
16 changes: 12 additions & 4 deletions docs/topics/cards/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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) → <VirtualCardsDefinition />

[**Physical cards**](./physical/index.mdx) → <PhysicalCardsDefinition />

[**Digital cards**](./digital/index.mdx) → <DigitalCardsDefinition />

### Creation order {#types-order}

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/topics/cards/physical/guide-block-unblock.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/cards/physical/guide-cancel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
8 changes: 8 additions & 0 deletions docs/topics/cards/physical/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ title: Physical cards

# Physical cards

import PhysicalCardsDefinition from '../../definitions/_cards-physical.mdx';

***

**Physical cards** *<PhysicalCardsDefinition />*

***

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.
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/cards/virtual/guide-view-info.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

Expand Down
8 changes: 7 additions & 1 deletion docs/topics/cards/virtual/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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** *<VirtualCardsDefinition />*

***

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.
Expand Down
2 changes: 2 additions & 0 deletions docs/topics/definitions/_cards-digital.mdx
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions docs/topics/definitions/_cards-physical.mdx
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions docs/topics/definitions/_cards-virtual.mdx
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 6a9edc9

Please sign in to comment.