List Group Types
curl --request GET \
--url https://api.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types', 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.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"object": "<string>",
"type": "<string>",
"name": "<string>",
"description": "<string>",
"currencies": [
{}
]
}
]
}Virtual Account Groups
List Group Types
List the virtual account group types that can be opened for an account
GET
/
v1
/
customers
/
{customer_id}
/
virtual-account-group-types
List Group Types
curl --request GET \
--url https://api.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types', 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.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/v1/customers/{customer_id}/virtual-account-group-types")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"object": "<string>",
"type": "<string>",
"name": "<string>",
"description": "<string>",
"currencies": [
{}
]
}
]
}Works on any account you own. Create Virtual Account Group covers who can open a group and what the account needs first.
A virtual account group is the onboarding relationship that sits behind an account’s virtual accounts. You open a group of a given type, satisfy the KYC/KYB requirements raised against it, and only then can virtual accounts be created under it.
An account can hold several groups. Each group is verified and enabled on its own and holds its own virtual accounts.
This endpoint lists the group types available to open. The list is the same for every customer in an environment. The
customer_id in the path scopes the call to your customer; it does not filter the catalogue.
Take type from an entry here and pass it as the type body field of Create Virtual Account Group.
The response is a plain {"items": [...]} object. It is not paginated, carries no page, size, total or pages, and takes no query parameters.
Requires an API key with read access on the virtual_accounts scope.
Path Parameters
string
required
The customer’s external ID (starts with
cus_)Response
array
Group type objects. The order follows Hop’s configuration and is stable within an environment.
Show Group Type Fields
Show Group Type Fields
string
Always returns
"virtual_account_group_type"string
Stable identifier of the type, for example
business_virtual_accounts, and the value to send to Create Virtual Account Group.string
Display name for the type
string
Product description, or
null when the type carries nonearray
Currency codes a virtual account under this group may be opened in, for example
["USD", "EUR", "GBP"]. An empty array means no currency is configured for the type.Errors
| Status | code | When |
|---|---|---|
404 | RESOURCE_NOT_FOUND | customer_id is unknown or is not your customer |
Request Example
curl "https://api.hopnow.io/v1/customers/cus_8xq2m4v7r1t5w9p3k6n0z2bd/virtual-account-group-types" \
-H "X-API-Key: your_api_key" \
-H "X-Signature: hmac_signature" \
-H "X-Timestamp: 1234567890" \
-H "X-Nonce: abc123"
Response Example
{
"items": [
{
"object": "virtual_account_group_type",
"type": "business_virtual_accounts",
"name": "Business Virtual Accounts",
"description": null,
"currencies": ["USD", "EUR", "GBP"]
}
]
}