Skip to content

Fixing typos and JSON throughout the docs #317

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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 docs/developers/using-api/payment-control.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Note that times are written in [epoch millis](https://www.unixtimestamp.com/).
"accountId": "$ACCOUNT_ID",
"cardId": "$CARD_ID",
"digitalCardWalletProvider": "ApplePay", //digital token used for transaction; ApplePay, GooglePay, Merchant
"dateTime": 1646214656661, //time payment occured
"dateTime": 1646214656661, //time payment occurred
"expirationDateTime": 1647114656661, //time authorization will be released if preauthorized amount is not used
"originalAmountValue": 10.00,
"originalAmountCurrency": "EUR",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import DocumentsIntro from '../partials/_intro-registration.mdx';
- **URSSAF**: Unions de recouvrement des cotisations de sécurité sociale et d'allocations familiales
- *(English: Organizations for the Collection of Social Security and Family Benefit Contributions)*
- **EEA**: European Economic Area
- **JOAFE**: Journal officiel des associations et fondations d'entreprises
- **JOAFE**: Journal officiel des associations et fondations d'entreprise
- *(English: Official Journal of Associations & Corporate Foundations)*
- **ANAH**: Agence Nationale de l'Habitat
- *(English: National Housing Agency)*
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The following table describes the legal forms typically found for companies regi
| Europäische wirtschaftliche Interessenvereinigung (EWIV) | European Economic Interest Grouping |
| Societas Cooperativa Europaea (SCE) | European Cooperative Society |
| Genossenschaft | Cooperative Society |
| Gesellschaft bürgerlichen Rechts (eGbR) | Registered Civil Law Partnership |
| Gesellschaft bürgerlichen Rechts (GbR) | Registered Civil Law Partnership |

### Accepted documents {#companies-documents}
The following table lists the proof of registration documents accepted for companies registered in Germany.
Expand Down Expand Up @@ -57,7 +57,7 @@ The following table describes the legal forms relevant to self-employed individu
| Freiberufler | Liberal professionals or freelancers | - Berufsanmeldung or Berufszulassung or Freiberufler-registrierung <br/> - Brief vom Finanzamt, Bescheinigung über die steuerliche Erfassung or Steuerbescheid |
| Selbständig/Gewerbetreibende | Self-employed in trade or business |Gewerbeschein |
| Partnerschaft | Partnership | Satzung der Gesellschaft or Partnerschaftsvertrag |
| Gesellschaft bürgerlichen Rechts (eGbR) | Civil law partnership | - Satzung der Gesellschaft <br/> - Gewerbeschein (if available) |
| Gesellschaft bürgerlichen Rechts (GbR) | Civil law partnership | - Satzung der Gesellschaft <br/> - Gewerbeschein (if available) |

### Accepted documents {#companies-types}
The following table lists the accepted proof of registration documents for self-employed individuals and freelancers in Germany.
Expand Down
2 changes: 1 addition & 1 deletion docs/partnership/overview/guide-orias.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ As an MOBSP, you're regulated by **Orias**, an association that approves and mon
**In order to partner with Swan, you must apply to Orias**.
Swan can't complete this process for you, nor can Swan, at any time, access your personal Orias profile or obtain privileged information about your application.
Swan does provide training related to this process.
This training must be completed by a company leader, such as the President, Chief Exceutive Officer (CEO), a Director of a pertinent department, or another senior or executive leader.
This training must be completed by a company leader, such as the President, Chief Executive Officer (CEO), a Director of a pertinent department, or another senior or executive leader.

Note that your part can be done within a few hours, and Swan's within a few days.
After that, Orias can take up to two months to review your application.
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/accounts/documents/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ You can also [query the API](./guide-get-info.mdx).
| `ProviderColorIdDocumentRequired` | The document must be submitted in color. |
| `MissingSignature` | The document submitted must be signed or dated. |
| `BadDocumentQuality` | The quality of the document submitted is too low. All document content must be clear and legible. |
| `FullDocumentRequired` | The entire document must be sumbitted, not just a portion of the document. |
| `FullDocumentRequired` | The entire document must be submitted, not just a portion of the document. |
| `MissingProviderProofOfAddress` | The accommodation provider's proof of address is required. |
| `MissingProviderProof`<br />`OfAddressAndIdDocument` | The accommodation provider's ID and proof of address are required. |
| `PowerOfAttorneyToSwanRequired` | A signed and dated Power of Attorney must be provided to Swan. |
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/accounts/funding/guide-add-source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Note that you also receive a funding source ID (line 6) and a payment mandate ID
```

:::tip Funding source and mandate `Enabled`
After the account holder consents to the adding the funding source, the statuses for both the funding source and the direct debit mandate change to `Enabled`, and funds can be pulled into the Swan account.
After the account holder consents to adding the funding source, the statuses for both the funding source and the direct debit mandate change to `Enabled`, and funds can be pulled into the Swan account.

However, the account holder still needs to declare their payment mandate to their external provider.
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/accounts/funding/guide-initiate-request.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Initiate a funding request with the API.
1. Call the `initiateFundingRequest` mutation.
1. Add your `fundingSourceId` and `consentRedirectUrl`.
1. Add the `amount` to send the account, and its `currency`.
1. Optionally, add a `label`, `reference`, and anything other information you'd like.
1. Optionally, add a `label`, `reference`, and any other information you'd like.
1. Add the `InitiateFundingRequestSuccessPayload` success payload.
1. Add rejections (not shown).

Expand Down
2 changes: 1 addition & 1 deletion docs/topics/accounts/ibans/guide-add-virtual.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ mutation AddVirtual {

## Payload {#payload}

The payload shows provides the virtual IBAN with the status `Enabled`.
The payload provides the virtual IBAN with the status `Enabled`.

```json {6,10} showLineNumbers
{
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/accounts/ibans/guide-validate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The `ibanValidation` query confirms the following formatting:
1. Call the `ibanValidation` query.
1. Add an IBAN. You can test IBANs from any issuer and any [country Swan covers](../../../partnership/overview/country-coverage.mdx).
1. Add both the `ValidIban` and `InvalidIban` unions.
1. Add anything other information you'd like to review.
1. Add any other information you'd like to review.

🔎 [Open the query in API Explorer](https://explorer.swan.io?query=cXVlcnkgQ2hlY2tJYmFuRm9ybWF0IHsKICBpYmFuVmFsaWRhdGlvbihpbnB1dDogeyBpYmFuOiAiJFlPVVJfSUJBTiIgfSkgewogICAgLi4uIG9uIFZhbGlkSWJhbiB7CiAgICAgIF9fdHlwZW5hbWUKICAgICAgYWNjb3VudE51bWJlcgogICAgfQogICAgLi4uIG9uIEludmFsaWRJYmFuIHsKICAgICAgX190eXBlbmFtZQogICAgICBtZXNzYWdlCiAgICAgIGNvZGUKICAgIH0KICB9Cn0K&tab=api)

Expand Down
2 changes: 1 addition & 1 deletion docs/topics/accounts/memberships/guide-add-one.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import PrerequisiteAddMembers from './partials/_add-member-prereq.mdx';
## Step 1: Add the account membership {#api-add}

1. Call the `addAccountMembership` mutation.
1. Add the account ID to which you're adding a invited account member (line 4).
1. Add the account ID to which you're adding an invited account member (line 4).
1. In the `restrictedTo` object, add information about the invited account member (lines 6-9).
- If you're only granting `canViewAccount` permissions, or you're [not granting any permissions](./index.mdx#permissions-none), the invited account member's `birthDate` isn't required.
- Include a `+` in front of the phone number.
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/accounts/memberships/guide-suspend-resume.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ mutation ResumeMembership {

```

The account holder, legal representative of the account, or account member with `canManageAccountMembership` permissions must consents to resuming the membership.
The account holder, legal representative of the account, or account member with `canManageAccountMembership` permissions must consent to resuming the membership.

```json {7} title="Resume payload" showLineNumbers
{
Expand All @@ -148,7 +148,7 @@ The account holder, legal representative of the account, or account member with
"__typename": "ResumeAccountMembershipSuccessPayload",
"consent": {
"status": "Created",
"consentUrl": "https://identity.swan.io/consent?consentId=$CONSENT_ID&env=Sandbox"
"consentUrl": "https://identity.swan.io/consent?consentId=$CONSENT_ID&env=Sandbox",
"user": {
"id": "$YOUR_USER_ID",
"identificationLevels": {
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/accounts/memberships/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ When the account status changes to `Closed`, account members can view the accoun
Account memberships have a `version` attribute.

When a new membership is added, the `version` is `0`, then increases by a factor of 1 with each change.
Changes includes including suspending, resuming, and updating the membership.
Changes include suspending, resuming, and updating the membership.

## Sequence diagram {#diagrams-add}

Expand Down
1 change: 1 addition & 0 deletions docs/topics/accounts/overview/guide-get-bank-details.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ query getListVirtualBankDetails {
"id": "VIRTUAL_IBAN_ID_4",
"status": "Enabled"
},
},
{
"node": {
"BIC": "SWNBFR22",
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/cards/design/guide-standard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Before creating cards, personalize the standard card design.
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.

:::tip Packaging
You can [customize your packaging](./index.mdx#packaging) for standard cards..
You can [customize your packaging](./index.mdx#packaging) for standard cards.
:::

## Create a standard card {#create}
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/merchants/online/idd/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Otherwise, the mandate is considered invalid.
| Mandate reference | Unique identifier for the mandate, visible on the debtor's bank statement |
| Payment type | Choose one of the following options:<ul><li>Recurrent</li><li>One-off</li></ul> |
| Merchant (beneficiary) information | <ul><li>Merchant name</li><li>Merchant account holder address</li></ul> |
| Debtor information | Choose one of the following options:<ul><li>Debtor's account number</li><li>Debtor's IBAN</li></ul><br/>If the debtor doesn't have a Swan account upon creation of the mandate, include their identification information instead:<ul><li>Individual: given name, family date, and date of birth</li><li>Legal: name and SIREN</li></ul> |
| Debtor information | Choose one of the following options:<ul><li>Debtor's account number</li><li>Debtor's IBAN</li></ul><br/>If the debtor doesn't have a Swan account upon creation of the mandate, include their identification information instead:<ul><li>Individual: given name, family name, and date of birth</li><li>Legal: name and SIREN</li></ul> |

### Sample content {#mandates-content}

Expand Down
2 changes: 1 addition & 1 deletion docs/topics/merchants/sandbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,6 @@ mutation EnablePaymentMethod {
}
```

:::caution SEPA Diret Debit
:::caution SEPA Direct Debit
For SEPA Direct Debit, you can *only* use the Partner Testing API to update the status of your payment methods.
:::
2 changes: 1 addition & 1 deletion docs/topics/onboarding/account-holders/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ participant S as Swan

## Guides {#guides}

* [Monitior onboarding to track the verification process](../overview/guide-get-info.mdx)
* [Monitor onboarding to track the verification process](../overview/guide-get-info.mdx)
* [Add an account for an existing account holder](./guide-add-additional-account.mdx)
* [Get account holder verification status](./guide-get-status.mdx)
* [Request a first transfer](./guide-request-first-transfer.mdx)
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/onboarding/company/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import OnboardingOverview from '../partials/_overview.mdx';

## Collecting onboarding information {#collect-info}

Company onboarding information can be sumbitted **with the API** or through **Swan's onboarding form**.
Company onboarding information can be submitted **with the API** or through **Swan's onboarding form**.

| Method | Details |
| --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/onboarding/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Account holders complete a new onboarding to open another account.

:::info Cross reference
During onboarding, users also [complete an account holder verification](./account-holders/index.mdx#verification-process) process and [authenticate](../../developers/using-api/authentication/index.mdx) (log in) for the first time.
The might also [sign up for Swan](../users/index.mdx#signup) if they haven't already.
They might also [sign up for Swan](../users/index.mdx#signup) if they haven't already.
:::

### Types of onboarding {#types}
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/partials/_iso-8601.mdx
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Dates for this mutation use ISO 8601 convention: `YYYY-MM-DDTHH-mm-ssZ`.
Dates for this mutation use ISO 8601 convention: `YYYY-MM-DDTHH:mm:ssZ`.
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ Refer to the following lists for allowed countries and rails.
</tr>
<tr>
<td>🇻🇳 <code>VND</code> Vietnamese Dong</td>
<td><code>vietname_earthport</code></td>
<td><code>vietnam_earthport</code></td>
<td>2</td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ mutation SuspendMandate {

## Payload {#payload}

The payload shows the status `Suspended`, as well as the date and time at which is was suspended..
The payload shows the status `Suspended`, as well as the date and time at which is was suspended.

```json {8,10} showLineNumbers
{
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/payments/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ Swan will verify that your offer is compliant.
## About SEPA {#sepa}

The [Single Euro Payments Area (SEPA)](https://www.europeanpaymentscouncil.eu/about-sepa) is a payment network used to **transfer funds in euros in 36 countries**.
One of SEPA's primary goals is to **harmozine payments** across these countries, making it **easy to use cashless payment methods** anywhere you are in and around Europe.
One of SEPA's primary goals is to **harmonize payments** across these countries, making it **easy to use cashless payment methods** anywhere you are in and around Europe.
SEPA is regulated by the European Payments Council (EPC).

Swan uses the SEPA Credit Transfer, SEPA Instant Credit Transfer, SEPA Direct Debit payment methods for all transactions not executed internally between Swan accounts.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ This is expected behavior.
"expert": {
"__typename": "InvalidIdentificationLevelStatusInfo",
"reasons": [
"BadDocumentLightning"
"BadDocumentLighting"
],
"status": "Invalid"
},
Expand Down