> For a complete page index, fetch https://docs.transak.com/llms.txt

# Get Virtual Account Status (Bank Transfer)

GET https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account

The **Get Virtual Account Status** is an **authenticated API** that polls the virtual account status. Keep polling until `status` is `COMPLETED` before placing an order.  A `FAILED` status indicates account creation failed. 

Reference: https://docs.transak.com/api/whitelabel/orders/get-virtual-account-status

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: whitelabel-api
  version: 1.0.0
paths:
  /api/v2/onramp/virtual-account:
    get:
      operationId: get-virtual-account-status
      summary: Get Virtual Account Status (Bank Transfer)
      description: >-
        The **Get Virtual Account Status** is an **authenticated API** that
        polls the virtual account status. Keep polling until `status` is
        `COMPLETED` before placing an order.  A `FAILED` status indicates
        account creation failed. 
      tags:
        - subpackage_orders
      parameters:
        - name: quoteId
          in: query
          description: Quote ID generated from `api/v2/lookup/quotes`
          required: true
          schema:
            type: string
        - name: authorization
          in: header
          description: >-
            Authorization token is the accessToken received from the API -`
            api/v2/auth/verify`


            Note: This is not applicable for [Auth Reliance
            Flows](/features/auth-reliance)
          required: false
          schema:
            type: string
        - name: x-user-identifier
          in: header
          description: >-
            Your authenticated user Email Id address.


            Note: This is applicable only for [Auth Reliance
            Flows](/features/auth-reliance)
          required: false
          schema:
            type: string
        - name: x-access-token
          in: header
          description: >
            Your Partner Access Token. Please refer
            [here](/guides/how-to-create-partner-access-token) for a tutorial on
            generating your access token.


            Note: This is applicable only for [Auth Reliance
            Flows](/features/auth-reliance)
          required: false
          schema:
            type: string
      responses:
        '200':
          description: 200 - Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Orders_get-virtual-account-status_Response_200
        '400':
          description: 400 - Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Get-virtual-account-statusRequestBadRequestError
        '401':
          description: 401 - Unauthorized
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Get-virtual-account-statusRequestUnauthorizedError
        '404':
          description: 404 - Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Get-virtual-account-statusRequestNotFoundError
        '500':
          description: 500 - Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Get-virtual-account-statusRequestInternalServerError
servers:
  - url: https://api-gateway-stg.transak.com
    description: Staging
components:
  schemas:
    ApiV2OnrampVirtualAccountGetResponsesContentApplicationJsonSchemaDataStatus:
      type: string
      enum:
        - INITIATED
        - COMPLETED
        - FAILED
      description: Current status of the virtual account creation.
      title: >-
        ApiV2OnrampVirtualAccountGetResponsesContentApplicationJsonSchemaDataStatus
    ApiV2OnrampVirtualAccountGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        status:
          $ref: >-
            #/components/schemas/ApiV2OnrampVirtualAccountGetResponsesContentApplicationJsonSchemaDataStatus
          description: Current status of the virtual account creation.
        message:
          type: string
      required:
        - status
        - message
      title: ApiV2OnrampVirtualAccountGetResponsesContentApplicationJsonSchemaData
    Orders_get-virtual-account-status_Response_200:
      type: object
      properties:
        data:
          $ref: >-
            #/components/schemas/ApiV2OnrampVirtualAccountGetResponsesContentApplicationJsonSchemaData
      required:
        - data
      title: Orders_get-virtual-account-status_Response_200
    ApiV2OnrampVirtualAccountGetResponsesContentApplicationJsonSchemaError:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
      required:
        - statusCode
        - message
      title: ApiV2OnrampVirtualAccountGetResponsesContentApplicationJsonSchemaError
    Get-virtual-account-statusRequestBadRequestError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV2OnrampVirtualAccountGetResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: Get-virtual-account-statusRequestBadRequestError
    Get-virtual-account-statusRequestUnauthorizedError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV2OnrampVirtualAccountGetResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: Get-virtual-account-statusRequestUnauthorizedError
    Get-virtual-account-statusRequestNotFoundError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV2OnrampVirtualAccountGetResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: Get-virtual-account-statusRequestNotFoundError
    Get-virtual-account-statusRequestInternalServerError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV2OnrampVirtualAccountGetResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: Get-virtual-account-statusRequestInternalServerError

```

## Examples

### Account Creation Completed



**Response**

```json
{
  "data": {
    "status": "COMPLETED",
    "message": "Account creation COMPLETED successfully"
  }
}
```

**SDK Code**

```python Account Creation Completed
import requests

url = "https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account"

querystring = {"quoteId":""}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript Account Creation Completed
const url = 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Account Creation Completed
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId="

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Account Creation Completed
require 'uri'
require 'net/http'

url = URI("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java Account Creation Completed
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=")
  .asString();
```

```php Account Creation Completed
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=');

echo $response->getBody();
```

```csharp Account Creation Completed
using RestSharp;

var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift Account Creation Completed
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Account Creation Initiated



**Response**

```json
{
  "data": {
    "status": "INITIATED",
    "message": "Account creation INITIATED successfully"
  }
}
```

**SDK Code**

```python Account Creation Initiated
import requests

url = "https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account"

querystring = {"quoteId":""}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript Account Creation Initiated
const url = 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Account Creation Initiated
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId="

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Account Creation Initiated
require 'uri'
require 'net/http'

url = URI("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java Account Creation Initiated
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=")
  .asString();
```

```php Account Creation Initiated
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=');

echo $response->getBody();
```

```csharp Account Creation Initiated
using RestSharp;

var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift Account Creation Initiated
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Account Creation Failed



**Response**

```json
{
  "data": {
    "status": "FAILED",
    "message": "addressLine1 contains invalid characters. Only letters, numbers, '/-?:().' and spaces are allowed (no leading spaces)"
  }
}
```

**SDK Code**

```python Account Creation Failed
import requests

url = "https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account"

querystring = {"quoteId":""}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript Account Creation Failed
const url = 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Account Creation Failed
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId="

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Account Creation Failed
require 'uri'
require 'net/http'

url = URI("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java Account Creation Failed
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=")
  .asString();
```

```php Account Creation Failed
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=');

echo $response->getBody();
```

```csharp Account Creation Failed
using RestSharp;

var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift Account Creation Failed
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account?quoteId=")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```