Skip to content

Commit 5c79c30

Browse files
authored
Merge pull request #23 from swan-io/143/cards
Migrate cards section
2 parents 7d89467 + a03f3f5 commit 5c79c30

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1549
-3
lines changed
284 KB
Loading
240 KB
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
147 KB
Loading
250 KB
Loading
538 KB
Loading
225 KB
Loading
+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Design custom cards
3+
---
4+
5+
# Design custom cards
6+
7+
You can design a custom card for your Swan cardholders.
8+
Custom designs, like standard ones, are used for virtual, physical, and digital cards.
9+
10+
import CustomCardDesign from '../partials/_custom-card-timeline.mdx';
11+
12+
<CustomCardDesign />
13+
14+
## Process overview {#overview}
15+
16+
1. Send an email to [email protected] stating that you'd like to begin the custom design process. Include how many cards you'll print in the first batch (100 minimum).
17+
1. Swan will send you a tutorial and an Adobe Illustrator file that's ready to use.
18+
1. Choose your **customizations**.
19+
1. Choose your **packaging**.
20+
1. Send your design to your Technical Account Manager.
21+
1. Your Technical Account Manager will work with Mastercard to validate your design.
22+
1. After your design is validated, samples of your card will be printed and delivered for final approval.
23+
1. As soon as you approve the sample, your cards can be printed and delivered to your cardholders.
24+
25+
import CustomCardLockedElements from '../partials/_custom-locked-elements.mdx';
26+
27+
:::note Locked elements
28+
The following elements **can't be changed**:
29+
<CustomCardLockedElements />
30+
:::
31+
32+
## Choose your customizations {#customizations}
33+
34+
| Element | Options |
35+
| --- | --- |
36+
| Chip color | <ul><li>Gold (default)</li><li>Silver (2,000 cards minimum, additional cost)</li></ul> |
37+
| Type of plastic<br/>*(no metal available)* | <ul><li>Standard plastic</li><li>Recycled plastic 85% or 100% (adds up to 12 weeks as recycled plastic is shipped by boat to reduce the carbon footprint)</li></ul> |
38+
| Finish | <ul><li>Matte</li><li>Gloss</li><li>Partially matte or gloss (might be referred to as *selective varnish*; additional cost)</li><li>Logo printed with brilliant effect (additional cost)</li><li>Other effects, such as metallic, fluorescent silkscreen, and more, are also available at an additional cost</li></ul> |
39+
| Color | You can customize your color for the front, back, and edges.<br/><br/><ul><li>**Dyed PVC**<ul><li>Front, back, and edges are dyed the same color </li><li>Additional cost</li></ul></li></ul><ul><li>**Edge color**<ul><li>Choose a different color for the edges</li><li>Additional cost</li></ul></li></ul><ul><li>**Face color only**<ul><li>Might be referred to as *quadri-faced color*</li><li>Front and back are dyed the same color, while the edges stay white</li><li>No additional cost</li></ul></li></ul><ul><li>**Custom magnetic band color**<ul><li>Default color is black</li><li>Choose a different color for an additional cost</li></ul></li></ul>Several colors are available. Please indicate the color you'd like, and your Technical Account Manager will share your options with you. Note that if your chosen color clashes with the Mastercard logo, the logo will be outlined in white. |
40+
| Text style | While the font must be Maison Neue, the styling of the text is up to you. Styling is applied to the cardholder name, card number, identifier, expiry date, CVC, and the debit or business label.<br/><br/><ul><li>**Durable graphics** (default, cost included)<ul><li>Durable color foil applied to card</li><li>Available in white, black, silver, or gold (other colors available but require validation)</li></ul></li></ul><ul><li>**Embossed**<ul><li>Text is raised off the card</li><li>Additional cost</li></ul></li></ul><ul><li>**Thermal printing**<ul><li>Long-lasting technique that carves the text out of the card</li><li>Additional cost</li></ul></li></ul><ul><li>**Laser**<ul><li>Long-lasting technique that burns the text into the card with a laser</li><li>Additional cost</li></ul></li></ul> |
41+
| Additional line | <ul><li>Add an additional line to the front of your card (example: add your company name)</li><li>Line appears under the cardholder name</li><li>Content must be approved</li><li>Limit: 26 characters</li></ul> |
42+
43+
## Choose your packaging {#packaging}
44+
45+
| Type | Options |
46+
| --- | --- |
47+
| Standard packaging | Standard envelope with card attached to an inserted letter |
48+
| Customized letter text | Customize the written content of the letter; add additional languages (additional cost) |
49+
| Colorful paper insert | Paper used for the letter can be a color other that the standard white (additional cost) |
50+
| Customized packaging | Use a box or flyer; can add additional time (additional cost) |
+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Configure logo
3+
---
4+
5+
# Configure your logo
6+
7+
For both standard and custom card designs, you'll add your logo to the card.
8+
9+
Please follow these guidelines to when creating your SVG file, both so your logo looks great on your card and so Swan can validate the file.
10+
11+
12+
1. The SVG file can be a maximum of **100 kilobytes** (KB).
13+
1. Colors must be **monochrome**:
14+
- Black cards: white monochrome
15+
- Silver cards: black monochrome
16+
- If you'd prefer other color options, consider designing a custom card.
17+
1. Don't use any **opacity** settings. Don't apply the fill-opacity attribute.
18+
1. Don't use any **non-vectorial text**, meaning no text tag.
19+
1. Don't use layering, meaning there should be **no overlaid elements**.
20+
1. The **logo edges** must fit inside the container, or viewbox attribute.
21+
22+
23+
## Troubleshooting
24+
25+
Here are some tips to make sure your logo meets requirements.
26+
27+
| Problem | Explanation |
28+
| --- | --- |
29+
| Logo appearing too small | If your logo is appearing **smaller than expected**, check that your logo fits perfectly in the SVG viewbox attribute. Any padding between your logo and the viewbox edges will appear on your card. |
30+
| Empty rectangle instead of logo | If you see an **empty rectangle** (black or white) instead of your uploaded logo, there might be an issue with your SVG file. Check that there are no overlaid elements in your file. If there are overlaid elements, remove them and upload the new file. |
31+
| Logo isn't the correct color | If your logo is showing up as black on a black card, or white on a silver card, there might be an issue with your SVG file. Make sure you're not using CSS to apply your color, which is only compatible with browser renderers. |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: Configure standard cards
3+
---
4+
5+
# Configure standard cards
6+
7+
Standard designs are used everywhere, such as in-app, in digital Wallets, and when revealing a card's sensitive information, for virtual, physical, and digital cards.
8+
9+
Before creating cards, personalize the standard card design.
10+
You can use Swan's [card design studio](https://swan-io.github.io/card-design-studio/) to get a 3D preview of how your card will look.
11+
12+
:::tip Packaging
13+
You can **customize your packaging** for standard cards. Learn more in the [custom card design guide](./guide-custom.mdx#packaging).
14+
:::
15+
16+
## Create a standard card {#create}
17+
18+
1. Go to **Dashboard** > **Settings** > **Cards**.
19+
1. Click **Create a new card product**.
20+
21+
![Screenshot of the Dashboard cards settings page with two card products](../../../images/topics/cards/cards-configure-create-1.png)
22+
23+
3. Name your new card product.
24+
4. If you'd like to allow physical cards, toggle **Allow physical cards** to **on**.
25+
5. Click **Create**.
26+
27+
![Screenshot of the Dashboard cards settings page with two card products](../../../images/topics/cards/cards-configure-create-2.png)
28+
29+
## Configure your standard card {#configure}
30+
31+
1. Open the card product you'd like to configure.
32+
Remember to start on **Dashboard** > **Settings** > **Cards**.
33+
34+
![Screenshot of the Dashboard cards settings page with two card products](../../../images/topics/cards/cards-configure-1.png)
35+
36+
2. Choose black or silver. If you'd like to design a custom card, refer to the [dedicated guide](./guide-custom.mdx).
37+
3. Choose your logo size.
38+
4. Upload your logo, resizing if needed. Don't hesitate to refer to the [guide to create your logo file](./guide-logo.mdx).
39+
5. Click **Save**.
40+
41+
*Note that you can also preview your card in 3D from this page.*
42+
43+
After clicking **Save**, your updates are available immediately in Sandbox.
44+
However, Swan needs to **review changes to Live cards**.
45+
If you didn't upload a new logo, please upload your logo again and click **Save**, which forces the API to trigger a review.
46+
47+
![Screenshot of the Dashboard cards settings page with two card products](../../../images/topics/cards/cards-configure-2.png)
48+
49+
:::info Card product settings
50+
In the **Options** tab, you can also update your [card product settings](../overview/guide-update.mdx).
51+
:::

docs/topics/cards/design/index.mdx

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Card design
3+
---
4+
5+
# Card design
6+
7+
Your card design appears several times during your cardholders' user experience.
8+
Your design is:
9+
10+
- Featured in the Web Banking interface for virtual and physical cards
11+
- Printed on physical cards
12+
- Displayed in digital wallets
13+
14+
## Card product {#card-product}
15+
16+
import CardProductExplanation from '../partials/_card-product.mdx';
17+
18+
<CardProductExplanation />
19+
20+
## Standard card design {#standard}
21+
22+
Swan proposes two standard card designs that are already validated by Mastercard.
23+
24+
Personalize standard cards with your logo on the front of the card.
25+
See it now in Swan's [card design studio](https://swan-io.github.io/card-design-studio/).
26+
27+
### Black
28+
29+
Black cards feature your logo in **white monochrome**.
30+
31+
![Image displaying connection between account holders, account, account membership, and cards](../../../images/topics/cards/cards-design-standard-black.png)
32+
33+
### Silver
34+
35+
Silver cards feature your logo in **black monochrome**.
36+
37+
![Image displaying connection between account holders, account, account membership, and cards](../../../images/topics/cards/cards-design-standard-silver.png)
38+
39+
## Custom card design {#custom}
40+
41+
If the standard black or silver designs won't meet your needs, or you want customize more to your brand's style, Swan also offers [custom card designs](./guide-custom.mdx).
42+
43+
import CustomCardDesign from '../partials/_custom-card-timeline.mdx';
44+
45+
<CustomCardDesign />
46+
47+
Note that the following elements **can't be customized**:
48+
49+
import CustomCardLockedElements from '../partials/_custom-locked-elements.mdx';
50+
51+
<CustomCardLockedElements />
52+
53+
54+
## Guides {#guides}
55+
56+
- [Configure your standard card](./guide-standard.mdx)
57+
- [Design your custom card](./guide-custom.mdx)
58+
- [Configure your logo](./guide-logo.mdx)
+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: Add digital cards
3+
---
4+
5+
# Add digital cards
6+
7+
Learn how to add digital cards to Wallets.
8+
9+
import CompleteProvisioningGuide from '../partials/_provisioning-guide.mdx';
10+
11+
<CompleteProvisioningGuide />
12+
13+
## Add digital cards to Apple Pay and Google Pay {#provisioning}
14+
15+
:::note Manual Provisioning
16+
Cardholders can also go digital by entering their card numbers directly into Apple Pay or Google Pay.
17+
:::
18+
19+
1. Call the `addDigitalCard` mutation.
20+
1. Make sure to choose the `walletProvider` that corresponds to the cardholder's mobile device.
21+
1. This returns a [consent](https://docs.swan.io/api/consent).
22+
When you do this, make sure you are authenticated with an User Access Token using the name of the card's account member.
23+
1. The mutation returns a `consentUrl`, inviting the user to start Strong Customer Authentication with the Swan app.
24+
1. Then the Swan app proposes adding the card to Apple Pay or Google Pay depending on the brand of the account member's mobile device.
25+
26+
### Mutation
27+
28+
🔎 [Open the mutation in API Explorer](https://explorer.swan.io?query=bXV0YXRpb24gRGlnaXRhbENhcmQgewogIGFkZERpZ2l0YWxDYXJkKAogICAgaW5wdXQ6IHsKICAgICAgY2FyZElkOiAiJFlPVVJfQ0FSRF9JRCIKICAgICAgd2FsbGV0UHJvdmlkZXI6IEFwcGxlUGF5CiAgICAgIGNvbnNlbnRSZWRpcmVjdFVybDogIiRZT1VSX1JFRElSRUNUX1VSTCIKICAgIH0KICApIHsKICAgIC4uLiBvbiBBZGREaWdpdGFsQ2FyZFN1Y2Nlc3NQYXlsb2FkIHsKICAgICAgX190eXBlbmFtZQogICAgICBkaWdpdGFsQ2FyZCB7CiAgICAgICAgaWQKICAgICAgICBzdGF0dXNJbmZvIHsKICAgICAgICAgIC4uLiBvbiBEaWdpdGFsQ2FyZENvbnNlbnRQZW5kaW5nU3RhdHVzSW5mbyB7CiAgICAgICAgICAgIF9fdHlwZW5hbWUKICAgICAgICAgICAgY29uc2VudCB7CiAgICAgICAgICAgICAgY29uc2VudFVybAogICAgICAgICAgICB9CiAgICAgICAgICB9CiAgICAgICAgfQogICAgICB9CiAgICB9CiAgfQp9Cg%3D%3D&tab=api)
29+
30+
```graphql {4-6} showLineNumbers
31+
mutation DigitalApplePay {
32+
addDigitalCard(
33+
input: {
34+
cardId: "$YOUR_CARD_ID"
35+
walletProvider: ApplePay
36+
consentRedirectUrl: "$YOUR_REDIRECT_URL"
37+
}
38+
) {
39+
... on AddDigitalCardSuccessPayload {
40+
__typename
41+
digitalCard {
42+
id
43+
statusInfo {
44+
... on DigitalCardConsentPendingStatusInfo {
45+
__typename
46+
consent {
47+
consentUrl
48+
}
49+
}
50+
}
51+
}
52+
}
53+
}
54+
}
55+
```
56+
57+
### Payload
58+
59+
```json {6} showLineNumbers
60+
{
61+
"data": {
62+
"addDigitalCard": {
63+
"__typename": "AddDigitalCardSuccessPayload",
64+
"digitalCard": {
65+
"id": "$YOUR_DIGITAL_CARD_ID",
66+
"statusInfo": {
67+
"__typename": "DigitalCardConsentPendingStatusInfo",
68+
"consent": {
69+
"consentUrl": "$YOUR_CONSENT_URL"
70+
}
71+
}
72+
}
73+
}
74+
}
75+
}
76+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Cancel digital cards
3+
---
4+
5+
# Cancel digital cards
6+
7+
When you wish to instantly and permanently delete an Apple Pay or Google Pay digital card, you must use the `cancelDigitalCard` mutation.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: Add digital cards
3+
---
4+
5+
# Add digital cards
6+
7+
Learn how to add digital cards to Wallets.
8+
9+
import CompleteProvisioningGuide from '../partials/_provisioning-guide.mdx';
10+
11+
<CompleteProvisioningGuide />
12+
13+
## Add digital cards to Apple Pay and Google Pay {#provisioning}
14+
15+
:::note Manual Provisioning
16+
Cardholders can also go digital by entering their card numbers directly into Apple Pay or Google Pay.
17+
:::
18+
19+
1. Call the `addDigitalCard` mutation.
20+
1. This returns a [consent](https://docs.swan.io/api/consent).
21+
When you do this, make sure you are authenticated with an User Access Token using the name of the card's account member.
22+
1. The mutation returns a `consentUrl`, inviting the user to start Strong Customer Authentication with the Swan app.
23+
1. Then the Swan app proposes adding the card to Apple Pay or Google Pay depending on the brand of the account member's mobile device.
24+
25+
### Mutation
26+
27+
🔎 [Open the mutation in API Explorer](https://explorer.swan.io?query=bXV0YXRpb24gRGlnaXRhbENhcmQgewogIGFkZERpZ2l0YWxDYXJkKAogICAgaW5wdXQ6IHsKICAgICAgY2FyZElkOiAiJFlPVVJfQ0FSRF9JRCIKICAgICAgd2FsbGV0UHJvdmlkZXI6IEFwcGxlUGF5CiAgICAgIGNvbnNlbnRSZWRpcmVjdFVybDogIiRZT1VSX1JFRElSRUNUX1VSTCIKICAgIH0KICApIHsKICAgIC4uLiBvbiBBZGREaWdpdGFsQ2FyZFN1Y2Nlc3NQYXlsb2FkIHsKICAgICAgX190eXBlbmFtZQogICAgICBkaWdpdGFsQ2FyZCB7CiAgICAgICAgaWQKICAgICAgICBzdGF0dXNJbmZvIHsKICAgICAgICAgIC4uLiBvbiBEaWdpdGFsQ2FyZENvbnNlbnRQZW5kaW5nU3RhdHVzSW5mbyB7CiAgICAgICAgICAgIF9fdHlwZW5hbWUKICAgICAgICAgICAgY29uc2VudCB7CiAgICAgICAgICAgICAgY29uc2VudFVybAogICAgICAgICAgICB9CiAgICAgICAgICB9CiAgICAgICAgfQogICAgICB9CiAgICB9CiAgfQp9Cg%3D%3D&tab=api)
28+
29+
```graphql {4-6} showLineNumbers
30+
mutation DigitalApplePay {
31+
addDigitalCard(
32+
input: {
33+
cardId: "$YOUR_CARD_ID"
34+
walletProvider: ApplePay
35+
consentRedirectUrl: "$YOUR_REDIRECT_URL"
36+
}
37+
) {
38+
... on AddDigitalCardSuccessPayload {
39+
__typename
40+
digitalCard {
41+
id
42+
statusInfo {
43+
... on DigitalCardConsentPendingStatusInfo {
44+
__typename
45+
consent {
46+
consentUrl
47+
}
48+
}
49+
}
50+
}
51+
}
52+
}
53+
}
54+
```
55+
56+
### Payload
57+
58+
```json {6} showLineNumbers
59+
{
60+
"data": {
61+
"addDigitalCard": {
62+
"__typename": "AddDigitalCardSuccessPayload",
63+
"digitalCard": {
64+
"id": "$YOUR_DIGITAL_CARD_ID",
65+
"statusInfo": {
66+
"__typename": "DigitalCardConsentPendingStatusInfo",
67+
"consent": {
68+
"consentUrl": "$YOUR_CONSENT_URL"
69+
}
70+
}
71+
}
72+
}
73+
}
74+
}
75+
```

0 commit comments

Comments
 (0)