API Reference

This document describes the public and API-key authenticated endpoints of the AzothPay API

Get list of available contracts

get

Returns a list of all available smart contracts

Responses

200

Success

application/json

get

/api/v1/contracts/

HTTPcURLJavaScriptPython

GET /api/v1/contracts/ HTTP/1.1
Host: azothpay.com
Accept: */*

200

Success

[
  {
    "name": "text",
    "address": "text"
  }
]

API information and status

get

Returns information about the API and the status of smart contracts

Responses

200

Success

application/json

get

/api/v1/contracts/api-info

HTTPcURLJavaScriptPython

GET /api/v1/contracts/api-info HTTP/1.1
Host: azothpay.com
Accept: */*

200

Success

{
  "message": "text",
  "contracts": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Cancel subscription for a specific contract

delete

Cancel an existing subscription to an author

Authorizations

ApiKey

X-API-KeystringRequired

API Key Authentication. Example: "X-API-Key: {api_key}"

Path parameters

contractstringRequired

authorstringRequired

Query parameters

Fromstring | nullableOptional

Sponsorstring | nullableOptional

Responses

200

Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

delete

/api/v1/{contract}/subscriptions/{author}

HTTPcURLJavaScriptPython

DELETE /api/v1/{contract}/subscriptions/{author} HTTP/1.1
Host: azothpay.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "message": "text",
  "transaction": {
    "from": "text",
    "to": "text",
    "data": "text",
    "gas": 1,
    "value": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Create new payment stream/subscription for a specific contract

post

Create a new subscription/payment stream to an author

Authorizations

ApiKey

X-API-KeystringRequired

API Key Authentication. Example: "X-API-Key: {api_key}"

Path parameters

contractstringRequired

Body

application/json

fromstringOptional

authorstringOptional

subscriptionRatestringOptional

projectIdstringOptional

sponsorstring | nullableOptional

Responses

200

Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/api/v1/{contract}/subscriptions/

HTTPcURLJavaScriptPython

POST /api/v1/{contract}/subscriptions/ HTTP/1.1
Host: azothpay.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "from": "text",
  "author": "text",
  "subscriptionRate": "text",
  "projectId": "text",
  "sponsor": "text"
}

{
  "message": "text",
  "transaction": {
    "from": "text",
    "to": "text",
    "data": "text",
    "gas": 1,
    "value": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

List user's active subscriptions for a specific contract

get

Retrieve a list of all active subscriptions for a user

Authorizations

ApiKey

X-API-KeystringRequired

API Key Authentication. Example: "X-API-Key: {api_key}"

Path parameters

contractstringRequired

addressstringRequired

Responses

200

Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/api/v1/{contract}/subscriptions/{address}

HTTPcURLJavaScriptPython

GET /api/v1/{contract}/subscriptions/{address} HTTP/1.1
Host: azothpay.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "address": "text",
  "subscriptions": [
    {
      "to": "text",
      "incomeRate": 1,
      "outgoingRate": 1,
      "incomeRateRaw": {
        "IsPowerOfTwo": true,
        "IsZero": true,
        "IsOne": true,
        "IsEven": true,
        "Sign": 1,
        "_sign": 1,
        "_bits": [
          1
        ]
      },
      "outgoingRateRaw": {
        "IsPowerOfTwo": true,
        "IsZero": true,
        "IsOne": true,
        "IsEven": true,
        "Sign": 1,
        "_sign": 1,
        "_bits": [
          1
        ]
      }
    }
  ]
}

Deposit funds to user account

post

Deposit funds to a user's account

Authorizations

ApiKey

X-API-KeystringRequired

API Key Authentication. Example: "X-API-Key: {api_key}"

Path parameters

contractstringRequired

Body

application/json

Request model for depositing funds into the system

fromstring · min: 1Required

Ethereum address to deposit funds from

amountstring · min: 1Required

Amount to deposit

isPermit2boolean | nullableOptional

Whether to use Permit2 for token approval

sponsorstring | nullableOptional

Optional sponsor address that pays for gas fees

Responses

200

Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/api/v1/{contract}/payments/deposit

HTTPcURLJavaScriptPython

POST /api/v1/{contract}/payments/deposit HTTP/1.1
Host: azothpay.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "from": "text",
  "amount": "text",
  "isPermit2": true,
  "sponsor": "text"
}

{
  "message": "text",
  "transaction": {
    "from": "text",
    "to": "text",
    "data": "text",
    "gas": 1,
    "value": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "from": "text",
  "amount": "text",
  "isPermit2": true,
  "sponsor": "text"
}

Get user account balance

get

Retrieve the balance of a user's account

Authorizations

ApiKey

X-API-KeystringRequired

API Key Authentication. Example: "X-API-Key: {api_key}"

Path parameters

contractstringRequired

addressstringRequired

Responses

200

Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/api/v1/{contract}/payments/balance/{address}

HTTPcURLJavaScriptPython

GET /api/v1/{contract}/payments/balance/{address} HTTP/1.1
Host: azothpay.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "address": "text",
  "balance": "text"
}

Make a one-time payment

post

Create a transaction to make a one-time payment to another user. This endpoint supports sponsored transactions where gas fees can be paid by the recipient. The sponsor must be either the sender or receiver of the payment. All addresses must be valid Ethereum addresses (42 characters starting with 0x).

Authorizations

ApiKey

X-API-KeystringRequired

API Key Authentication. Example: "X-API-Key: {api_key}"

Path parameters

contractstringRequired

Body

application/json

Request model for making a payment transaction

fromstring · min: 1Required

Ethereum address of the sender

tostring · min: 1Required

Ethereum address of the recipient

amountstring · min: 1Required

Amount to be transferred (in wei for ETH)

sponsorstring | nullableOptional

Optional sponsor address that pays for gas fees. Must be either the sender or receiver.

Responses

200

Successfully prepared payment transaction

application/json

400

Bad Request - Invalid parameters or addresses

401

Unauthorized - Invalid API key

403

Forbidden

500

Internal Server Error

post

/api/v1/{contract}/payments/

HTTPcURLJavaScriptPython

POST /api/v1/{contract}/payments/ HTTP/1.1
Host: azothpay.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "from": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
  "to": "0x8ba1f109551bD432803012645Hacab3dF0cDeaC1",
  "amount": "1000000000000000000",
  "sponsor": "0x8ba1f109551bD432803012645Hacab3dF0cDeaC1"
}

