v1

latestOpenAPI 3.1.02026-07-26460218.4 KB

Widget Quote

Gets a quote for a widget transaction

post/widget/quote

Request body

currencystring

Local currency user is buying tokens with

localAmountinteger

Total amount of local currency user is wanting to buy of tokens. This should only be used for BUY transactionType

cryptoAmountnumber float

Total amount of crypto currency user is wanting to sell of tokens. This should only be used for SELL transactionType

coinstring

The type of coin/token that the user is wanting to buy

networkstring

The network of the coin/token that the user is wanting to buy

channelIdstring

The channelId of the payment method that the user is wanting to use. This will be retrieved from the getChannels API

transactionTypestring

Type of the transaction wanting to be conducted by the user. This will be 'Buy' or 'Sell'

Response

200

currencystring

coinstring

cryptoAmountinteger

networkstring

channelIdstring

transactionTypestring

fiatReceivednumber

convertedAmountinteger

rateLocalnumber

serviceFeeLocalnumber

serviceFeeUSDinteger

partnerFeeLocalnumber

partnerFeeUSDinteger

paymentMethodstring

settlementstring

updatedAtstring

expireAtstring

transactionLimitMininteger

transactionLimitMaxinteger

cryptoMaxLimitnumber

cryptoMinLimitnumber

Example response

{
  "currency": "NGN",
  "coin": "USDC",
  "cryptoAmount": 100,
  "network": "ERC20",
  "channelId": "d01e48c1-8ada-408b-8bee-c62090cfb24a",
  "transactionType": "Sell",
  "fiatReceived": 153430.08,
  "convertedAmount": 159823,
  "rateLocal": 1598.23,
  "serviceFeeLocal": 1598.23,
  "serviceFeeUSD": 1,
  "partnerFeeLocal": 4794.69,
  "partnerFeeUSD": 3,
  "paymentMethod": "p2p",
  "settlement": "instant",
  "updatedAt": "2024-12-09T11:46:23.325Z",
  "expireAt": "2024-12-09T11:56:23.325Z",
  "transactionLimitMin": 10000,
  "transactionLimitMax": 500000,
  "cryptoMaxLimit": 312.85,
  "cryptoMinLimit": 6.26
}