Transfer API

In order to transfer assets from one wallet to another you will need to...

1. calculate whether the user has enough funds after fees

2. check any restrictions on transfer

3. actually trigger the transfer

Validate funds for transaction

In order to ensure the transaction goes through successfully, check the user's balance as close as possible to the actual point in which the transaction is triggered. With the latest balance determine how much the user intends to send, estimate the fee amount, and then validate whether the user has enough balance to cover both.

The fee is always estimated in the the native blockchain currency. So for example, a USDC transfer will have an ETH fee so the balance for both need to be c

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": {}
}

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
}

Validate restrictions for transfer

Some asset types have unique restrictions. In these cases, we give you the option to check these restrictions BEFORE sending the transaction which will prevent your end user from submitting failed transactions and losing out on fee money.

Algorand Standard Assets

Every Algorand Standard Asset (any asset other than Algo itself) requires the user to opt in before it is received. You can check if the end recipient of the transfer is opted in. If they are not and that recipient is in your ecosystem, you could inform them that they are not opted in and allow them to do so as described in Algorand Opt In.

Get the list of all assets that the current account has opted into. This is only relevant for the Algorand chain

get

Authorizations

Query parameters

addressstringRequired

The address of the account that is being checked for optin status on particular assets or apps

Example: KFMRQHJVVONKOLXTEQ33CNUQZ4NBGU2EDCE25KNKVMRYPRKLKCNQDAWWTM

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/transactions/check-asset-optin?address=text HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Returns list of assets opted into

No content

ERC-1404s and EVM equivalents

ERC-1404s and their equivalents on other chains are customized to have their own transfer restrictions. For example, an address may be restricted from sending until a certain date or limited to a certain group of addresses. You can preemptively detect any restrictions on the current inputs and show what those restrictions actually are using the endpoints below.

Request to detect whether there is a transfer restriction on a particular transaction

get

Authorizations

Query parameters

fromAddressstringRequired

Origin address

Example: 0x9bf4001d307dfd62b26a2f1307ee0c0307632d59

toAddressstringRequired

Recipient address

Example: 0xb44e88ff3c67de6e6548a6caf006bf6e1cb84111

valuestringRequired

value being sent

Example: 109203.1281

assetIdstringRequired

Asset ID inside wallaby system

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

tokenContractAddressstringOptional

Optional ERC1404 token contract address on chain, when this is supplied, the assetId field will be ignored

Example: 0x28aef3b18daec312860dd030102a427ed43dac71

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/transactions/detect-transfers-restrictions?fromAddress=text&toAddress=text&value=text&assetId=text HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Restriction info returned successfully

{
  "canTransfer": true,
  "restrictionCodeMessage": "SUCCESS",
  "tokenContractAddress": "0xb44e88ff3c67de6e6548a6caf006bf6e1cb84111",
  "fromAddress": "0x9bf4001d307dfd62b26a2f1307ee0c0307632d59",
  "toAddress": "0xb44e88ff3c67de6e6548a6caf006bf6e1cb84111",
  "value": "109203.1281",
  "assetId": "ed378076-80c0-43ed-9914-5988e1abd748"
}

Request restriction message by providing a restriction code

get

Authorizations

Query parameters

restrictionCodenumberRequired

Restriction code to be interpreted by the API, by reading data from the contract

Example: 0

assetIdstringRequired

Asset ID inside wallaby system

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

tokenContractAddressstringOptional

Optional ERC1404 token contract address on chain, when this is supplied, the assetId field will be ignored

Example: 0x28aef3b18daec312860dd030102a427ed43dac71

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/transactions/transfer-restriction-message?restrictionCode=1&assetId=text HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Restriction message info returned successfully

{
  "restrictionCode": 0,
  "restrictionCodeMessage": "SUCCESS"
}

Conducting the transfer

Once all checks are confirmed you can trigger the transfer by sending along the seed phrase with transaction details as described in

Request transferring funds to a recipient address

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

originAddressstringRequired

Origin address

Example: 0x6127DCB35b4625C2559526EEc22300c2Df804B5c

recipientAddressstringRequired

Recipient address

Example: 0x7cBc2e807d0191c5b9EA332CCec2423f8d72D626

assetIdstringRequired

Asset Wallaby UUID

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

amountnumberRequired

Transfer amount

Example: 100

referencestringRequired

Transaction reference

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

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"}

memostringRequired

Transaction memo or note

Example: Hello 1282991

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

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

{
  "message": "717ea458b62a430cb37ced7c22ebec97",
  "clientAuthPubKey": "e3421d7f9d6888ea83bef6b28ce0a2ab6eb6fe8a8fbfa3743240992590816b08f9a62edcc63296d056c552054d583fec36d23ef11dffb24c95aaf4a47d50dccc",
  "signature": "0xb44e88ff3c67de6e6548a6caf006bf6e1cb841119d0b9ea1b7e9b2d36a5e0ed42fd9f5e543243d1d73dc4b7800cc2026f74961f4edc769699678a316abb34e661c",
  "originAddress": "0x6127DCB35b4625C2559526EEc22300c2Df804B5c",
  "recipientAddress": "0x7cBc2e807d0191c5b9EA332CCec2423f8d72D626",
  "assetId": "a4dedb83-4d59-41ca-84b5-4b24a98878d8",
  "amount": 100,
  "reference": "a4dedb83-4d59-41ca-84b5-4b24a98878d8",
  "encryptedSeed": "{\"iv\":\"b7b643ebccf35c262aa2d5c2729c5f3d\",\"ephemPublicKey\":\"040cff71ed16f1105c45c2214c9e72d3eabde48efe3759c6f150352b19aa8054c302dc1fd8b4f3927bd7d74ae0186854b3a13de7673be4f8424a6ba3702c239729\",\"ciphertext\":\"736bc1881a02fa08df4a3f1e35d426660e3c35471facba2866e960f8a19b783bac30d037b07dc9e6406e258d09a4a7e4a7cf58d20cf7b8b7201db0f80849a48d20389039e3fc196f42796fe6d501f47afb030f9946ecbc148d8da1e46c3793a4\",\"mac\":\"b6cbbdbbc3a311d919340fc3ec9ee1911d9ead6d989efa73e0ac3303c51a353e\"}",
  "memo": "Hello 1282991"
}

200

Transfer transaction was broad-casted 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:37:01.136Z",
      "updatedAt": "2025-04-24T06:37:01.136Z",
      "createdAssets": [
        []
      ]
    }
  },
  "message": "text"
}