View Voucher Type

POST {api-url}/viewVoucherType?ns={community}

Retrieve the full set of configuration parameters for a specified voucher type.

Request

Parameters

Field	Type	Requirement	Description
VoucherType	String	Required	The unique identifier string for the voucher type.
Metadata	String	Optional	Any other detail to store with this request.

Example Body

{
  "VoucherType": "168Cash",
  "Metadata": ""
}

Response

Parameters

Field	Type	Description
TID	String	TID of the executed operation.
VoucherType	String	The unique identifier string for the voucher type.
Community	String	The community the voucher type operates in.
DisplayName	String	The user-facing display name.
Locked	String	If 1, vouchers created under this type are locked.
AutoLock	String	If 1, vouchers automatically lock after a transaction.
VSettle	String	If 1, vouchers regenerate their voucher number after spending.
VAccumulate	String	If 1, funds accumulate into a single voucher pocket.
WithdrawFee	String	The fixed withdrawal fee in cents.
TransactionOverrides	String	The tilde-separated list of TTs allowed to bypass standard restrictions (~2~, ~4~, ~6~, ~26~).
IsCard	String	Frontend filtering flag specifying if this voucher type represents isolated physical cards.
VMetadata	String	Restricted basket rules mapping to the voucher’s metadata.
State	String	Transaction state (Success or Failed).
Status	String	Transaction status code (1 or negative error code).
Error	String	Failure reason, if applicable.

Example Body

{
    "TID": "15000000000",
    "VoucherType": "168Cash",
    "Community": "celbux",
    "DisplayName": "Celbux Cash",
    "Locked": "0",
    "AutoLock": "0",
    "VSettle": "1",
    "VAccumulate": "1",
    "WithdrawFee": "1000",
    "TransactionOverrides": "~4~6~26~",
    "IsCard": "false",
    "State": "Success",
    "Status": "1",
    "Error": ""
}

cURL

curl -X POST '{api-url}/viewVoucherType?ns={community}' \
-H 'Authorization: bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"VoucherType":"168Cash","Metadata":""}'

C#

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        var request = new HttpRequestMessage(HttpMethod.Post, "{api-url}/viewVoucherType?ns={community}");
        request.Headers.Add("Authorization", "bearer YOUR_TOKEN");

        var jsonPayload = @"{
  ""VoucherType"": ""168Cash"",
  ""Metadata"": """"
}";
        request.Content = new StringContent(jsonPayload, Encoding.UTF8, "application/json");

        var response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Go

package main

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

func main() {
  url := "{api-url}/viewVoucherType?ns={community}"
  payload := strings.NewReader(`{"VoucherType":"168Cash","Metadata":""}`)

  req, _ := http.NewRequest("POST", url, payload)
  req.Header.Add("Authorization", "bearer YOUR_TOKEN")
  req.Header.Add("Content-Type", "application/json")

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

  body, _ := ioutil.ReadAll(res.Body)
  fmt.Println(string(body))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ApiRequest {
    public static void main(String[] args) throws Exception {
        var payload = """
                {
  "VoucherType": "168Cash",
  "Metadata": ""
}
                """;

        var request = HttpRequest.newBuilder()
                .uri(URI.create("{api-url}/viewVoucherType?ns={community}"))
                .header("Authorization", "bearer YOUR_TOKEN")
                .header("Content-Type", "application/json")
                .POST(HttpRequest.BodyPublishers.ofString(payload))
                .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Node.js

// Requires Node.js v18+
(async () => {
    const url = '{api-url}/viewVoucherType?ns={community}';
    const payload = {
    "VoucherType": "168Cash",
    "Metadata": ""
};

    try {
        const response = await fetch(url, {
            method: 'POST',
            headers: {
                'Authorization': 'bearer YOUR_TOKEN',
                'Content-Type': 'application/json'
            },
            body: JSON.stringify(payload)
        });
        const data = await response.json();
        console.log(data);
    } catch (error) {
        console.error('Error:', error);
    }
})();

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{api-url}/viewVoucherType?ns={community}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "VoucherType": "168Cash",
  "Metadata": ""
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: bearer YOUR_TOKEN',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;

Python

import requests
import json

url = "{api-url}/viewVoucherType?ns={community}"
payload = {
  "VoucherType": "168Cash",
  "Metadata": ""
}

headers = {
    "Authorization": "bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

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

Ruby

require 'uri'
require 'net/http'
require 'json'

url = URI("{api-url}/viewVoucherType?ns={community}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'bearer YOUR_TOKEN'
request["Content-Type"] = 'application/json'

request.body = JSON.dump({
  "VoucherType": "168Cash",
  "Metadata": ""
})

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