TokenOS
  • Overview
    • Introduction
    • Authentication
    • User & Wallet Identification
    • Errors
    • Versioning
  • Guides
    • How our system works
    • Rewarding your audience
      • In exchange for completing an incentive
      • In exchange for your own points
      • As a credit
  • Wallet API
    • Balances
    • Allocations
  • Management API
    • Token Selection
    • Campaigns
    • Subscriptions
    • Codes
  • Payments API
    • Introduction
    • Payments
    • Deliveries
    • Relayer
Powered by GitBook
On this page
  1. Payments API

Deliveries

PreviousPaymentsNextRelayer

Last updated 2 years ago

Delivery requests allow you to airdrop $TOKENs directly to your users' wallets, and be notified when it's done.

How are Deliveries different than Allocations?

The delivery system differs from the allocation system in that it is designed to deliver $TOKENs on a per-transaction basis, rather than in batches.

Conversion Rate

Similar to payment requests, delivery requests can also save an arbitrary conversion rate. This can be especially useful if you need to lock in a specific exchange rate for a particular transaction.

Get a delivery request information and status

get
Authorizations
Path parameters
requestIdstringRequired
Responses
200
Delivery request information
application/json
Responseobject
get
GET /v1/deliveries/{requestId} HTTP/1.1
Host: localhost:8080
Accept: */*
200

Delivery request information

{}
  • POSTCreate a new delivery request
  • GETGet a delivery request information and status
  • Conversion Rate

Create a new delivery request

post
Authorizations
Body
objectOptional
Responses
200
Created
application/json
Responseobject
post
POST /v1/deliveries HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Created

{}