MyWay
  • Overview
    • Welcome to MyWay!
  • Integration
    • Onboarding
    • Quick Start
  • API Reference
    • Introduction
    • Authorization
    • Checking Account
    • Payment Link
    • Transaction
    • Benefits
    • Community Tokens
    • Cards
  • Extras
    • Contact
    • SDK Reference
    • FAQ
Powered by GitBook
On this page
  1. API Reference

Benefits

Here is where all the Benefits are gonna be managed

PreviousTransactionNextCommunity Tokens

Last updated 2 years ago

Create an Benefit

Get detailed Benefit info

List Benefits

Check if a user has access to your Benefits

Update an Benefit

Remove an Benefit

get
Authorizations
Path parameters
idstringRequired
Responses
get
GET /api/v1/benefit/{id}/manage HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
No content
get
Authorizations
Query parameters
takenumberOptionalDefault: 36
skipnumberOptionalDefault: 0
Responses
get
GET /api/v1/benefit/manage HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
No content
delete
Authorizations
Path parameters
idstringRequired
Responses
delete
DELETE /api/v1/benefit/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
No content
  • Create an Benefit
  • POST/api/v1/benefit
  • Get detailed Benefit info
  • GET/api/v1/benefit/{id}/manage
  • List Benefits
  • GET/api/v1/benefit/manage
  • Check if a user has access to your Benefits
  • POST/api/v1/benefit/check/manage
  • Update an Benefit
  • PATCH/api/v1/benefit/{id}
  • Remove an Benefit
  • DELETE/api/v1/benefit/{id}
post
Authorizations
Body
namestringRequired

Name of the benefit

discountPercentagenumber · min: 100 · max: 10000Optional

Discount percentage multiplied by 100. Therefore, to create a benefit that gives a 10% discount, an input of 1000 is required for this property

givesWhitelistAccessbooleanRequired

If this benefit gives whitelist access

maxUsageLimitnumberRequired

The max amount of times this benefit can be used by a user

Responses
post
POST /api/v1/benefit HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "name": "text",
  "discountPercentage": 1,
  "givesWhitelistAccess": true,
  "maxUsageLimit": 1
}
201Success
No content
post
Authorizations
Body
userWalletsstring[]Required

Array of wallets that are gonna be checked to see if they have access to a benefit

Responses
application/json
objectOptional
post
POST /api/v1/benefit/check/manage HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "userWallets": [
    "text"
  ]
}
201Success
{}
patch
Authorizations
Path parameters
idstringRequired
Body
namestringOptional

Name of the benefit

discountPercentagenumberOptional

Discount percentage multiplied by 100. Therefore, to create a benefit that gives a 10% discount, an input of 1000 is required for this property

givesWhitelistAccessbooleanRequired

If this benefit gives whitelist access

Responses
patch
PATCH /api/v1/benefit/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "name": "text",
  "discountPercentage": 1,
  "givesWhitelistAccess": true
}
200Success
No content