API Reference
Offramps
Get Quote by reference [GET]

Get Quote by Reference

https://sandboxapi.bitnob.co/api/v1/payouts/fetch/reference/{reference} (opens in a new tab)

Get a quote by it's reference

Path Parameters

ParametertypeRequired
referencestring

Request

Offramps/Get Quote by Reference [GET]
curl --location 'https://sandboxapi.bitnob.co/api/v1/payouts/fetch/reference/{reference}' \
--header 'Authorization: Bearer API-KEY'

Responses

🟢 200 - Result example
{
"status": true,
"message": "OffRamp retrieved successfully",
"data": {
  "id": "47a53f18-351a-479b-be70-939d1d663944",
  "createdAt": "2024-11-27T12:35:38.266Z",
  "updatedAt": "2024-11-29T12:42:35.826Z",
  "quoteId": "QT_489",
  "companyId": "537f275e-c51a-4399-a4c8-779ca0217649",
  "customerId": "57475dbf-ea9d-4f37-9f0d-b6a475ace4cb",
  "paymentReason": "Funds for stuff",
  "reference": "nu-reference-5",
  "callbackUrl": "https://example.com/callback/id",
  "beneficiaryId": "a21b99cb-e00d-4f39-8486-6f82e0e78dee",
  "status": "expired",
  "exchangeRate": {
    "rate": 1718.8,
    "currency": "ngn"
  },
  "beneficiary": {
    "id": "a21b99cb-e00d-4f39-8486-6f82e0e78dee",
    "status": "success",
    "country": "NG",
    "currency": "NGN",
    "createdAt": "2024-11-27T12:34:47.154Z",
    "reference": "QT488_15b34a708b9e",
    "updatedAt": "2024-11-27T12:34:47.154Z",
    "destination": {
      "type": "BANK",
      "bankCode": "000014",
      "accountNumber": "xx2179988"
    }
  },
  "trip": {
    "submitted": null,
    "quoteSentAt": "1732710939",
    "assetReceived": null,
    "initializedAt": "1732710965",
    "completionTime": "1732884155",
    "processingStart": null,
    "timeToCompletion": null
  },
  "clientMetaData": {
    "name": "john doe",
    "height": "194"
  },
  "satAmount": "0",
  "btcAmount": "0",
  "amount": "1000",
  "centAmount": "100000",
  "settlementAmount": 1718800,
  "centFees": "0",
  "fees": "0",
  "address": null,
  "source": "onchain",
  "fromAsset": "usdt",
  "chain": "trc20",
  "toCurrency": "ngn",
  "paymentETA": "3-5 minutes",
  "expiry": "2024-11-27T12:52:03.529Z"
}
}