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. 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

/v3/deposit-address

Query parameters

destinationChainIdstringrequired

destinationTokenAddressstringrequired

toAmountstringrequired

destinationRecipientstringrequired

transferTypestring · enumrequired

Options: onramp, cex, wallet

routeTypestring · enum

Options: time, fee, value

fromChainIdstring

fromTokenAddressstring

fromAddressstring

slippagestring

transferOutobject[]

targetCalldatastring

gasLimitstring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v3/deposit-address?destinationChainId=text&destinationTokenAddress=text&toAmount=text&destinationRecipient=text&transferType=onramp' \
  --header 'x-api-key: text'

200

200

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

Deposit address details

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

Header parameters

x-api-keystringrequired

Body

fromAddressstring

toAddressstring

tokenstring

amountstring

scheduleTimestring · date-time

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v3/schedule-transaction' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json'

201

201

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

Transaction scheduled successfully

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

requestIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v3/request-status/{requestId}' \
  --header 'x-api-key: text'

200

200

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

Request status

1. Check Supported Tokens and Chains (optional)

• 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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v3/supported-chains'

200

200

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

List of supported chains

get

/v3/supported-tokens

Query parameters

chainIdnumber

symbolstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v3/supported-tokens'

200

200

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

List of supported tokens