Skip to content
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
4 changes: 4 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

The portal uses Astro with the Starlight theme. Application source sits in `src/`, with `pages/` for route entry points, `content/` for MDX docs, `components/` for reusable UI (React, Astro, and Circuit UI), and `utils/`/`lib/` for shared logic. Assets live in `src/assets` and `public/`. Build outputs go to `dist/`. Configuration resides in `astro.config.ts`, `ec.config.mjs`, and `wrangler.jsonc`; adjust them when adding new content types or deployment targets. API documentation is based on `openapi.yaml`, this file is synchronized from outside this repository, do not edit it.

## Content

Content (`content/`) of the developer portal uses United States English spelling and grammar. The articles shall be clear and concise and refer to external documentation for established standards and RFCs. We don't use emojis.

## Build, Test, and Development Commands

- `npm run dev` — watch mode with Hot Module Reloading; use when authoring docs or components.
Expand Down
6 changes: 3 additions & 3 deletions public/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
/online-payments/tools/hosted-checkout /online-payments/checkouts/hosted-checkout/
/online-payments/introduction/webhooks /online-payments/webhooks/
/online-payments/introduction/response-handling /online-payments/guides/response-handling/
/online-payments/introduction/register-app /tools/authorization/register-app
/online-payments/introduction/register-app /tools/authorization/oauth/
/online-payments/introduction/get-started /online-payments/
/online-payments/introduction/authorization /tools/authorization/authorization/
/online-payments/introduction/authorization /tools/authorization/
/online-payments/introduction/3ds /online-payments/3ds/
/online-payments/apm/introduction /online-payments/apm
/extdev /quickstart
Expand All @@ -23,7 +23,7 @@
/docs/sumup-woocommerce-plugin /online-payments/plugins/woocommerce
/docs/sumup-prestashop-plugin /online-payments/plugins/prestashop
/docs/single-payment /online-payments/guides/single-payment
/docs/register-app /tools/authorization/register-app
/docs/register-app /tools/authorization/oauth/
/docs/refund /online-payments/guides/refund
/docs/recurring-payments /online-payments/guides/recurring-payments
/docs/php-sdk /online-payments/sdks/php-sdk
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/online-payments/checkouts/card-widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A secure HTTPS connection is used to submit the payment information. To ensure a

Payment Widget is available to all SumUp merchants and getting started with it is really easy!

The only requirement to use Payment Widget is the ability to create online checkouts [using SumUp checkout API](/api/checkouts/create). SumUp API requires authorization with an API Key or Access Token - see the [Authorization Guide](/tools/authorization/authorization/) for details.
The only requirement to use Payment Widget is the ability to create online checkouts [using SumUp checkout API](/api/checkouts/create). SumUp API requires authorization with an API Key or Access Token - see the [Authorization guide](/tools/authorization/) for details.

## Compliance

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ All SumUp payment methods are available in Hosted Checkout, according to availab

Hosted Checkouts is available to all SumUp merchants and getting started with it is really easy!

The only requirement to access Hosted Checkout is the ability to create online checkouts [using SumUp checkout API](/api/checkouts/create), which returns the hosted checkout URL. SumUp API requires authorization with an API Key or Access Token - see the [Authorization Guide](/tools/authorization/authorization/) for details.
The only requirement to access Hosted Checkout is the ability to create online checkouts [using SumUp checkout API](/api/checkouts/create), which returns the hosted checkout URL. SumUp API requires authorization with an API key or access token—see the [Authorization guide](/tools/authorization/) for details.

## Accessing Hosted Checkout

Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/online-payments/guides/refund.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ Here are the things that you need in order to complete the steps in this guide:

