Spending Authorization (Allowance) API

This transaction is only available for ERC-20s and interfaces that extend ERC-20 such as ERC-1404. It is also available on all supported EVM chains that have equivalent interfaces such as Avalanche, Polygon, Binance Smart Chain, etc.

Validate funds for transaction

The allowance itself does not spend funds like a transfer does, however, there is still a fee associated. So before the tx takes place, you should estimate the fee & check the balance of the native currency on the blockchain of the currency you are authorizing someone else to spend. For example, if you would like to authorize your spouses wallet to spend 100 USDC on Ethereum from your wallet you need to pay the fee for that authorization in ETH.

Request fee estimate for a particular transaction

get

Authorizations

api-key-authjwt-access-token

Query parameters

assetSymbolstringRequired

Asset symbol

Example: ETH

transactionTypestring · enumOptional

The nature of the transaction on which a fee should be estimated for. By default TRANSFER_TX is used

Example: TRANSFER_TXAvailable options:

tokenTypestring · enumOptional

Optional value only used when dealing with non native assets (aka tokens), it can be ERC_20, BEP_20, ALGO_STANDARD, ALGO_APP. If native asset, keep the field empty

Example: ERC_20Available options:

originAddressstringRequired

Origin or spender address

Example: 0x6127DCB35b4625C2559526EEc22300c2Df804B5c

recipientAddressstringRequired

Recipient address

Example: 0x7cBc2e807d0191c5b9EA332CCec2423f8d72D626

amountnumberRequired

Transfer or allowance amount

Example: 100

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/transactions/estimate-fee?assetSymbol=text&originAddress=text&recipientAddress=text&amount=1 HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Fee estimate value was returned successfully

{
  "feePaymentSymbol": "ETH",
  "fee": 0.000121,
  "lowestFee": 0.0001,
  "highestFee": 0.0002
}

Fetch asset balance by specifying the asset address and the asset symbol

get

Authorizations

Query parameters

addressstringRequired

Asset valid address

Example: 0x9bf4001d307dfd62b26a2f1307ee0c0307632d59

assetSymbolstringRequired

Asset symbol, for instance: USDT, ETH, ALGO, etc, ...

Example: USDT

tokenStandardstring · enumOptional

Optional value only used when dealing with non native assets (aka tokens), it can be ERC_20, BEP_20, ALGO_STANDARD, ALGO_APP. If native asset, keep the field empty

Example: ERC_20Available options:

tokenTypestringRequired

Optional value only used when querying non native assets(tokens), it can be ERC_20, BEP_20, ALGO_STANDARD. If native asset, keep the field empty

Example: ERC_20

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/query/assets/balance?address=text&assetSymbol=text&tokenType=text HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "address": "0x9bf4001d307dfd62b26a2f1307ee0c0307632d59",
  "assetSymbol": "ETH",
  "tokenStandard": "ERC_20",
  "tokenType": "ERC_20",
  "balance": "181.2939",
  "lockedTokenBalance": "181.2939",
  "stakedBalance": "399.2",
  "claimableBalance": "1.3",
  "assetConfigId": "text",
  "balanceUpdatedAt": {}
}

Allowance

This is the transaction that actually authorizes the spending amount. As with other transactions, you should prepare the seed phrase for transport and provide details about the authorized spender address and the currency/amount that address is authorized to spend on your behalf.

Create an allowance for others to spend on your behalf

post

Authorizations

api-key-authjwt-access-token

Body

messagestringRequired

Message retrieved from the backend

Example: 717ea458b62a430cb37ced7c22ebec97

clientAuthPubKeystringRequiredExample: e3421d7f9d6888ea83bef6b28ce0a2ab6eb6fe8a8fbfa3743240992590816b08f9a62edcc63296d056c552054d583fec36d23ef11dffb24c95aaf4a47d50dccc

signaturestringRequired

Signature generated after signing the provided data field

Example: 0xb44e88ff3c67de6e6548a6caf006bf6e1cb841119d0b9ea1b7e9b2d36a5e0ed42fd9f5e543243d1d73dc4b7800cc2026f74961f4edc769699678a316abb34e661c

ownerAddressstringRequired

The owner's address

Example: 0x44Fa139F39D97b000cfAB1266ce8154782Bcef9D

spenderAddressstringRequired

The spender's address

Example: 0x44Fa139F39D97b000cfAB1266ce8154782Bcef9D

amountnumberRequired

The amount the owner wishes to allow the spender to spend

Example: 10

assetIdstringRequired

The asset ID for which you wish to specify an alloance

Example: ed378076-80c0-43ed-9914-5988e1abd748

contractAddressstringRequired

The asset contract address

Example: 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48

referencestringRequired

Transaction reference

Example: a4dedb83-4d59-41ca-84b5-4b24a98878d8

memostringRequired

Transaction memo or note

Example: Allowance for buying NOTE

encryptedSeedall ofRequired

Seed encrypted asymmetrically by current user corresponding wallaby auth public key, to be decrypted inside the secure code execution environment

