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

Community Tokens

This is where you're gonna create and manage the tokens that give access to your Benefits

PreviousBenefitsNextCards

Last updated 2 years ago

Create a Community Token

Get detailed Community Token info

List Community Tokens

Update an Community Token

Remove an Community Token

Associate a Community Token to a Benefit

Disassociate a Community Token from a Benefit

get
Authorizations
Path parameters
idstringRequired
Responses
get
GET /api/v1/community-token/{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/community-token/manage HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
No content
delete
Authorizations
Path parameters
idstringRequired
Responses
delete
DELETE /api/v1/community-token/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
No content
  • Create a Community Token
  • POST/api/v1/community-token
  • Get detailed Community Token info
  • GET/api/v1/community-token/{id}/manage
  • List Community Tokens
  • GET/api/v1/community-token/manage
  • Update an Community Token
  • PATCH/api/v1/community-token/{id}
  • Remove an Community Token
  • DELETE/api/v1/community-token/{id}
  • Associate a Community Token to a Benefit
  • POST/api/v1/community-token/{id}/add/benefit
  • Disassociate a Community Token from a Benefit
  • POST/api/v1/community-token/{id}/remove/benefit
post
Authorizations
Body
namestringRequired

Name of the token collection

contractAddressstringRequired

Address of the token contract from which this Community token will be associated with

startTokenIdstring | nullableOptional

The initial blockchain id from the range that will be associated with this Community Token

endTokenIdstring | nullableOptional

The final blockchain id from the range that will be associated with this Community Token

networkstring ยท enumRequired

Network where the contractAddress was deployed

Available options:
Responses
post
POST /api/v1/community-token HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "name": "text",
  "contractAddress": "text",
  "startTokenId": "text",
  "endTokenId": "text",
  "network": "ethereum_mainnet"
}
201Success
No content
patch
Authorizations
Path parameters
idstringRequired
Body
namestringOptional

Name of the token collection

contractAddressstringOptional

Address of the token contract from which this Community token will be associated with

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

{
  "name": "text",
  "contractAddress": "text",
  "benefitsHasCommunityToken": {}
}
200Success
No content
post
Authorizations
Path parameters
idstringRequired
Body
benefitIdsstring[]Required

An array containing all the benefitIds that will be updated (added or removed) in relation to the Community Token

Responses
application/json
object[]Optional
post
POST /api/v1/community-token/{id}/add/benefit HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "benefitIds": [
    "text"
  ]
}
201Success
[
  {}
]
post
Authorizations
Path parameters
idstringRequired
Body
benefitIdsstring[]Required

An array containing all the benefitIds that will be updated (added or removed) in relation to the Community Token

Responses
post
POST /api/v1/community-token/{id}/remove/benefit HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "benefitIds": [
    "text"
  ]
}
201Success
No content