Skip to content

fix: correct Solo checkout example in affiliate keys docs #1019

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.

Sign up for GitHub

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

Draft
nicosommi wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: correct Solo checkout example in affiliate keys docs #1019

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 12 additions & 9 deletions src/content/docs/tools/authorization/affiliate-keys.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,24 @@ Affiliate keys are not an authorization mechanism. Use them together with either

## Example Usage

The Solo Terminal API includes the Affiliate Key in the [Reader Checkout Request](https://developer.sumup.com/api/readers/create-checkout) under the affiliate section:
The Solo Terminal API includes the Affiliate Key in the [Reader Checkout Request](/api/readers/create-checkout/) under the `affiliate` object. This payload is for `POST /v0.1/merchants/{merchant_code}/readers/{reader_id}/checkout` (Cloud API), not for mobile SDKs.

- `app_id`: This is the aforementioned application ID.
- `key`: This is the Affiliate key unique to each account and mandatory for every merchant in their checkout requests.
- `app_id`: Application ID assigned to the Affiliate Key.
- `key`: Affiliate key for the partner account.
- `foreign_transaction_id`: Your unique transaction identifier (required when sending `affiliate`).

```json
{
"total_amount": {
"currency": "EUR",
"minor_unit": 2,
"value": 1000
},
"description": "Test Transaction",
"affiliate": {
"app_id": "your_application_id",
"key": "your_affiliate_key"
},
"checkout": {
"amount": 10.0,
"currency": "EUR",
"description": "Test Transaction"
"key": "your_affiliate_key",
"foreign_transaction_id": "your_unique_transaction_id"
}
}
```
Expand Down
Loading