HitPay Product Guide and API docs.

Get virtual account details

curl --request GET \
  --url https://api.hit-pay.com/v1/virtual-accounts/{virtual_account_id} \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'

import requests

url = "https://api.hit-pay.com/v1/virtual-accounts/{virtual_account_id}"

headers = {"X-BUSINESS-API-KEY": "<x-business-api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-BUSINESS-API-KEY': '<x-business-api-key>'}};

fetch('https://api.hit-pay.com/v1/virtual-accounts/{virtual_account_id}', 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.hit-pay.com/v1/virtual-accounts/{virtual_account_id}",
  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-BUSINESS-API-KEY: <x-business-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.hit-pay.com/v1/virtual-accounts/{virtual_account_id}"

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

	req.Header.Add("X-BUSINESS-API-KEY", "<x-business-api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hit-pay.com/v1/virtual-accounts/{virtual_account_id}")

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

request = Net::HTTP::Get.new(url)
request["X-BUSINESS-API-KEY"] = '<x-business-api-key>'

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "reference": "<string>",
    "payment_provider": "<string>",
    "payment_provider_method": "<string>",
    "payment_provider_method_logos": [
      {
        "method": "<string>",
        "iconName": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "sm": "<string>",
        "md": "<string>",
        "lg": "<string>",
        "svg": "<string>",
        "svg_square": "<string>"
      }
    ],
    "payment_provider_method_main_logo": {
      "method": "<string>",
      "iconName": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "sm": "<string>",
      "md": "<string>",
      "lg": "<string>",
      "svg": "<string>",
      "svg_square": "<string>"
    },
    "supported_currencies": [
      "<string>"
    ],
    "transfer_types": [
      "<string>"
    ],
    "address": "<string>",
    "status": "<string>",
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "display_name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "errors": "<array>"
}

{
  "message": "<string>",
  "errors": "<array>"
}

{
  "message": "<string>",
  "errors": "<array>"
}

GET

virtual-accounts

{virtual_account_id}

Get virtual account details

curl --request GET \
  --url https://api.hit-pay.com/v1/virtual-accounts/{virtual_account_id} \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'

import requests

url = "https://api.hit-pay.com/v1/virtual-accounts/{virtual_account_id}"

headers = {"X-BUSINESS-API-KEY": "<x-business-api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-BUSINESS-API-KEY': '<x-business-api-key>'}};

fetch('https://api.hit-pay.com/v1/virtual-accounts/{virtual_account_id}', 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.hit-pay.com/v1/virtual-accounts/{virtual_account_id}",
  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-BUSINESS-API-KEY: <x-business-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.hit-pay.com/v1/virtual-accounts/{virtual_account_id}"

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

	req.Header.Add("X-BUSINESS-API-KEY", "<x-business-api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hit-pay.com/v1/virtual-accounts/{virtual_account_id}")

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

request = Net::HTTP::Get.new(url)
request["X-BUSINESS-API-KEY"] = '<x-business-api-key>'

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "reference": "<string>",
    "payment_provider": "<string>",
    "payment_provider_method": "<string>",
    "payment_provider_method_logos": [
      {
        "method": "<string>",
        "iconName": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "sm": "<string>",
        "md": "<string>",
        "lg": "<string>",
        "svg": "<string>",
        "svg_square": "<string>"
      }
    ],
    "payment_provider_method_main_logo": {
      "method": "<string>",
      "iconName": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "sm": "<string>",
      "md": "<string>",
      "lg": "<string>",
      "svg": "<string>",
      "svg_square": "<string>"
    },
    "supported_currencies": [
      "<string>"
    ],
    "transfer_types": [
      "<string>"
    ],
    "address": "<string>",
    "status": "<string>",
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "display_name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "errors": "<array>"
}

{
  "message": "<string>",
  "errors": "<array>"
}

{
  "message": "<string>",
  "errors": "<array>"
}

Headers

X-BUSINESS-API-KEY

string

required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Path Parameters

virtual_account_id

string<uuid>

required

The virtual account ID

Response

Successful operation

data

object

Show child attributes

Last modified on June 9, 2026