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

# Create Virtual Account

POST https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account
Content-Type: application/json

The **Create Virtual Account** is an **authenticated API** that initiates virtual account creation for the authenticated user.

Reference: https://docs.transak.com/api/whitelabel/payments/open-banking/create-virtual-account

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: whitelabel-api
  version: 1.0.0
paths:
  /api/v2/onramp/virtual-account:
    post:
      operationId: create-virtual-account
      summary: Create Virtual Account
      description: >-
        The **Create Virtual Account** is an **authenticated API** that
        initiates virtual account creation for the authenticated user.
      tags:
        - subpackage_openBanking
      parameters:
        - name: x-user-ip
          in: header
          description: >-
            End user's originating IP. More details
            [here](/guides/mandatory-security-changes#user-ip-header-in-apis)
          required: true
          schema:
            type: string
        - name: x-api-key
          in: header
          description: Partner API Key present in Transak Dashboard.
          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 - Virtual Account Status
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/openBanking:create-virtual-account_Response_200
        '400':
          description: 400 - Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/openBanking:Create-virtual-accountRequestBadRequestError
        '401':
          description: 401 - Unauthorized
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/openBanking:Create-virtual-accountRequestUnauthorizedError
        '403':
          description: 403 - Forbidden
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/openBanking:Create-virtual-accountRequestForbiddenError
        '404':
          description: 404 - User Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/openBanking:Create-virtual-accountRequestNotFoundError
        '500':
          description: 500 - Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/openBanking:Create-virtual-accountRequestInternalServerError
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                quoteId:
                  type: string
                  description: Quote ID generated from `api/v2/lookup/quotes`
              required:
                - quoteId
servers:
  - url: https://api-gateway-stg.transak.com
    description: Staging
components:
  schemas:
    openBanking:ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaDataStatus:
      type: string
      enum:
        - INITIATED
        - COMPLETED
        - FAILED
      description: Current status of the virtual account creation.
      title: >-
        ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaDataStatus
    openBanking:ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        status:
          $ref: >-
            #/components/schemas/openBanking:ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaDataStatus
          description: Current status of the virtual account creation.
        message:
          type: string
      required:
        - status
        - message
      title: ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaData
    openBanking:create-virtual-account_Response_200:
      type: object
      properties:
        data:
          $ref: >-
            #/components/schemas/openBanking:ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaData
      required:
        - data
      title: create-virtual-account_Response_200
    openBanking:ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaError:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
      required:
        - statusCode
        - message
      title: ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaError
    openBanking:Create-virtual-accountRequestBadRequestError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/openBanking:ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: Create-virtual-accountRequestBadRequestError
    openBanking:Create-virtual-accountRequestUnauthorizedError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/openBanking:ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: Create-virtual-accountRequestUnauthorizedError
    openBanking:Create-virtual-accountRequestForbiddenError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/openBanking:ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: Create-virtual-accountRequestForbiddenError
    openBanking:Create-virtual-accountRequestNotFoundError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/openBanking:ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: Create-virtual-accountRequestNotFoundError
    openBanking:Create-virtual-accountRequestInternalServerError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/openBanking:ApiV2OnrampVirtualAccountPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: Create-virtual-accountRequestInternalServerError

```

## Examples

### Account Creation Initiated



**Request**

```json
undefined
```

**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"

headers = {
    "x-user-ip": "",
    "x-api-key": "",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript Account Creation Initiated
const url = 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account';
const options = {
  method: 'POST',
  headers: {'x-user-ip': '', 'x-api-key': '', 'Content-Type': 'application/json'},
  body: undefined
};

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"

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

	req.Header.Add("x-user-ip", "")
	req.Header.Add("x-api-key", "")
	req.Header.Add("Content-Type", "application/json")

	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")

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

request = Net::HTTP::Post.new(url)
request["x-user-ip"] = ''
request["x-api-key"] = ''
request["Content-Type"] = 'application/json'

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.post("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account")
  .header("x-user-ip", "")
  .header("x-api-key", "")
  .header("Content-Type", "application/json")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account', [
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '',
    'x-user-ip' => '',
  ],
]);

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

```csharp Account Creation Initiated
using RestSharp;

var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account");
var request = new RestRequest(Method.POST);
request.AddHeader("x-user-ip", "");
request.AddHeader("x-api-key", "");
request.AddHeader("Content-Type", "application/json");
IRestResponse response = client.Execute(request);
```

```swift Account Creation Initiated
import Foundation

let headers = [
  "x-user-ip": "",
  "x-api-key": "",
  "Content-Type": "application/json"
]

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

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 Completed



**Request**

```json
undefined
```

**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"

headers = {
    "x-user-ip": "",
    "x-api-key": "",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript Account Creation Completed
const url = 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account';
const options = {
  method: 'POST',
  headers: {'x-user-ip': '', 'x-api-key': '', 'Content-Type': 'application/json'},
  body: undefined
};

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"

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

	req.Header.Add("x-user-ip", "")
	req.Header.Add("x-api-key", "")
	req.Header.Add("Content-Type", "application/json")

	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")

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

request = Net::HTTP::Post.new(url)
request["x-user-ip"] = ''
request["x-api-key"] = ''
request["Content-Type"] = 'application/json'

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.post("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account")
  .header("x-user-ip", "")
  .header("x-api-key", "")
  .header("Content-Type", "application/json")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account', [
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '',
    'x-user-ip' => '',
  ],
]);

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

