Skip to main content
POST
/
v1
/
users
/
{userId}
/
virtual-accounts
Create Virtual Account
curl --request POST \
  --url https://api.cadanapay.com/v1/users/{userId}/virtual-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "USD",
  "customIdentification": {
    "type": "ssn",
    "number": "123-45-6789"
  },
  "jobInformation": {
    "employerName": "Acme Corp",
    "address": {
      "line1": "123 Main St",
      "city": "Anytown",
      "postalCode": "12345",
      "state": "CA",
      "countryCode": "US"
    },
    "employerWebsite": "",
    "title": "Software Engineer",
    "type": "full-time",
    "netPay": {
      "amount": 10000,
      "currency": "USD"
    },
    "frequency": "monthly",
    "contractStartDate": "2021-01-01",
    "contractEndDate": "2025-05-06"
  },
  "suppressNotification": true
}
'
import requests

url = "https://api.cadanapay.com/v1/users/{userId}/virtual-accounts"

payload = {
    "currency": "USD",
    "customIdentification": {
        "type": "ssn",
        "number": "123-45-6789"
    },
    "jobInformation": {
        "employerName": "Acme Corp",
        "address": {
            "line1": "123 Main St",
            "city": "Anytown",
            "postalCode": "12345",
            "state": "CA",
            "countryCode": "US"
        },
        "employerWebsite": "",
        "title": "Software Engineer",
        "type": "full-time",
        "netPay": {
            "amount": 10000,
            "currency": "USD"
        },
        "frequency": "monthly",
        "contractStartDate": "2021-01-01",
        "contractEndDate": "2025-05-06"
    },
    "suppressNotification": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    currency: 'USD',
    customIdentification: {type: 'ssn', number: '123-45-6789'},
    jobInformation: {
      employerName: 'Acme Corp',
      address: {
        line1: '123 Main St',
        city: 'Anytown',
        postalCode: '12345',
        state: 'CA',
        countryCode: 'US'
      },
      employerWebsite: '',
      title: 'Software Engineer',
      type: 'full-time',
      netPay: {amount: 10000, currency: 'USD'},
      frequency: 'monthly',
      contractStartDate: '2021-01-01',
      contractEndDate: '2025-05-06'
    },
    suppressNotification: true
  })
};

fetch('https://api.cadanapay.com/v1/users/{userId}/virtual-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadanapay.com/v1/users/{userId}/virtual-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'currency' => 'USD',
    'customIdentification' => [
        'type' => 'ssn',
        'number' => '123-45-6789'
    ],
    'jobInformation' => [
        'employerName' => 'Acme Corp',
        'address' => [
                'line1' => '123 Main St',
                'city' => 'Anytown',
                'postalCode' => '12345',
                'state' => 'CA',
                'countryCode' => 'US'
        ],
        'employerWebsite' => '',
        'title' => 'Software Engineer',
        'type' => 'full-time',
        'netPay' => [
                'amount' => 10000,
                'currency' => 'USD'
        ],
        'frequency' => 'monthly',
        'contractStartDate' => '2021-01-01',
        'contractEndDate' => '2025-05-06'
    ],
    'suppressNotification' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.cadanapay.com/v1/users/{userId}/virtual-accounts"

	payload := strings.NewReader("{\n  \"currency\": \"USD\",\n  \"customIdentification\": {\n    \"type\": \"ssn\",\n    \"number\": \"123-45-6789\"\n  },\n  \"jobInformation\": {\n    \"employerName\": \"Acme Corp\",\n    \"address\": {\n      \"line1\": \"123 Main St\",\n      \"city\": \"Anytown\",\n      \"postalCode\": \"12345\",\n      \"state\": \"CA\",\n      \"countryCode\": \"US\"\n    },\n    \"employerWebsite\": \"\",\n    \"title\": \"Software Engineer\",\n    \"type\": \"full-time\",\n    \"netPay\": {\n      \"amount\": 10000,\n      \"currency\": \"USD\"\n    },\n    \"frequency\": \"monthly\",\n    \"contractStartDate\": \"2021-01-01\",\n    \"contractEndDate\": \"2025-05-06\"\n  },\n  \"suppressNotification\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.cadanapay.com/v1/users/{userId}/virtual-accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"currency\": \"USD\",\n  \"customIdentification\": {\n    \"type\": \"ssn\",\n    \"number\": \"123-45-6789\"\n  },\n  \"jobInformation\": {\n    \"employerName\": \"Acme Corp\",\n    \"address\": {\n      \"line1\": \"123 Main St\",\n      \"city\": \"Anytown\",\n      \"postalCode\": \"12345\",\n      \"state\": \"CA\",\n      \"countryCode\": \"US\"\n    },\n    \"employerWebsite\": \"\",\n    \"title\": \"Software Engineer\",\n    \"type\": \"full-time\",\n    \"netPay\": {\n      \"amount\": 10000,\n      \"currency\": \"USD\"\n    },\n    \"frequency\": \"monthly\",\n    \"contractStartDate\": \"2021-01-01\",\n    \"contractEndDate\": \"2025-05-06\"\n  },\n  \"suppressNotification\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.cadanapay.com/v1/users/{userId}/virtual-accounts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"currency\": \"USD\",\n  \"customIdentification\": {\n    \"type\": \"ssn\",\n    \"number\": \"123-45-6789\"\n  },\n  \"jobInformation\": {\n    \"employerName\": \"Acme Corp\",\n    \"address\": {\n      \"line1\": \"123 Main St\",\n      \"city\": \"Anytown\",\n      \"postalCode\": \"12345\",\n      \"state\": \"CA\",\n      \"countryCode\": \"US\"\n    },\n    \"employerWebsite\": \"\",\n    \"title\": \"Software Engineer\",\n    \"type\": \"full-time\",\n    \"netPay\": {\n      \"amount\": 10000,\n      \"currency\": \"USD\"\n    },\n    \"frequency\": \"monthly\",\n    \"contractStartDate\": \"2021-01-01\",\n    \"contractEndDate\": \"2025-05-06\"\n  },\n  \"suppressNotification\": true\n}"

response = http.request(request)
puts response.read_body
{
  "code": "invalid_request_body",
  "message": "The request body provided is not valid",
  "params": {
    "field": "Value is invalid."
  }
}
{
  "code": "internal_error",
  "message": "An unexpected error occurred. Please try again later."
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

​
userId
string<uuid>
required

The unique identifier for the user

Example:

"c06f3427-3bbe-4d70-9a54-28acda267e48"

Body

application/json
​
currency
string
required

ISO 4217 currency code for the virtual account

Example:

"USD"

​
jobInformation
object
required
​
customIdentification
object
​
suppressNotification
boolean

Whether to suppress notifications for this virtual account, defaults to false

Example:

true

Response

Successful operation