Swap

Swap endpoints for exchanging between different stablecoin assets

Get swap quote

post

Get a real-time quote for swapping between two stablecoin assets including exchange rate and fees.

Authorizations

ServiceKey

Body

application/json

amountnumberRequired

from_assetstring · enumRequiredPossible values:

to_assetstring · enumRequiredPossible values:

exact_outputbooleanOptionalDefault: false

developer_feenumber · max: 100Optional

Optional developer fee percentage (0-100)

Responses

200

Successfully retrieved swap quote

application/json

400

Bad request - Invalid input parameters or validation error

application/json

post

/swap/quote

HTTPcURLJavaScriptPython

POST /swap/quote HTTP/1.1
Host: api.onswitch.xyz
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "amount": 100,
  "from_asset": "base:usdc",
  "to_asset": "solana:usdt",
  "exact_output": false,
  "developer_fee": 0.5
}

{
  "success": true,
  "message": "Swap quote fetched successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": {
    "expiry": "2024-01-01T00:15:00.000Z",
    "settlement": "Instant",
    "channel": "BLOCKCHAIN",
    "rate": 1,
    "fee": {
      "total": 0.5,
      "platform": 0.45,
      "developer": 0.05,
      "currency": "USDC"
    },
    "fee_inclusive": true,
    "source": {
      "amount": 100,
      "currency": "USDC"
    },
    "destination": {
      "amount": 99.5,
      "currency": "USDT"
    }
  }
}

Initiate swap transaction

post

Initiate a swap transaction between two stablecoin assets.

Authorizations

ServiceKey

Body

application/json

amountnumberRequired

from_assetstring · enumRequiredPossible values:

to_assetstring · enumRequiredPossible values:

exact_outputbooleanOptionalDefault: false

callback_urlstring · uriOptional

referencestring · uuidOptional

developer_feenumber · max: 100Optional

Optional developer fee percentage (0-100)

Responses

200

Successfully initiated swap transaction

application/json

400

Bad request - Invalid input parameters or validation error

application/json

post

/swap/initiate

HTTPcURLJavaScriptPython

POST /swap/initiate HTTP/1.1
Host: api.onswitch.xyz
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "amount": 100,
  "from_asset": "base:usdc",
  "to_asset": "solana:usdt",
  "beneficiary": {
    "wallet_address": "0x1234567890123456789012345678901234567890"
  },
  "exact_output": false,
  "callback_url": "https://your-app.com/webhooks/swap",
  "reference": "550e8400-e29b-41d4-a716-446655440000",
  "developer_fee": 0.5
}

{
  "success": true,
  "message": "Swap initiated successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": {
    "status": "AWAITING_DEPOSIT",
    "type": "SWAP",
    "reference": "550e8400-e29b-41d4-a716-446655440000",
    "source": {
      "amount": 100,
      "currency": "USDC"
    },
    "destination": {
      "amount": 99.5,
      "currency": "USDT"
    },
    "deposit": {
      "amount": 100,
      "address": "0x1234567890123456789012345678901234567890",
      "asset": "base:usdc",
      "note": [
        "Kindly send the exact amount to the blockchain wallet address to complete the transaction.",
        "This payment has a 15 minutes expiry window and should be sent within this time frame."
      ]
    }
  }
}