Get notifications

GET

notifications

Get notifications

curl --request GET \
  --url https://processor-prod.up.railway.app/notifications \
  --header 'x-service-key: <api-key>'

{
  "success": true,
  "status": 200,
  "message": "Notifications fetched successfully",
  "timestamp": "2025-09-17T00:07:13.436Z",
  "data": {
    "notifications": [
      {
        "asset": "bsc:usdt",
        "id": "68c9b988196a18d7bd2161cd",
        "reference": "s7s2ewm5qduwgwz23zpw",
        "wallet": "68c67578e4b64749538d1326",
        "hash": "0x2a592a8f253e9f404676190d6ee564afa307739549f15175c414ae16030076c6",
        "sender": "0xb8fbc060136580db4732c8e89af6bfc03f4ea229",
        "beneficiary": "68c67578196a18d7bd1e4e9b",
        "currency": "NGN",
        "rate": 1504.98,
        "direction": "outgoing",
        "receiver": "0xb8fbc060136580db4732c8e89af6bfc03f4ea229",
        "amount": 70,
        "fee": 0.35,
        "token": "0x55d398326f99059ff775485246999027b3197955",
        "blockchain": 56,
        "status": "completed",
        "type": "offramp",
        "timestamp": "2025-09-16T19:24:56.425Z"
      }
    ],
    "total": 9,
    "page": 1,
    "previous": null,
    "next": null,
    "limit": 10
  }
}

Authorizations

x-service-key

string

header

required

Query Parameters

page

integer

default:1

This is the current page being requested relative to size of a page

type

enum<string>

The type of notifications to retrieve

Available options:

transfer,

deposit,

offramp,

onramp,

swap

Example:

"offramp"

wallet_id

string

The wallet ID to get notifications for

Example:

"68c67578e4b64749538d1326"

reference

string

The reference of the specific transaction

Example:

"a6zhamo1neisjcxncmas"

Response

200 - application/json

Notifications fetched successfully

success

boolean

Example:

true

status

integer

Example:

200

message

string

Example:

"Notifications fetched successfully"

timestamp

string<date-time>

Example:

"2025-09-17T00:07:13.436Z"

data

object

Show child attributes

data.notifications

object[]

Show child attributes

data.notifications.asset

string

Asset identifier

Example:

"bsc:usdt"

data.notifications.id

string

Unique identifier for the notification

Example:

"68c9b988196a18d7bd2161cd"

data.notifications.reference

string

Reference identifier for the transaction

Example:

"s7s2ewm5qduwgwz23zpw"

data.notifications.wallet

string

Wallet ID associated with the notification

Example:

"68c67578e4b64749538d1326"

data.notifications.hash

string

Transaction hash on the blockchain

Example:

"0x2a592a8f253e9f404676190d6ee564afa307739549f15175c414ae16030076c6"

data.notifications.sender

string

Sender address

Example:

"0xb8fbc060136580db4732c8e89af6bfc03f4ea229"

data.notifications.beneficiary

string

Beneficiary ID for offramp transactions

Example:

"68c67578196a18d7bd1e4e9b"

data.notifications.currency

string

Currency code for offramp transactions

Example:

"NGN"

data.notifications.rate

number

Exchange rate used

Example:

1504.98

data.notifications.direction

enum<string>

Direction of the transaction

Available options:

incoming,

outgoing

Example:

"outgoing"

data.notifications.receiver

string

Receiver address

Example:

"0xb8fbc060136580db4732c8e89af6bfc03f4ea229"

data.notifications.amount

number

Transaction amount

Example:

70

data.notifications.fee

number

Transaction fee

Example:

0.35

data.notifications.token

string

Token contract address

Example:

"0x55d398326f99059ff775485246999027b3197955"

data.notifications.blockchain

integer

Blockchain identifier

Example:

56

data.notifications.status

enum<string>

Transaction status

Available options:

completed,

pending,

failed

Example:

"completed"

data.notifications.type

enum<string>

Type of transaction

Available options:

transfer,

deposit,

offramp,

onramp,

swap

Example:

"offramp"

data.notifications.timestamp

string<date-time>

Transaction timestamp

Example:

"2025-09-16T19:24:56.425Z"

data.total

integer

Example:

9

data.page

integer

Example:

1

data.previous

string | null

Example:

null

data.next

string | null

Example:

null

data.limit

integer

Example:

10

Create webhookThis endpoint allows you to create or update webhook.

⌘I

Get notifications

curl --request GET \
  --url https://processor-prod.up.railway.app/notifications \
  --header 'x-service-key: <api-key>'

{
  "success": true,
  "status": 200,
  "message": "Notifications fetched successfully",
  "timestamp": "2025-09-17T00:07:13.436Z",
  "data": {
    "notifications": [
      {
        "asset": "bsc:usdt",
        "id": "68c9b988196a18d7bd2161cd",
        "reference": "s7s2ewm5qduwgwz23zpw",
        "wallet": "68c67578e4b64749538d1326",
        "hash": "0x2a592a8f253e9f404676190d6ee564afa307739549f15175c414ae16030076c6",
        "sender": "0xb8fbc060136580db4732c8e89af6bfc03f4ea229",
        "beneficiary": "68c67578196a18d7bd1e4e9b",
        "currency": "NGN",
        "rate": 1504.98,
        "direction": "outgoing",
        "receiver": "0xb8fbc060136580db4732c8e89af6bfc03f4ea229",
        "amount": 70,
        "fee": 0.35,
        "token": "0x55d398326f99059ff775485246999027b3197955",
        "blockchain": 56,
        "status": "completed",
        "type": "offramp",
        "timestamp": "2025-09-16T19:24:56.425Z"
      }
    ],
    "total": 9,
    "page": 1,
    "previous": null,
    "next": null,
    "limit": 10
  }
}

API reference

Authorizations

Query Parameters

Response