Skip to main content
GET
/
status
/
offramp
Get status
curl --request GET \
  --url https://processor-prod.up.railway.app/status/offramp \
  --header 'x-service-key: <api-key>'
{
  "success": true,
  "status": 200,
  "message": "Offramp status fetched successfully",
  "timestamp": "2025-09-11T21:29:42.416Z",
  "data": {
    "id": "68c1b920196a18d7bd1998d6",
    "reference": "rk7fimzmx3r5uvsjwpdx70uz4tjhmeoc",
    "address": "0x0000000000000000000000000000000000000000",
    "blockchain": {
      "id": 8453,
      "icon": "https://i.imgur.com/zvJz8OR.png",
      "name": "Base",
      "code": "Base"
    },
    "token": {
      "id": "base:usdc",
      "icon": "https://i.imgur.com/ilNGZVh.png",
      "name": "USD Coin",
      "code": "USDC"
    },
    "currency": {
      "icon": "https://i.imgur.com/RhBMnVC.png",
      "name": "Nigerian Naira",
      "code": "NGN"
    },
    "recipient": {
      "account_name": "John Doe",
      "account_number": "0123456789",
      "bank_name": "Opay"
    },
    "from_amount": 0.997598,
    "to_amount": "738",
    "rate": 1522,
    "fee": 0.996600402,
    "time_to_arrive": 60,
    "status": "completed"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bread.africa/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-service-key
string
header
required

Query Parameters

​
wallet_id
string
required

The wallet ID to get offramp status for

Example:

"68bc290df51feea8c53f5275"

​
reference
string

The reference of the offramp transaction

Example:

"rk7fimzmx3r5uvsjwpdx70uz4tjhmeoc"

Response

200 - application/json

Offramp status fetched successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Offramp status fetched successfully"

​
timestamp
string<date-time>
Example:

"2025-09-11T21:29:42.416Z"

​
data
object