ONonlink
Partner API

List your registered withdrawal addresses

get/v1/wallets

Request

  • Base URL
    https://sandbox.onlink.africa
  • Auth
    API key in header X-OnLink-Key

Response

Your addresses

walletIdstring uuid required

The registration id. Use it for POST /v1/wallets/{id}/confirm and DELETE /v1/wallets/{id}.

chain'tron' required

Network. Tron only at launch.

asset'USDT' required

Asset. USDT only at launch.

addressstring required

The withdrawal address, in full — exactly as stored, checksum already verified. Compare the entire string when you reconcile: a truncated rendering makes a lookalike address indistinguishable from the real one, and USDT sent to the wrong address is an irrecoverable burn.

labelstring nullable required

Your own label, echoed back. Never used for routing. null if you sent none.

status'pending_partner_approval' | 'pending_onlink_approval' | 'active' | 'revoked' required

Where the address sits in the two-party approval. active is the only deliverable value — a correct administrator code moves it to pending_onlink_approval, and OnLink’s own review is what makes it usable. revoked is terminal.

screeningStatus'pending' | 'clear' | 'flagged' required

Address-screening outcome. Never defaults to a clear verdict: a newly registered address reads pending until a screen has actually run.

createdAtstring date-time required

When the address was registered, ISO 8601 UTC.

Example response

[
  {
    "walletId": "b8e4d1c7-2f39-4a05-8d6b-1c2e3f4a5b60",
    "chain": "tron",
    "asset": "USDT",
    "address": "T9yD14Nj9j7xAB4dbGeiX9h8unkKHxuWwb",
    "label": "Settlement wallet — Tron",
    "status": "pending_partner_approval",
    "screeningStatus": "pending",
    "createdAt": "2026-08-31T09:30:00.000Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.