Get status - Bread

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"
  }
}

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

Show child attributes

data.id

string

Unique identifier for the offramp transaction

Example:

"68c1b920196a18d7bd1998d6"

data.reference

string

Reference identifier for the offramp transaction

Example:

"rk7fimzmx3r5uvsjwpdx70uz4tjhmeoc"

data.address

string

Address of the offramp wallet

Example:

"0x0000000000000000000000000000000000000000"

data.blockchain

object

Show child attributes

data.blockchain.id

integer

Blockchain identifier

Example:

8453

data.blockchain.icon

string

Blockchain icon URL

Example:

"https://i.imgur.com/zvJz8OR.png"

data.blockchain.name

string

Blockchain name

Example:

"Base"

data.blockchain.code

string

Blockchain code

Example:

"Base"

data.token

object

Show child attributes

data.token.id

string

Token identifier

Example:

"base:usdc"

data.token.icon

string

Token icon URL

Example:

"https://i.imgur.com/ilNGZVh.png"

data.token.name

string

Token name

Example:

"USD Coin"

data.token.code

string

Token code

Example:

"USDC"

data.currency

object

Show child attributes

data.currency.icon

string

Currency icon URL

Example:

"https://i.imgur.com/RhBMnVC.png"

data.currency.name

string

Currency name

Example:

"Nigerian Naira"

data.currency.code

string

Currency code

Example:

"NGN"

data.recipient

object

Show child attributes

data.recipient.account_name

string

Account holder's name

Example:

"John Doe"

data.recipient.account_number

string

Account number

Example:

"0123456789"

data.recipient.bank_name

string

Bank name

Example:

"Opay"

data.from_amount

number

Amount being offramped from crypto

Example:

0.997598

data.to_amount

string

Amount being received in fiat currency

Example:

"738"

data.rate

number

Exchange rate used for the offramp

Example:

1522

data.fee

number

Fee charged for the offramp

Example:

0.996600402

data.time_to_arrive

integer

Estimated time for funds to arrive (in seconds)

Example:

60

data.status

enum<string>

Status of the offramp transaction

Available options:

completed,

pending,

failed,

processing

Example:

"completed"

Get notificationsThis endpoint allows you to retrieve notifications by type for a wallet.

⌘I

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"
  }
}

API reference

Authorizations

Query Parameters

Response