Offramp

Offramp transaction endpoints for converting stablecoins to fiat currency

Get offramp rate

post

Get the current exchange rate for an offramp transaction.

Authorizations

ServiceKey

Body

application/json

assetstring · enumRequiredPossible values:

countrystringRequired

ISO 3166-1 alpha-2 country code

currencystringOptional

Optional currency code. If not specified, defaults to the country's local currency.

Responses

200

Successfully retrieved offramp rate

application/json

400

Bad request - Invalid input parameters or validation error

application/json

post

/offramp/rate

HTTPcURLJavaScriptPython

POST /offramp/rate HTTP/1.1
Host: api.onswitch.xyz
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "asset": "base:usdc",
  "country": "NG",
  "currency": "NGN"
}

{
  "success": true,
  "message": "Offramp rate fetched successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": {
    "rate": 1500.5
  }
}

Get offramp quote

post

Get a real-time quote for an offramp transaction including exchange rate, settlement time, and payment rail information.

Authorizations

ServiceKey

Body

application/json

amountnumberRequired

countrystring · enumRequiredPossible values:

assetstring · enumRequiredPossible values:

currencystring · enumOptional

Optional currency code. If not specified, defaults to the country's local currency.

Possible values:

channelstring · enumOptional

Optional transfer channel. If not specified, defaults to the country's default channel.

Possible values:

exact_outputbooleanOptionalDefault: false

Responses

200

Successfully retrieved offramp quote

application/json

400

Bad request - Invalid input parameters or validation error

application/json

post

/offramp/quote

HTTPcURLJavaScriptPython

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

{
  "amount": 100,
  "country": "NG",
  "asset": "base:usdc",
  "currency": "NGN",
  "channel": "BANK",
  "exact_output": false,
  "developer_fee": 0.5
}

{
  "success": true,
  "message": "Quote fetched successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": {
    "rate": 1500.5,
    "expiry": "2024-01-01T00:05:00.000Z",
    "settlement": "Same day",
    "channel": "BANK",
    "fee": {
      "total": 5,
      "platform": 4.5,
      "developer": 0.5,
      "currency": "USDC"
    },
    "fee_inclusive": true,
    "source": {
      "amount": 100,
      "currency": "USDC"
    },
    "destination": {
      "amount": 150050,
      "currency": "NGN"
    }
  }
}

Initiate offramp transaction

post

Initiate a stablecoin to fiat transaction.

Authorizations

ServiceKey

Body

application/json

amountnumberRequired

countrystring · enumRequiredPossible values:

assetstring · enumRequiredPossible values:

currencystring · enumOptional

Optional currency code. If not specified, defaults to the country's local currency.

Possible values:

sender_namestringOptional

exact_outputbooleanOptionalDefault: false

callback_urlstring · uriOptional

referencestring · uuidOptional

channelstring · enumOptional

Optional transfer channel. If not specified, defaults to the country's default channel.

Possible values:

reasonstring · enumOptional

Optional payment reason for compliance purposes

Possible values:

developer_feenumber · max: 100Optional

Optional developer fee percentage (0-100)

Responses

200

Successfully initiated offramp transaction

application/json

400

Bad request - Invalid input parameters or validation error

application/json

post

/offramp/initiate

HTTPcURLJavaScriptPython

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

{
  "amount": 100,
  "country": "NG",
  "currency": "NGN",
  "asset": "base:usdc",
  "beneficiary": {
    "holder_type": "INDIVIDUAL",
    "holder_name": "John Doe",
    "account_number": "0123456789",
    "bank_code": "058"
  },
  "exact_output": false,
  "callback_url": "https://your-app.com/webhooks/offramp",
  "reference": "550e8400-e29b-41d4-a716-446655440000",
  "channel": "BANK",
  "reason": "REMITTANCES",
  "developer_fee": 0.5
}

{
  "success": true,
  "message": "Offramp transaction initiated successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": null,
  "status": "AWAITING_DEPOSIT",
  "type": "OFFRAMP",
  "reference": "550e8400-e29b-41d4-a716-446655440000",
  "source": {
    "amount": 100,
    "currency": "USDC"
  },
  "destination": {
    "amount": 150050,
    "currency": "NGN"
  },
  "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 30 minutes expiry window and should be sent within this time frame."
    ]
  }
}