- You have a merchant account with [SumUp](https://me.sumup.com/login) and have already filled in your [account details](https://me.sumup.com/account).
- For a **test account** reach out to our support team through this [contact form](/contact).
- You have [registered your client application](/tools/authorization/register-app/) with SumUp.
- You have a valid access token obtained via the [Authorization code flow](/tools/authorization/authorization/#authorization-code-flow).
- You have [registered your client application](/tools/authorization/oauth/#register-oauth-application) with SumUp.
- You have a valid access token obtained via the [Authorization code flow](/tools/authorization/oauth/#authorization-code-flow).
- You have processed successfully a payment checkout and you need to refund the transaction.

<Aside type="note">

Transactions are associated with active merchant user accounts. As a result, you _cannot_ use an access token obtained via the [Client credentials flow](/tools/authorization/authorization/#client-credentials-flow) to complete the steps in this guide.
Transactions are associated with active merchant user accounts. As a result, you _cannot_ use an access token obtained via the [Client credentials flow](/tools/authorization/oauth/#client-credentials-flow) to complete the steps in this guide.

</Aside>

Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/online-payments/guides/single-payment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ Here are the things that you need in order to complete the steps in this guide:

- You have a merchant account with [SumUp](https://me.sumup.com/login) and have already filled in your [account details](https://me.sumup.com/account).
- For a **test account** reach out to our support team through this [contact form](/contact).
- You have [registered your client application](/tools/authorization/register-app/) with SumUp.
- You have a valid access token obtained via one of the supported OAuth2 authorization flow, the [Authorization code flow](/tools/authorization/authorization/#authorization-code-flow) or [Client credentials flow](/tools/authorization/authorization/#client-credentials-flow).
- You have [registered your client application](/tools/authorization/oauth/#register-oauth-application) with SumUp.
- You have a valid access token obtained via one of the supported OAuth2 authorization flow, the [Authorization code flow](/tools/authorization/oauth/#authorization-code-flow) or [Client credentials flow](/tools/authorization/oauth/#client-credentials-flow).

<Aside type="note">

You can create and complete a payment checkout for any valid SumUp merchant user's account. As a result, you _can_ use an access token obtained either via the [Client credentials flow](/tools/authorization/authorization/#client-credentials-flow) or via the [Authorization code flow](/tools/authorization/authorization/#authorization-code-flow).
You can create and complete a payment checkout for any valid SumUp merchant user's account. As a result, you _can_ use an access token obtained either via the [Client credentials flow](/tools/authorization/oauth/#client-credentials-flow) or via the [Authorization code flow](/tools/authorization/oauth/#authorization-code-flow).

</Aside>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Here are the things that you need in order to complete the steps in this guide:

- You have a merchant account with [SumUp](https://me.sumup.com/login) and have already filled in your [account details](https://me.sumup.com/account).
- For a **test account** reach out to our support team through this [contact form](/contact).
- You have [an api key](/api-keys/). For more details see [docs](/tools/authorization/authorization/#api-keys)
- You have [an API key](/tools/authorization/api-keys/). For more details see the [API key guide](/tools/authorization/api-keys/#create-an-api-key).
- You have control over the backend server to retrieve data in a secure manner.

## Summary
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/online-payments/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ When you're done experimenting with the test account, switch back to a regular a

## Authorization

All Online Payment products consume SumUp APIs, which requires a means of authorization - either an API Key or Access Token. Check the [Authorization Guide](/tools/authorization/authorization/) for details on the available authorization options in SumUp.
All Online Payment products consume SumUp APIs, which requires a means of authorizationeither an API key or access token. Check the [Authorization guide](/tools/authorization/) for details on the available authorization options in SumUp.

## Checkout Products

Expand Down Expand Up @@ -99,13 +99,13 @@ The API receives requests and communicates responses mostly in [JSON](http://www

### Receiving payments

In order to receive payments, you need to [create a checkout](/online-payments/guides/single-payment/#1-create-a-checkout). Whether you would like to receive payments as a merchant directly, or initiate payments on a merchant's behalf depends on the type of [authorization](/tools/authorization/authorization/) provided.
In order to receive payments, you need to [create a checkout](/online-payments/guides/single-payment/#1-create-a-checkout). Whether you would like to receive payments as a merchant directly, or initiate payments on a merchant's behalf depends on the type of [authorization](/tools/authorization/) provided.
Checkouts are created in a server-to-server communication. This ensures that you can keep your access token and client credentials secret and guarantees that sensitive checkout details, e.g. amount or recipient, cannot be changed.

[Completing checkouts](/online-payments/guides/single-payment/#2-complete-a-checkout) could be done via your web browser or mobile application, which guarantees you do not need to worry about sensitive data, like card data, ever hitting your servers and thus avoiding the need to be PCI DSS compliant.

<Aside type="tip">
A checkout can be completed in a browser only from a domain that is present as an authorized JavaScript origin when [creating your client credentials](/tools/authorization/register-app/#3-create-oauth-client-credentials).
A checkout can be completed in a browser only from a domain that is present as an authorized JavaScript origin when [creating your client credentials](/tools/authorization/oauth/#3-create-oauth-client-credentials).
</Aside>

SumUp provides flexibility to complete a checkout by offering a couple of integration approaches:
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/online-payments/plugins/prestashop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ Currently the Alternative Payment Methods (APMs) are not available in SumUp plug

## Installation

1. Follow the instructions described in [the register application guide](/tools/authorization/register-app) in order to obtain the client credentials for your app.
2. Download the client credentials JSON as described in the [access client credentials section](/tools/authorization/register-app/#4-access-the-client-credentials)
1. Follow the instructions described in [the register application guide](/tools/authorization/oauth/#register-oauth-application) in order to obtain the client credentials for your app.
2. Download the client credentials JSON as described in the [access client credentials section](/tools/authorization/oauth/#4-access-the-client-credentials)
3. Upload the JSON to the "Module Configuration" page in your PrestaShop Backoffice.
4. Once your account is fully verified by SumUp, [contact us](/contact) to request enabling of the online payments scope for your PrestaShop online store.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/online-payments/plugins/wix.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ With this integration, the following Alternative Payment Methods (APMs) are avai

Here's how you can connect SumUp to your WIX online store:

1. First, create your secret API Key. [See this article](/tools/authorization/authorization/#integration-via-api-keys) for full information on how to do it. Copy your key before proceeding.
1. First, create your secret API key. [See this article](/tools/authorization/api-keys/#create-an-api-key) for full information on how to do it. Copy your key before proceeding.
2. Head over to your WIX dashboard.
3. Go to **Settings** and click on **Accept payments**.
4. Select **SumUp**, paste your secret API Key in the required field under **Account Information** and **Save**.
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/online-payments/plugins/woocommerce.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ You can now begin accepting payments through SumUp on your WordPress shop.
### Advanced Integration

1. Once the plugin is activated, click on **Advanced version** option.
2. [Create your API Key](/tools/authorization/authorization/#create-api-key)
2. [Create your API key](/tools/authorization/api-keys/#create-an-api-key)
3. Enter your credentials from your SumUp account (API Key, email and merchant code) and configure any settings as needed.

## Additional configuration
Expand Down Expand Up @@ -115,7 +115,7 @@ Create your credentials [here](https://developer.sumup.com/apps).
Monday through Friday.
</Aside>

Once you ensure you've met the above requirements, you can proceed with our [Register application guide](/tools/authorization/register-app/) to set up your client credentials. In that page you find information on how to register an app and your client credentials which are necessary for setting up the plugin in your Wordpress account.
Once you ensure you've met the above requirements, you can proceed with our [Register application guide](/tools/authorization/oauth/#register-oauth-application) to set up your client credentials. In that page you find information on how to register an app and your client credentials which are necessary for setting up the plugin in your Wordpress account.

## Plugin Configuration

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/online-payments/sdks/react-native-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ SumUp's React Native Payment SDK provides a payment sheet that is displayed on t
Here are the things that you need in order to complete the steps in this guide:
- You have a merchant account with [SumUp](https://me.sumup.com/login) and have already filled in your [account details](https://me.sumup.com/account).
- For a **test account** reach out to our support team through this [contact form](/contact).
- You have [registered your client application](/tools/authorization/register-app/) with SumUp.
- You have a valid access token obtained via the [Authorization code flow](/tools/authorization/authorization/#authorization-code-flow).
- You have [registered your client application](/tools/authorization/oauth/#register-oauth-application) with SumUp.
- You have a valid access token obtained via the [Authorization code flow](/tools/authorization/oauth/#authorization-code-flow).
- The restricted `payment_instruments` scope is enabled for your client application. If it isn't enabled, [contact us](/contact) and request it.
- Review how to create a single payment [here](https://developer.sumup.com/online-payments/guides/single-payment/#before-you-begin).

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/terminal-payments/cloud-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The Cloud API integration supports:

## Prerequisites

* Your device must be authorized to use the Cloud API. [Read the authorization guide](/tools/authorization/authorization/) and implement a method that best fits your use case. The API key should be sufficient if you do not intend to delegate access to third parties.
* Your device must be authorized to use the Cloud API. [Read the authorization guide](/tools/authorization/) and implement a method that best fits your use case. The API key should be sufficient if you do not intend to delegate access to third parties.
* You need to [create an Affiliate Key](/tools/authorization/affiliate-keys/) for your app. SumUp Cloud API requires the Affiliate Key to be present in checkout requests.
* We strongly recommend keeping the Solo terminal plugged-in when using Cloud API.
* If you want to use mobile data, make sure that you're not connected to a Wi-Fi network. Disconnect if you are -
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/terminal-payments/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can accept card payments using SumUp’s platform accompanied by our proprie

* Before you integrate either the [Native SDK](/terminal-payments/tools/sdk/) or the [Payment API Switch](/terminal-payments/payment-switch), you need to create a SumUp account in the [SumUp Dashboard](https://me.sumup.com). Alternatively, you can [create a test account](#getting-a-test-account).

* Once you have an account, you need to [create an Affiliate Key](/tools/authorization/affiliate-keys/) for your app and [provide means of authorization](/tools/authorization/authorization/).
* Once you have an account, you need to [create an Affiliate Key](/tools/authorization/affiliate-keys/) for your app and [provide means of authorization](/tools/authorization/).

<Aside type="caution">

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/terminal-payments/payment-switch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Your app initiates a request to charge a card, opens the SumUp app on the mercha

The API integration also allows the possibility to pre-fill the checkout amount and card holder information, and to send a receipt via SMS or email. You can use the cash option, which is not available in our SDK version, for better reporting and management of your funds in the SumUp dashboard.

Activate the [mandatory authorization scopes](/tools/authorization/authorization/#authorization-scopes) for a smooth performance. They will require obtaining an access token for your client application that will authenticate it with the SumUp REST API and authorize it to access server resources.
Activate the [mandatory authorization scopes](/tools/authorization/oauth/#authorization-scopes) for a smooth performance. They will require obtaining an access token for your client application that will authenticate it with the SumUp REST API and authorize it to access server resources.

## API documentation

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/terminal-payments/sdks/ios-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ SumUp iOS SDK supports either the OAuth 2.0 Authorization Code Flow login with A

### Implementing Authentication with OAuth 2.0

SumUp can issue Access Tokens in accordance with the OAuth 2.0 Authorization Code Flow, which is our recommended authorization approach (Client Credentials Flow is not supported by this SDK). See the [Authorization Documentation](/tools/authorization/authorization#integration-via-oauth-20) for more details.
SumUp can issue Access Tokens in accordance with the OAuth 2.0 Authorization Code Flow, which is our recommended authorization approach (Client Credentials Flow is not supported by this SDK). See the [Authorization Documentation](/tools/authorization/oauth/#integration-via-oauth-20) for more details.

### Implementing Authentication with View Controller

Expand Down
6 changes: 2 additions & 4 deletions src/content/docs/tools/authorization/affiliate-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ fees. For that reason, **Affiliate Keys are mandatory for card-present integrati
* [API Payment Switch](/terminal-payments/payment-switch/)
* [Solo API (Cloud API)](/terminal-payments/cloud-api/)

Affiliate keys are NOT part of any authorization mechanism as such. They are used by SumUp in card-present integrations to attribute the payments to a specific integration.

See [Authorization Guide](/tools/authorization/authorization/) for details on authorization.
Affiliate keys are not an authorization mechanism. Use them together with either [API keys](/tools/authorization/api-keys/) or [OAuth 2.0](/tools/authorization/oauth/) depending on how your integration calls SumUp APIs.

## Create Affiliate Key

Expand Down Expand Up @@ -66,7 +64,7 @@ in their checkout requests.

Check the following resources to build your integration:

* [OAuth 2.0 App Registration Guide](/tools/authorization/register-app/)
* [OAuth 2.0 App Registration Guide](/tools/authorization/oauth/#register-oauth-application)
* [iOS SDK Guide](/terminal-payments/sdks/ios-sdk/)
* [Android SDK Guide](https://github.com/sumup/sumup-android-sdk)
* [PHP SDK Guide](/online-payments/sdks/php-sdk/)
Expand Down
Loading