Get Quote (Crypto-to-Crypto)
This endpoint fetches the complete details of a previously created crypto-to-crypto quote using its quote_id
. The data includes source and target crypto information, exchange rates, and transaction rules.
Endpoint
GET {{appUrl}}/v1/ramp/quote/{{quote_id}}
Headers
Header | Value | Required |
---|---|---|
Content-Type | application/json | Yes |
x-api-key | YOUR_API_KEY | Yes |
Path Parameter
Parameter | Type | Description |
---|---|---|
quote_id | string | Unique identifier of the quote |
Successful Response 200 OK
{
"message": "quote successfully created",
"status": "success",
"data": {
"id": "92da6ea0-79fe-4000-971d-xxxxxxxxxxxxxxxx",
"source": {
"currency": "Polygon",
"symbol": "POL",
"addressRegex": "^(0x)[0-9A-Fa-f]{40}$",
"amount": 0.12,
"blockchain": "MATIC",
"type": "CRYPTOCURRENCY"
},
"target": {
"currency": "Polygon",
"symbol": "POL",
"addressRegex": "^(0x)[0-9A-Fa-f]{40}$",
"amount": 0.12,
"blockchain": "MATIC",
"type": "CRYPTOCURRENCY"
},
"rate": 0.00102300,
"fees": {
"symbol": "POL",
"amount": 0.00,
"gas": {
"type": "MEDIUM",
"amount": 0.01909123
}
},
"rules": [
{
"category": "LIMIT",
"appliedCurrency": "USDC",
"transaction": {
"minimum": 10.00,
"maximum": 2000000.00
},
"invoice": 2000000.00
}
],
"summary": {
"total": 0.12
}
}
}
Response Breakdown
Field | Type | Description |
---|---|---|
message | string | Status message (e.g., "quote successfully created" ) |
status | string | Status of the request (e.g., "success" ) |
data.id | string | Unique identifier of the quote |
data.source | object | Details of the source cryptocurrency |
data.source.currency | string | Name of the source currency (e.g., "Polygon" ) |
data.source.symbol | string | Symbol of the source cryptocurrency (e.g., "POL" ) |
data.source.addressRegex | string | Regular expression pattern for validating crypto addresses |
data.source.amount | number | Amount of source cryptocurrency |
data.source.blockchain | string | Blockchain network (e.g., "MATIC" ) |
data.source.type | string | Type of the asset ("CRYPTOCURRENCY" ) |
data.target | object | Details of the target cryptocurrency |
data.target.currency | string | Name of the target currency (e.g., "Polygon" ) |
data.target.symbol | string | Symbol of the target cryptocurrency (e.g., "POL" ) |
data.target.addressRegex | string | Regular expression pattern for validating target crypto addresses |
data.target.amount | number | Amount of target cryptocurrency |
data.target.blockchain | string | Blockchain network of the target currency |
data.target.type | string | Type of the asset ("CRYPTOCURRENCY" ) |
data.rate | number | Exchange rate between source and target cryptocurrencies |
data.fees | object | Fee breakdown for the transaction |
data.fees.symbol | string | Currency symbol for fees |
data.fees.amount | number | Fee amount charged |
data.fees.gas | object | Gas fee details |
data.fees.gas.type | string | Gas fee level ("MEDIUM" , etc.) |
data.fees.gas.amount | number | Gas fee amount |
data.rules | array | Rules that apply to this transaction |
data.rules[].category | string | Rule category (e.g., "LIMIT" ) |
data.rules[].appliedCurrency | string | Currency to which the rule applies (e.g., "USDC" ) |
data.rules[].transaction | object | Transaction limits |
data.rules[].transaction.minimum | number | Minimum transaction amount |
data.rules[].transaction.maximum | number | Maximum transaction amount |
data.rules[].invoice | number | Maximum invoice amount |
data.summary | object | Summary of the transaction |
data.summary.total | number | Total amount of the source cryptocurrency involved in the transaction |
Error Codes
Code | Message |
---|---|
400 | Bad request – invalid or missing fields |
401 | Unauthorized – invalid API key |
500 | Internal server error |