Skip to main content
GET
Read how to deposit into the venue account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Workspace-Id
string<uuid>

The workspace the request acts in. An API key bound to a workspace implies it: omit the header, or send that same id (another id answers 403 WORKSPACE_SCOPE_MISMATCH). A member session must send it (400 MISSING_WORKSPACE without it).

Path Parameters

workspaceId
string
required

Current company or broker workspace

venueAccountId
string
required

Query Parameters

asset
string
chainRef
string
currency
string

ISO fiat currency for the bank-deposit read; never with asset or chainRef.

providerBankId
string

The dedicated fiat venue's linked bank id for the sending bank. Required with currency for a dedicated fiat venue and refused for other venues.

Response

Bank-rail instructions for ZAR on a VALR venue account; account capabilities trimmed to one entry and the deposit reference masked here (the API returns it in full to the member) (captured live, rfq be48e0453)

connection
object
required
options
object[]
required
reason
string
required
reasonCode
string
required
state
enum<string>
required

New values may be added; treat unknown values as other.

Available options:
supported,
unsupported,
unverified,
stale,
unavailable
unconfirmedNetworkAssets
string[]
required

Catalogue assets for which the venue declares no network mapping. Any registry chainRef may be requested; its network is never confirmed.

bankDeposit
null | object

Present when a bank currency is selected: receiving account available, reference only, not offered by the venue, or unread with its reason.

bankInstructions
null | object

The venue's bank deposit instructions for one fiat currency, read live from the bound account. Absent when the read failed: no reference is ever guessed.

instructions
null | object