Skip to content
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

Jump to bottom

adding docs about how toggle linking works for custodians #1576

Merged
merged 1 commit into from
Sep 1, 2022
Merged

adding docs about how toggle linking works for custodians #1576

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
54 changes: 54 additions & 0 deletions services/wallet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,57 @@ To provide BAT-Wallet API.
### to run

go run ../main.go serve wallet rest

## Custodian Linking Toggle

We have the ability to turn off/on individually custodial linking capabilities
for rewards wallets. The following response can be expected for each of the
custodian linking endpoints if we have administratively turned off linking capabilities.

### Uphold Linking Toggle

```
POST /v3/wallet/uphold/<payment_id>/claim
...

HTTP2/0 400 Bad Request
{
"message": "Error validating Connecting Brave Rewards to Uphold is temporarily unavailable. Please try again later",
"code": 400,
"data": {
"validationErrors": null
}
}
```

### Gemini Linking Toggle

```
POST /v3/wallet/gemini/<payment_id>/claim
...

HTTP2/0 400 Bad Request
{
"message": "Error validating Connecting Brave Rewards to Gemini is temporarily unavailable. Please try again later",
"code": 400,
"data": {
"validationErrors": null
}
}
```

### Bitflyer Linking Toggle

```
POST /v3/wallet/bitflyer/<payment_id>/claim
...

HTTP2/0 400 Bad Request
{
"message": "Error validating Connecting Brave Rewards to Bitflyer is temporarily unavailable. Please try again later",
"code": 400,
"data": {
"validationErrors": null
}
}
```