--- agentTools: projectIndex: https://oneramp.readme.io/llms.txt --- # Quote Out This endpoint is used to retrieve the quote showing price estimations for the transfer Before your offramp your users, you must first create a quote instance. This will return the price estimations and **quoteId** which will be used later in the transfer endpoint [Run In Postman](https://www.postman.com/speeding-astronaut-312013/oneramp-public-api/request/5v7znf6/oneramp-api-live?action=share\&creator=12967887\&ctx=documentation\&active-environment=12967887-b11e3b15-2c66-42b0-aaea-6c82db2932a4) # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "OneRamp URL", "version": "1.0" }, "servers": [ { "url": "https://api.oneramp.io" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "Bearer" } } }, "security": [ { "sec0": [] } ], "paths": { "/quote-out": { "post": { "summary": "Quote Out", "description": "This endpoint is used to retrieve the quote showing price estimations for the transfer", "operationId": "quote-out", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fiatType": { "type": "string", "description": "Select the user's fiat currency", "default": "UGX", "enum": [ "NGN", "KES", "GHS", "UGX", "TZS", "ZMW" ] }, "cryptoType": { "type": "string", "description": "Select the type of asset", "default": "cUSD", "enum": [ "cUSD" ] }, "cryptoAmount": { "type": "string", "description": "Enter the amount of asset. Not supposed to be used together with fiatAmount" }, "country": { "type": "string", "description": "Select the country", "default": "UG", "enum": [ "NG", "KE", "UG", "GH", "TZ", "ZM" ] }, "address": { "type": "string", "description": "Enter the wallet user's address" }, "fiatAmount": { "type": "string", "description": "Enter the amount in fiat of asset. Not supposed to be used together with cryptoAmount" }, "network": { "type": "string", "description": "Select the network on which the user wants to make the transaction", "enum": [ "base", "celo", "starknet", "polygon", "ethereum" ] } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"quote\": {\n \"fiatType\": \"ZAR\",\n \"cryptoType\": \"USDC\",\n \"fiatAmount\": \"112.68\",\n \"cryptoAmount\": \"5.64\",\n \"country\": \"ZA\",\n \"amountPaid\": \"6\",\n \"address\": \"0x240ef8C7Ae6eB6C1A80Da77F5586EeE76d50C589\",\n \"fee\": \"0.36\",\n \"guaranteedUntil\": \"2025-05-14T17:41:01.381Z\",\n \"transferType\": \"TransferOut\",\n \"quoteId\": \"f6204b44-6089-4f82-8ded-dedb19e278d2\",\n \"network\": \"celo\",\n \"used\": false,\n \"requestType\": \"fiat\",\n \"id\": \"6824d5ada642d48ade8eb3d2\"\n },\n \"kyc\": {\n \"kycRequired\": true,\n \"kycSchemas\": [\n {\n \"kycSchema\": \"PersonalDataAndDocuments\",\n \"allowedValues\": {\n \"isoCountryCode\": [\n \"UG\",\n \"KE\"\n ],\n \"isoRegionCode\": [\n \"UG\",\n \"KE\"\n ]\n }\n }\n ]\n },\n \"fiatAccount\": {\n \"MobileMoney\": {\n \"fiatAccountSchemas\": [\n {\n \"fiatAccountSchema\": \"MobileMoney\",\n \"userActionType\": \"AccountNumberUserAction\",\n \"allowedValues\": {\n \"country\": [\n \"UG\",\n \"KE\"\n ]\n },\n \"institutionName\": \"OneRamp\",\n \"accountName\": \"OneRamp\",\n \"accountNumber\": \"25656\",\n \"transactionReference\": \"ref-6824d5ada642d48ade8eb3d2\"\n }\n ],\n \"settlementTimeLowerBound\": \"3600\",\n \"settlementTimeUpperBound\": \"86400\"\n }\n }\n}\n" } }, "schema": { "type": "object", "properties": { "quote": { "type": "object", "properties": { "fiatType": { "type": "string", "example": "ZAR" }, "cryptoType": { "type": "string", "example": "USDC" }, "fiatAmount": { "type": "string", "example": "112.68" }, "cryptoAmount": { "type": "string", "example": "5.64" }, "country": { "type": "string", "example": "ZA" }, "amountPaid": { "type": "string", "example": "6" }, "address": { "type": "string", "example": "0x240ef8C7Ae6eB6C1A80Da77F5586EeE76d50C589" }, "fee": { "type": "string", "example": "0.36" }, "guaranteedUntil": { "type": "string", "example": "2025-05-14T17:41:01.381Z" }, "transferType": { "type": "string", "example": "TransferOut" }, "quoteId": { "type": "string", "example": "f6204b44-6089-4f82-8ded-dedb19e278d2" }, "network": { "type": "string", "example": "celo" }, "used": { "type": "boolean", "example": false, "default": true }, "requestType": { "type": "string", "example": "fiat" }, "id": { "type": "string", "example": "6824d5ada642d48ade8eb3d2" } } }, "kyc": { "type": "object", "properties": { "kycRequired": { "type": "boolean", "example": true, "default": true }, "kycSchemas": { "type": "array", "items": { "type": "object", "properties": { "kycSchema": { "type": "string", "example": "PersonalDataAndDocuments" }, "allowedValues": { "type": "object", "properties": { "isoCountryCode": { "type": "array", "items": { "type": "string", "example": "UG" } }, "isoRegionCode": { "type": "array", "items": { "type": "string", "example": "UG" } } } } } } } } }, "fiatAccount": { "type": "object", "properties": { "MobileMoney": { "type": "object", "properties": { "fiatAccountSchemas": { "type": "array", "items": { "type": "object", "properties": { "fiatAccountSchema": { "type": "string", "example": "MobileMoney" }, "userActionType": { "type": "string", "example": "AccountNumberUserAction" }, "allowedValues": { "type": "object", "properties": { "country": { "type": "array", "items": { "type": "string", "example": "UG" } } } }, "institutionName": { "type": "string", "example": "OneRamp" }, "accountName": { "type": "string", "example": "OneRamp" }, "accountNumber": { "type": "string", "example": "25656" }, "transactionReference": { "type": "string", "example": "ref-6824d5ada642d48ade8eb3d2" } } } }, "settlementTimeLowerBound": { "type": "string", "example": "3600" }, "settlementTimeUpperBound": { "type": "string", "example": "86400" } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "curl", "code": "curl --location 'https://api.oneramp.io/api/quote/out' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"fiatType\": \"UGX\",\n \"cryptoType\": \"cUSD\",\n \"cryptoAmount\": \"95\",\n \"country\": \"UG\",\n \"address\": \"0x5CBDf5f9E468dF3888e0415562635ajhgdu2387f\"\n}'" }, { "language": "javascript", "code": "const axios = require('axios');\nlet data = JSON.stringify({\n \"fiatType\": \"UGX\",\n \"cryptoType\": \"cUSD\",\n \"cryptoAmount\": \"95\",\n \"country\": \"UG\",\n \"address\": \"0x5CBDf5f9E468dF3888e04155668fasyt2375\"\n});\n\nlet config = {\n method: 'post',\n maxBodyLength: Infinity,\n url: 'https://api.oneramp.io/api/quote/out',\n headers: { \n 'Content-Type': 'application/json', \n },\n data : data\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n" }, { "language": "python", "code": "import requests\nimport json\n\nurl = \"https://api.oneramp.io/api/quote/out\"\n\npayload = json.dumps({\n \"fiatType\": \"UGX\",\n \"cryptoType\": \"cUSD\",\n \"cryptoAmount\": \"95\",\n \"country\": \"UG\",\n \"address\": \"0x5CBDf5f9E468dF3888e041552365gaus76253f\"\n})\nheaders = {\n 'Content-Type': 'application/json',\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "language": "php", "code": " 'application/json',\n];\n$body = '{\n \"fiatType\": \"UGX\",\n \"cryptoType\": \"cUSD\",\n \"cryptoAmount\": \"95\",\n \"country\": \"UG\",\n \"address\": \"0x5CBDf5f9E468dF3888e041556682365gasyi4576\"\n}';\n$request = new Request('POST', 'https://api.oneramp.io/api/quote/out', $headers, $body);\n$res = $client->sendAsync($request)->wait();\necho $res->getBody();\n" } ], "samples-languages": [ "curl", "javascript", "python", "php" ] } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "6578a18ab9ee9e04ffd2297b:6578b587d411bb005b66db3c" } ```