Initialize Offramps Quote

https://sandboxapi.bitnob.co/api/v1/payouts/initialize (opens in a new tab)

Body Parameters

Parameter	Type	Required	Description	Allowed Values
quoteId	`string`	✅	ID of the previously generated quote	-
customerId	`string`	✅	Unique identifier for the customer	-
country	`string`	✅	Country code for the transaction	Currently supported: `NG` (Nigeria) `KE` (Kenya) `AU` (Australia)
reference	`string`	✅	Unique reference for the transaction	-
paymentReason	`string`	✅	Reason for the payment	-
beneficiaryId	`string`	❌	ID of existing beneficiary (Alternative to beneficiary object)	-
beneficiary	`object`	❌	Beneficiary details (Required if beneficiaryId not provided)	Object containing bank account details (use country requirements endpoint to get the correct structure per country)
callbackUrl	`string`	❌	URL for transaction status updates	-
clientMetaData	`object`	❌	Additional metadata for the transaction	Any valid JSON object

Request

Offramps/Initialize Off-ramp [POST]

curl --request POST \
   --url https://sandboxapi.bitnob.co/api/v1/payouts/initialize \
   --header 'Authorization: Bearer API-KEY' \
   --header 'accept: application/json' \
   --header 'content-type: application/json' \
   --data '{
"quoteId": "QT_6158",
"customerId": "uuid string",
"country": "NG",
"reference": "ref_QT_OF_RM-123",
"beneficiary": {
     "type": "BANK",
     "bankCode": "110072",
     "accountNumber": "1421795566"
 },
"paymentReason": "Funds for stuff",
"callbackUrl": "https://example.com/callback/id",
"clientMetaData": {
  "name": "john doe",
  "height": "194"
}
}'

Responses

🟢 200 - Result example

{
  "status": true,
  "message": "OffRamp quote initialized successfully",
  "data": {
      "fees": 0,
      "id": "4c281868-7b0d-4c4f-bcd7-bb3bbc9248bc",
      "address": "TNgGpCkphycU4pLg2LSJGUdb1mdwgMP8xs",
      "chain": "trc20",
      "status": "initiated",
      "paymentETA": "3-5 minutes",
      "reference": "ref_QT_OF_RM-123",
      "fromAsset": "usdt",
      "quoteId": "QT_6158",
      "paymentReason": "Funds for stuff",
      "settlementCurrency": "ngn",
      "exchangeRate": 1636.21,
      "expiryTimeStamp": 1736952410,
      "amount": 200,
      "btcAmount": 0.00201816,
      "satAmount": 201816,
      "expiresInText": "This invoice expires in 15 minutes",
      "beneficiaryDetails": {
          "id": "41b1e004-ce45-4591-bebe-6a2debcf05fd",
          "status": "success",
          "country": "NG",
          "currency": "NGN",
          "createdAt": "2025-01-15T14:30:48.773Z",
          "reference": "QT_6158_24ccd39d2345",
          "updatedAt": "2025-01-15T14:30:48.773Z",
          "destination": {
              "type": "BANK",
              "bankCode": "000014",
              "accountName": "JOHN DOE",
              "accountNumber": "1421795566"
          }
      },
      "settlementAmount": 327242
  }
}

Create Offramps Quote [POST]Finalize Offramps Quote [POST]