getSmartVoucherInfo

You are able to fetch your Smart Voucher Information via this API.

GraphQL API

• Query String
  
  query getSmartVoucherInfo { me { token { vouchers { edges { node { id token { id } contractAddress transactionHash name description symbol decimals totalSupply proofOfContract { ipfs } liquid approveChecking price { numerator denominator } availableAmount vendible expiry consumable createdTime } } } } } }

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

  query getSmartVoucherInfo {   me {     token {       vouchers {         edges {           node {             id             token {               id             }             contractAddress             transactionHash             name             description             symbol             decimals             totalSupply             proofOfContract {               ipfs             }             liquid             approveChecking             price {               numerator               denominator             }             availableAmount             vendible             expiry             consumable             createdTime           }         }       }     }   } }

• HTTP Headers
  
  { "accept": "application/json", "content-type": "application/json", "authorization": "bearer [JWT Web-to-Server access token]" }

  1 2 3 4 5 6 7

  {   "accept": "application/json",   "content-type": "application/json",   "authorization": "bearer [JWT Web-to-Server access token]" }

HTTP Request and Response

Request

• URL
  • For development: https://test.fstk.io/api
  • For production: https://engine.fstk.io/api
• Method: POST
• Headers
  • accept: application/json
  • content-type: application/json
  • authorization: Bearer [JWT Web-to-Server access token]
    • (for example)
      
      Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6ImZzdGstZW5naW5lIn0.eyJ1aWQiOiLDr1xiw73Ch8KDSFx1MDAxMcOowo5awrvCqsOAXHUwMDAywrwmIiwiaWF0IjoxNTM4NzA5MDM2LCJleHAiOjE1Mzg3OTU0MzYsImF1ZCI6InVybjpmc3RrOmVuZ2luZSIsImlzcyI6InVybjpmc3RrOmVuZ2luZSIsInN1YiI6InVybjpmc3RrOmVuZ2luZTphY2Nlc3NfdG9rZW4ifQ.msJZ61FHIkKtjUpDs4sx1Kk1rb9vdhus3ntUDj6rHNmsygiHTgOEMQFJMtVqtWqkNgrtRgGpngq8Rf47xTT53g

      1 2 3

      Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6ImZzdGstZW5naW5lIn0.eyJ1aWQiOiLDr1xiw73Ch8KDSFx1MDAxMcOowo5awrvCqsOAXHUwMDAywrwmIiwiaWF0IjoxNTM4NzA5MDM2LCJleHAiOjE1Mzg3OTU0MzYsImF1ZCI6InVybjpmc3RrOmVuZ2luZSIsImlzcyI6InVybjpmc3RrOmVuZ2luZSIsInN1YiI6InVybjpmc3RrOmVuZ2luZTphY2Nlc3NfdG9rZW4ifQ.msJZ61FHIkKtjUpDs4sx1Kk1rb9vdhus3ntUDj6rHNmsygiHTgOEMQFJMtVqtWqkNgrtRgGpngq8Rf47xTT53g

• Body
  
  { "query":"{ me { token { vouchers { edges { node { id token { id } contractAddress transactionHash name description symbol decimals totalSupply proofOfContract { ipfs } liquid approveChecking price { numerator denominator } availableAmount vendible expiry consumable createdTime } } } } }}" }

  1 2 3 4 5

  {     "query":"{  me {    token {      vouchers {        edges {          node {            id            token {              id            }            contractAddress            transactionHash            name            description            symbol            decimals            totalSupply            proofOfContract {              ipfs            }            liquid            approveChecking            price {              numerator              denominator            }            availableAmount            vendible            expiry            consumable            createdTime          }        }      }    }  }}" }

  
  The value of query in the body is a String.

Response

Parameters

Response

• vouchers <VoucherConnection>
  • totalCount <Int!>
    • Total amount of the vouchers.
  • pageInfo <PageInfo>
    • Please refer to document of GraphQL
  • edges <[VoucherEdge]>
    • cursor <String!>
      • Please refer to document of GraphQL
    • node <Voucher>
      • id <ID!>
        • Smart Voucher ID. ID is a global identifier.
      • token<Token>
        • id <ID!>
          • ID of the Smart Token which the Smart Voucher . ID is a global identifier.
      • contractAddress <String!>
        • The Smart Voucher contract address.
      • transactionHash <String!>
        • Transaction hash of the Smart Voucher publishment.
      • name <String!>
        • Smart Voucher name.
      • description <String!>
        • Description of the Smart Voucher.
      • symbol <String!>
        • Smart Voucher symbol.
      • decimals <String!>
        • Smart Voucher decimals
      • totalSupply <String!>
        • Total supply of the Smart Voucher. The format is Decimaled Number.
      • proofOfContract <File!>
        • The PDF file of the Smart Voucher contract.
        • ipfs <String!>
          • Information of the contract’s ipfs link.
      • liquid <Boolean!>
        • The Smart Voucher is liquid or not.
      • price <Fraction!>
        • Smart Voucher price.
        • numerator <String!>
          • The numerator of this fraction.
        • denominator <String!>
          • The denominator of this fraction.
      • availableAmount <String!>
        • Remaining amount of the Smart Voucher. The format is Decimaled Number.
      • vendible <Boolean!>
        • The Smart Voucher is vendible or not.
      • expiry <String>
        • Expiry date of the Smart Voucher. The format is Unix Timestamp in millisecond resolution.
      • consumable <Boolean!>
        • The Smart Voucher is consumalbe or not.
      • createdTime <String!>
        • The Smart Voucher created time. The format is Unix Timestamp in millisecond resolution.