Buy/Checkout API

Enables buy or checkout usecase based on the request.

Scenarios	API Response
Users have TokenA on ChainA	Calldata generated for Direct Transfer
Users have TokenB on ChainA	Calldata generated for Swap on ChainA
Users have TokenA on ChainB	Calldata generated for bridging TokenA from ChainB to ChainA
Users have TokenB on ChainB	Calldata generated for swapping and bridging the TokenB from ChainB to TokenA on ChainA.

Steps to follow:

1. Check Supported Tokens and Chains

   • Before initiating a transaction, verify if the token and chain are supported by Aarc using the v3/supported-chains and v3/supported-tokens endpoints. This ensures compatibility with the Aarc system.

GET/v3/supported-chains

Response

200

List of supported chains

Body

application/json

chainIdinteger

namestring

nativeCurrencyobject

rpcUrlsarray of string

Request

JavaScriptCurlPython

const response = await fetch('/v3/supported-chains', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "chainId": 0,
    "name": "text",
    "nativeCurrency": {
      "symbol": "text",
      "decimals": 0
    },
    "rpcUrls": [
      "text"
    ]
  }
]

GET/v3/supported-tokens

Query parameters

Response

200

List of supported tokens

Body

application/json

symbolstring

namestring

addressstring

decimalsinteger

Request

JavaScriptCurlPython

const response = await fetch('/v3/supported-tokens', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "symbol": "text",
    "name": "text",
    "address": "text",
    "decimals": 0
  }
]

1. Generate Deposit Address

• Use the deposit-address endpoint to:

  • Obtain a precise quote for the requested buy/checkout parameters.

  • Determine if the current configuration is viable.

  • Receive deposit parameters and a requestId for tracking purposes.

GET/deposit-address

Query parameters

Response

200

Deposit address details

Body

application/json

requestIdstring

statusstring

depositAddressstring

onChainIDstring

depositTokenNamestring

depositTokenSymbolstring

depositTokenAddressstring

depositTokenDecimalsstring

depositTokenUsdPricenumber

amountstring

executionTimestring

gasFeestring

txDataobject

Request

JavaScriptCurlPython

const response = await fetch('/deposit-address?destinationChainId=text&destinationTokenAddress=text&toAmount=text&destinationRecipient=text&transferType=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "requestId": "text",
  "status": "text",
  "depositAddress": "text",
  "onChainID": "text",
  "depositTokenName": "text",
  "depositTokenSymbol": "text",
  "depositTokenAddress": "text",
  "depositTokenDecimals": "text",
  "depositTokenUsdPrice": 0,
  "amount": "text",
  "executionTime": "text",
  "gasFee": "text"
}

1. Transaction Notification for Transfers from EOAs

• If transferring funds from an Externally Owned Account (EOA), inform the Aarc system by calling the schedule-transaction endpoint. Provide transaction details along with the requestId.

POST/v3/schedule-transaction

Body

application/json

fromAddressstring

toAddressstring

tokenstring

amountstring

scheduleTimestring (date-time)

Response

201

Transaction scheduled successfully

Body

application/json

transactionIdstring

statusstring

Request

JavaScriptCurlPython

const response = await fetch('/v3/schedule-transaction', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "transactionId": "text",
  "status": "text"
}

1. Track Transaction Status

• Use the request-status endpoint to monitor the progress of your transaction. The endpoint returns detailed information about the transaction state, allowing for real-time tracking.

GET/v3/request-status/{requestId}

Path parameters

requestId*string

Response

200

Request status

Body

application/json

requestIdstring

statusstring

transactionStepsarray of object

Request

JavaScriptCurlPython

const response = await fetch('/v3/request-status/{requestId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "requestId": "text",
  "status": "text",
  "transactionSteps": []
}