Skip to main content
GET
/
api
/
v1
/
business-offramp
/
orders
/
{orderId}
Get Offramp Order
curl --request GET \
  --url https://aboki-b2b-eobk.onrender.com/api/v1/business-offramp/orders/{orderId} \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "data": {
    "orderId": "<string>",
    "status": "<string>",
    "tokenAmount": 123,
    "targetToken": "<string>",
    "targetNetwork": "<string>",
    "netNgnAmount": 123,
    "depositInstructions": {
      "walletAddress": "<string>",
      "expiresAt": "<string>"
    },
    "bankDetails": {
      "accountNumber": "<string>",
      "accountName": "<string>",
      "bankName": "<string>"
    },
    "createdAt": "<string>"
  }
}

Get Offramp Order

Retrieve complete details of a specific offramp order including current status, transaction information, and bank details.
Authorization
string
required
Your Public Key from the dashboard. Format: Bearer pk_live_your_key_here

Path Parameters

orderId
string
required
Order ID or business order reference (e.g., OFF_1703234567_ABC123DEF)

Response

success
boolean
Whether the request was successful
data
object
orderId
string
Unique order identifier
status
string
Current order status (pending_deposit, processing, completed, failed)
tokenAmount
number
Amount of tokens being converted
targetToken
string
Token being converted (USDC, USDT, ETH, SOL)
targetNetwork
string
Blockchain network (base, ethereum, solana)
netNgnAmount
number
NGN amount customer receives
depositInstructions
object
walletAddress
string
Generated wallet address for deposits
expiresAt
string
Deposit deadline
bankDetails
object
accountNumber
string
Customer’s bank account number
accountName
string
Account holder name
bankName
string
Bank name
createdAt
string
Order creation timestamp

Order Statuses

  • pending_deposit: Waiting for customer to send tokens
  • processing: Tokens received, processing NGN payout
  • completed: NGN successfully sent to customer’s bank
  • failed: Transaction failed or expired
  • expired: Customer didn’t deposit within 24 hours

Example Response

{
  "success": true,
  "data": {
    "orderId": "OFF_1703234567_ABC123DEF",
    "status": "completed",
    "tokenAmount": 100,
    "targetToken": "USDC",
    "targetNetwork": "base",
    "netNgnAmount": 162525,
    "depositInstructions": {
      "walletAddress": "0x742d35Cc6669C87532DD123F5b8c6B3e8e7c5B2A",
      "expiresAt": "2025-08-20T22:32:55.036Z"
    },
    "bankDetails": {
      "accountNumber": "1234567890",
      "accountName": "JOHN DOE",
      "bankName": "Guaranty Trust Bank"
    },
    "createdAt": "2025-08-19T22:32:55.036Z"
  }
}
I