Skip to main content

private/fiat/fiat-access

POST 
/private/fiat/fiat-access
Retrieves fiat access information for a user account. Used by FCM/DCM brokers to check deposit and withdrawal permissions for different currencies and payment networks on behalf of their users.

Request​

Body

required
    id int64required

    Request id (echoed in response)

    method stringrequired

    Must be "private/fiat/fiat-access"

    api_key stringrequired

    Your API key (only required for private REST)

    sig stringrequired

    HMAC-SHA256 signature in hex (only required for private REST)

    nonce int64required

    Current timestamp in milliseconds, e.g. "1773372503821".

    on_behalf_of_account_uuid stringrequired

    The account UUID of the user on whose behalf the broker is making the request

    params objectrequired
    object
Success.
Schema
    id int64

    Echoed request id

    method string

    Method invoked

    code int32

    0 = success; non-zero indicates error (reason code).

    result object
    Present when code === 0. Contains accesses array.
    accesses object[]required
    List of fiat access permissions
  • Array [
    • currency stringrequired

    Currency code (e.g., USD)

    payment_network stringrequired

    Payment network identifier (e.g., us_ach)

    is_deposit_enable booleanrequired

    Whether deposits are enabled for this currency/network

    is_withdraw_enable booleanrequired

    Whether withdrawals are enabled for this currency/network

  • ]
    • message string

    Present when code !== 0.

    original string

    Present when code !== 0.