```csharp Account Creation Completed
using RestSharp;

var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account");
var request = new RestRequest(Method.POST);
request.AddHeader("x-user-ip", "");
request.AddHeader("x-api-key", "");
request.AddHeader("Content-Type", "application/json");
IRestResponse response = client.Execute(request);
```

```swift Account Creation Completed
import Foundation

let headers = [
  "x-user-ip": "",
  "x-api-key": "",
  "Content-Type": "application/json"
]

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

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



**Request**

```json
undefined
```

**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"

headers = {
    "x-user-ip": "",
    "x-api-key": "",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript Account Creation Failed
const url = 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account';
const options = {
  method: 'POST',
  headers: {'x-user-ip': '', 'x-api-key': '', 'Content-Type': 'application/json'},
  body: undefined
};

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"

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

	req.Header.Add("x-user-ip", "")
	req.Header.Add("x-api-key", "")
	req.Header.Add("Content-Type", "application/json")

	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")

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

request = Net::HTTP::Post.new(url)
request["x-user-ip"] = ''
request["x-api-key"] = ''
request["Content-Type"] = 'application/json'

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.post("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account")
  .header("x-user-ip", "")
  .header("x-api-key", "")
  .header("Content-Type", "application/json")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account', [
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '',
    'x-user-ip' => '',
  ],
]);

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

```csharp Account Creation Failed
using RestSharp;

var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account");
var request = new RestRequest(Method.POST);
request.AddHeader("x-user-ip", "");
request.AddHeader("x-api-key", "");
request.AddHeader("Content-Type", "application/json");
IRestResponse response = client.Execute(request);
```

```swift Account Creation Failed
import Foundation

let headers = [
  "x-user-ip": "",
  "x-api-key": "",
  "Content-Type": "application/json"
]

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

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()
```

### create-virtual-account_example



**Request**

```json
{
  "quoteId": ""
}
```

**Response**

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

**SDK Code**

```python create-virtual-account_example
import requests

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

payload = { "quoteId": "" }
headers = {
    "x-user-ip": "",
    "x-api-key": "",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript create-virtual-account_example
const url = 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account';
const options = {
  method: 'POST',
  headers: {'x-user-ip': '', 'x-api-key': '', 'Content-Type': 'application/json'},
  body: '{"quoteId":""}'
};

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

```go create-virtual-account_example
package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"quoteId\": \"\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-user-ip", "")
	req.Header.Add("x-api-key", "")
	req.Header.Add("Content-Type", "application/json")

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

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

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

}
```

```ruby create-virtual-account_example
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["x-user-ip"] = ''
request["x-api-key"] = ''
request["Content-Type"] = 'application/json'
request.body = "{\n  \"quoteId\": \"\"\n}"

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

```java create-virtual-account_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account")
  .header("x-user-ip", "")
  .header("x-api-key", "")
  .header("Content-Type", "application/json")
  .body("{\n  \"quoteId\": \"\"\n}")
  .asString();
```

```php create-virtual-account_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account', [
  'body' => '{
  "quoteId": ""
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '',
    'x-user-ip' => '',
  ],
]);

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

```csharp create-virtual-account_example
using RestSharp;

var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account");
var request = new RestRequest(Method.POST);
request.AddHeader("x-user-ip", "");
request.AddHeader("x-api-key", "");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"quoteId\": \"\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift create-virtual-account_example
import Foundation

let headers = [
  "x-user-ip": "",
  "x-api-key": "",
  "Content-Type": "application/json"
]
let parameters = ["quoteId": ""] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway-stg.transak.com/api/v2/onramp/virtual-account")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```