Example: {"iv":"b7b643ebccf35c262aa2d5c2729c5f3d","ephemPublicKey":"040cff71ed16f1105c45c2214c9e72d3eabde48efe3759c6f150352b19aa8054c302dc1fd8b4f3927bd7d74ae0186854b3a13de7673be4f8424a6ba3702c239729","ciphertext":"736bc1881a02fa08df4a3f1e35d426660e3c35471facba2866e960f8a19b783bac30d037b07dc9e6406e258d09a4a7e4a7cf58d20cf7b8b7201db0f80849a48d20389039e3fc196f42796fe6d501f47afb030f9946ecbc148d8da1e46c3793a4","mac":"b6cbbdbbc3a311d919340fc3ec9ee1911d9ead6d989efa73e0ac3303c51a353e"}

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /api/v1/transactions/create-allowance HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1182

{
  "message": "717ea458b62a430cb37ced7c22ebec97",
  "clientAuthPubKey": "e3421d7f9d6888ea83bef6b28ce0a2ab6eb6fe8a8fbfa3743240992590816b08f9a62edcc63296d056c552054d583fec36d23ef11dffb24c95aaf4a47d50dccc",
  "signature": "0xb44e88ff3c67de6e6548a6caf006bf6e1cb841119d0b9ea1b7e9b2d36a5e0ed42fd9f5e543243d1d73dc4b7800cc2026f74961f4edc769699678a316abb34e661c",
  "ownerAddress": "0x44Fa139F39D97b000cfAB1266ce8154782Bcef9D",
  "spenderAddress": "0x44Fa139F39D97b000cfAB1266ce8154782Bcef9D",
  "amount": 10,
  "assetId": "ed378076-80c0-43ed-9914-5988e1abd748",
  "contractAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "reference": "a4dedb83-4d59-41ca-84b5-4b24a98878d8",
  "memo": "Allowance for buying NOTE",
  "encryptedSeed": "{\"iv\":\"b7b643ebccf35c262aa2d5c2729c5f3d\",\"ephemPublicKey\":\"040cff71ed16f1105c45c2214c9e72d3eabde48efe3759c6f150352b19aa8054c302dc1fd8b4f3927bd7d74ae0186854b3a13de7673be4f8424a6ba3702c239729\",\"ciphertext\":\"736bc1881a02fa08df4a3f1e35d426660e3c35471facba2866e960f8a19b783bac30d037b07dc9e6406e258d09a4a7e4a7cf58d20cf7b8b7201db0f80849a48d20389039e3fc196f42796fe6d501f47afb030f9946ecbc148d8da1e46c3793a4\",\"mac\":\"b6cbbdbbc3a311d919340fc3ec9ee1911d9ead6d989efa73e0ac3303c51a353e\"}"
}

200

Allowance has been created successfully

{
  "transaction": {
    "reference": "text",
    "hash": "text",
    "userId": "text",
    "merchantId": "text",
    "userEmail": "text",
    "chainId": "text",
    "chainName": "text",
    "chainSlip44": 1,
    "fromWalletId": "text",
    "fromAddress": "text",
    "toWalletId": "text",
    "toAddress": "text",
    "assetId": "text",
    "assetSymbol": "text",
    "tokenType": "text",
    "amount": "text",
    "fee": "text",
    "note": "text",
    "nonce": 1,
    "gasPrice": 1,
    "submitter": "text",
    "status": "text",
    "ownershipType": "text",
    "multisigVersion": 1,
    "multisigSignerThreshold": 1,
    "multisigSignerApprovedCount": 1,
    "txBlob": "text",
    "multisigParticipants": [
      {
        "transactionId": "text",
        "userAddress": "text",
        "userId": "text",
        "chainId": "text",
        "chainName": "text",
        "assetId": "text",
        "assetName": "text",
        "assetSymbol": "",
        "status": "pending-approval",
        "transaction": "[Circular Reference]",
        "user": {
          "id": "text",
          "externalUserId": "6e464058-67c1-4273-a6a4-8aae522e34be",
          "merchantId": "6e464058-67c1-4273-a6a4-8aae522e34be",
          "role": "republic_admin",
          "firstName": "Bryan",
          "walletsCount": 2,
          "latestWallabyAuthPubKey": "4ecb720b1392468c75803d6252ac987c113206955070b96df1208c1c480338168e1407cec4b5af2f91d12af9b725cbd85af994b29c6364971a7ef8d955be83dc",
          "latestWallabyAuthPubKeyVersion": "1",
          "hasFullPermissions": true
        }
      }
    ],
    "merchant": {
      "name": "Republic",
      "nameSlugify": "republic",
      "verified": true,
      "contactEmail": "[email protected]",
      "contactPhoneNumber": "text",
      "usersCount": 1,
      "assetsCount": 1,
      "tokensCount": 1,
      "coinsCount": 1,
      "walletsCount": 1,
      "status": "active",
      "createdAt": "2025-04-24T06:51:46.585Z",
      "updatedAt": "2025-04-24T06:51:46.585Z",
      "createdAssets": [
        []
      ]
    }
  }
}