{
  "message": "text",
  "transaction": {
    "from": "text",
    "to": "text",
    "data": "text",
    "gas": 1,
    "value": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "from": "text",
  "to": "text",
  "amount": "text",
  "sponsor": "text"
}

Withdraw funds from user account

post

Withdraw funds from a user's account

Authorizations

ApiKey

X-API-KeystringRequired

API Key Authentication. Example: "X-API-Key: {api_key}"

Path parameters

contractstringRequired

Body

application/json

Request model for withdrawing funds from the system

fromstring · min: 1Required

Ethereum address to withdraw funds from

amountstring · min: 1Required

Amount to withdraw

tostring · min: 1Required

Ethereum address to withdraw funds to

sponsorstring | nullableOptional

Optional sponsor address that pays for gas fees

Responses

200

Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/api/v1/{contract}/payments/withdraw

HTTPcURLJavaScriptPython

POST /api/v1/{contract}/payments/withdraw HTTP/1.1
Host: azothpay.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "from": "text",
  "amount": "text",
  "to": "text",
  "sponsor": "text"
}

{
  "message": "text",
  "transaction": {
    "from": "text",
    "to": "text",
    "data": "text",
    "gas": 1,
    "value": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "from": "text",
  "amount": "text",
  "to": "text",
  "sponsor": "text"
}

Execute a meta transaction using a signature from the user

post

Execute a meta transaction that has been signed by the user

Authorizations

ApiKey

X-API-KeystringRequired

API Key Authentication. Example: "X-API-Key: {api_key}"

Path parameters

contractstringRequired

Body

application/json

fromstring · min: 1Required

signaturestring · min: 1Required

datastring · min: 1Required

nonceinteger · int32Required

sponsorstring | nullableOptional

deadlineinteger · int64 | nullableOptional

Responses

200

Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/api/v1/{contract}/meta/execute

HTTPcURLJavaScriptPython

POST /api/v1/{contract}/meta/execute HTTP/1.1
Host: azothpay.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "from": "text",
  "signature": "text",
  "data": "text",
  "nonce": 1,
  "sponsor": "text",
  "deadline": 1
}

{
  "message": "text",
  "from": "text",
  "transactionHash": "text",
  "gasUsed": 1
}

Get the current nonce for an account

get

Retrieve the current nonce value for a specific account

Authorizations

ApiKey

X-API-KeystringRequired

API Key Authentication. Example: "X-API-Key: {api_key}"

Path parameters

contractstringRequired

accountstringRequired

Responses

200

Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/api/v1/{contract}/meta/nonce/{account}

HTTPcURLJavaScriptPython

GET /api/v1/{contract}/meta/nonce/{account} HTTP/1.1
Host: azothpay.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "account": "text",
  "nonce": 1
}

Create multiple subscriptions in one sponsored call

post

Create multiple subscriptions in a single transaction

Authorizations

ApiKey

X-API-KeystringRequired

API Key Authentication. Example: "X-API-Key: {api_key}"

Path parameters

contractstringRequired

Body

application/json

fromstring · min: 1Required

sponsorstring | nullableOptional

Responses

200

Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/api/v1/{contract}/batch/subscriptions

HTTPcURLJavaScriptPython

POST /api/v1/{contract}/batch/subscriptions HTTP/1.1
Host: azothpay.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "from": "text",
  "subscriptions": [
    {
      "author": "text",
      "subscriptionRate": "text",
      "projectId": "text"
    }
  ],
  "sponsor": "text"
}

{
  "message": "text",
  "transaction": {
    "from": "text",
    "to": "text",
    "data": "text",
    "gas": 1,
    "value": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "from": "text",
  "count": 1,
  "sponsor": "text"
}

Process batch payments to multiple recipients

post

Process multiple payments to different recipients in a single transaction

Authorizations

ApiKey

X-API-KeystringRequired

API Key Authentication. Example: "X-API-Key: {api_key}"

Path parameters

contractstringRequired

Body

application/json

fromstring · min: 1Required

sponsorstring | nullableOptional

Responses

200

Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/api/v1/{contract}/batch/payments

HTTPcURLJavaScriptPython

POST /api/v1/{contract}/batch/payments HTTP/1.1
Host: azothpay.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "from": "text",
  "payments": [
    {
      "to": "text",
      "amount": "text"
    }
  ],
  "sponsor": "text"
}

{
  "message": "text",
  "transaction": {
    "from": "text",
    "to": "text",
    "data": "text",
    "gas": 1,
    "value": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "from": "text",
  "count": 1,
  "sponsor": "text"
}