> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whitebit.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get virtual account status
> The endpoint returns the status of the account's [virtual account](/glossary#virtual-account) for the `SEPA_BCB_GROUP` [provider](/glossary#provider). When `status` is `active`, the response includes the bank details for incoming bank transfers in `paymentDetails`.
An account without a virtual account is not an error: the endpoint returns `notFound`. To register a virtual account, use [Create virtual account](/api-reference/account-wallet/create-virtual-account).
Two settings control access to the endpoint:
- **Endpoint access.** Enable the endpoint in the [API key settings](/api-reference/authentication#setting-up-api-keys).
- **Provider access.** WhiteBIT support enables API deposits for each provider on the account. Without provider access, the endpoint returns `403`.
Rate limit: 20 requests/1 min.
The API does not cache the response.
POST
Copy URL
Copy URL
## OpenAPI
````yaml openapi/private/main_api_v4.yaml POST /api/v4/main-account/payment/virtual-accounts/status
openapi: 3.0.3
info:
title: WhiteBIT Private HTTP API V4
description: |
WhiteBIT Private HTTP API V4 for Main balance changes.
Base URL: https://whitebit.com
All endpoints return time in Unix-time format.
All endpoints return either a JSON object or array.
For receiving responses from API calls please use http method POST.
version: 4.0.0
contact:
name: WhiteBIT Support
email: support@whitebit.com
url: https://whitebit.com
servers:
- url: https://whitebit.com
description: WhiteBIT Global Server
- url: https://whitebit.eu
description: WhiteBIT EU Server
- url: https://whitebit.tr
description: WhiteBIT TR Server
- url: https://whitebit.ge
description: WhiteBIT GE Server
security:
- ApiKeyAuth: []
PayloadAuth: []
SignatureAuth: []
tags:
- name: Main Account
description: Main account balance and operations
- name: Deposit
description: Cryptocurrency and fiat deposit operations
- name: Withdraw
description: Cryptocurrency and fiat withdrawal operations
- name: Transfer
description: Balance transfer operations
- name: Codes
description: WhiteBIT codes operations
- name: Crypto Lending - Fixed
description: Fixed crypto lending plans
- name: Crypto Lending - Flex
description: Flexible crypto lending plans
- name: Fees
description: Fee information
- name: Sub-Account
description: Sub-account management
- name: Sub-Account API Keys
description: Sub-account API key management
- name: Mining Pool
description: Mining pool operations
- name: Credit Line
description: Credit line information
- name: JWT
description: JWT token management
- name: Travel Rule
description: Travel Rule compliance endpoints for deposits and withdrawals
paths:
/api/v4/main-account/payment/virtual-accounts/status:
post:
tags:
- Deposit
summary: Get virtual account status
description: >
The endpoint returns the status of the account's [virtual
account](/glossary#virtual-account) for the `SEPA_BCB_GROUP`
[provider](/glossary#provider). When `status` is `active`, the response
includes the bank details for incoming bank transfers in
`paymentDetails`.
An account without a virtual account is not an error: the endpoint
returns `notFound`. To register a virtual account, use [Create virtual
account](/api-reference/account-wallet/create-virtual-account).
Two settings control access to the endpoint:
- **Endpoint access.** Enable the endpoint in the [API key
settings](/api-reference/authentication#setting-up-api-keys).
- **Provider access.** WhiteBIT support enables API deposits for each
provider on the account. Without provider access, the endpoint returns
`403`.
Rate limit: 20 requests/1 min.
The API does not cache the response.
operationId: getVirtualAccountStatus
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ticker
- provider
- request
- nonce
properties:
ticker:
type: string
description: >
Base currency [ticker](/glossary#ticker) of the
[fiat](/glossary#fiat) currency. Use `EUR`.
example: EUR
provider:
type: string
description: >
[Fiat](/glossary#fiat) [provider](/glossary#provider) of the
virtual account. Use `SEPA_BCB_GROUP`.
example: SEPA_BCB_GROUP
request:
type: string
description: >
Request path. See the [authentication
guide](/api-reference/authentication) for signature
generation details.
example: '{{request}}'
nonce:
type: integer
description: >
A unique identifier for the request. Use a monotonically
increasing value such as a Unix timestamp in milliseconds.
example: 1594297865000
example:
ticker: EUR
provider: SEPA_BCB_GROUP
request: '{{request}}'
nonce: 1594297865000
responses:
'200':
description: Virtual account status returned
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
enum:
- pending
- active
- rejected
- closed
- notFound
description: >
Virtual account status:
- `pending` — registration accepted, the provider has not
allocated the account yet.
- `active` — the account is allocated and accepts
deposits.
- `rejected` — the provider refused to open the account.
Submit a new registration request.
- `closed` — the account is closed. Submit a new
registration request.
- `notFound` — the account has no virtual account with the
provider.
paymentDetails:
type: object
description: >-
Bank details of the virtual account. Present only when
`status` is `active`.
properties:
beneficiary:
type: string
description: Beneficiary name for the bank transfer.
iban:
type: string
description: IBAN of the virtual account.
bic:
type: string
description: >-
BIC (SWIFT code) of the bank that holds the virtual
account.
examples:
active:
summary: Active virtual account
value:
status: active
paymentDetails:
beneficiary: Acme Trading Ltd
iban: DE89370400440532013000
bic: COBADEFFXXX
pending:
summary: Registration pending
value:
status: pending
notFound:
summary: No virtual account
value:
status: notFound
'400':
description: >
Validation failed. The endpoint also returns `400` when KYC
verification of the account is incomplete.
content:
application/json:
schema:
$ref: '#/components/schemas/FiatDepositError'
examples:
requiredFields:
summary: Required fields missing
value:
code: 0
message: Validation failed
errors:
ticker:
- The ticker field is required.
provider:
- The provider field is required.
providerNotSupported:
summary: Provider not supported for the currency
value:
code: 0
message: Validation failed
errors:
provider: Provider is not supported for this currency
virtualAccountsNotSupported:
summary: Provider does not issue virtual accounts
value:
code: 0
message: Validation failed
errors:
provider: Provider does not support virtual accounts
categoryRestricted:
summary: Currency not available for the account category
value:
code: 0
message: Validation failed
errors:
ticker: Currency is not available for this account category
notDepositable:
summary: Currency not depositable
value:
code: 0
message: Validation failed
errors:
ticker: Currency is not depositable
statusFailed:
summary: Status request failed on the provider side
value:
code: 0
message: Something went wrong
errors:
message: Failed to get virtual account status
'403':
description: >-
API deposits are not enabled for the provider on the account.
Contact WhiteBIT support to enable the provider.
content:
application/json:
schema:
$ref: '#/components/schemas/FiatDepositError'
example:
code: 0
message: >-
You don't have permission to use this endpoint. Please contact
support for more details
'429':
description: Rate limit exceeded
'451':
description: The currency is unavailable for the jurisdiction of the account.
components:
schemas:
FiatDepositError:
type: object
description: >
Error response of the fiat deposit and virtual account endpoints.
Request-rule failures return each `errors` value as an array of
messages. Business-rule failures return each `errors` value as a single
message string.
properties:
code:
type: integer
message:
type: string
errors:
type: object
additionalProperties:
oneOf:
- type: string
- type: array
items:
type: string
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-TXC-APIKEY
description: The public WhiteBIT API key.
PayloadAuth:
type: apiKey
in: header
name: X-TXC-PAYLOAD
description: Base64-encoded JSON request body.
SignatureAuth:
type: apiKey
in: header
name: X-TXC-SIGNATURE
description: >-
HMAC-SHA512 signature of the payload, hex-encoded. Computed as
hex(HMAC-SHA512(payload, api_secret)).
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.