Merge Vouchers

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

Use this endpoint to perform a Collapse operation. Collapsing will automatically find all active vouchers on a user’s account matching the provided VoucherType and aggregate their funds into a single, unified voucher pocket.

Request

Parameters

Field	Type	Requirement	Description
Username	String	Required	The username of the account.
VoucherType	String	Required	The identifier of the voucher type to target.
Community	String	Optional	Explicitly filter the merge operation to a specific community space.
Currency	String	Optional	The currency context for the merge. Defaults to community currency.
CollapseOtherCommunities	String	Optional	Set to true to siphon and merge funds universally across all communities the user belongs to (restricted to communities the acting bearer token has authorization for).
Metadata	String	Optional	Any other detail to store with this transaction.

Example Body

{
  "Username": "27820000000",
  "VoucherType": "168Cash",
  "Community": "",
  "Currency": "ZAR",
  "CollapseOtherCommunities": "true",
  "Metadata": ""
}

Response

Parameters

Field	Type	Description
TID	String	TID of the executed operation.
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",
    "State": "Success",
    "Status": "1",
    "Error": ""
}

cURL

curl -X POST '{api-url}/mergeVouchers?ns={community}' \
-H 'Authorization: bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"Username":"27820000000","VoucherType":"168Cash","Community":"","Currency":"ZAR","CollapseOtherCommunities":"true","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}/mergeVouchers?ns={community}");
        request.Headers.Add("Authorization", "bearer YOUR_TOKEN");

        var jsonPayload = @"{
  ""Username"": ""27820000000"",
  ""VoucherType"": ""168Cash"",
  ""Community"": """",
  ""Currency"": ""ZAR"",
  ""CollapseOtherCommunities"": ""true"",
  ""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}/mergeVouchers?ns={community}"
  payload := strings.NewReader(`{"Username":"27820000000","VoucherType":"168Cash","Community":"","Currency":"ZAR","CollapseOtherCommunities":"true","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 = """
                {
  "Username": "27820000000",
  "VoucherType": "168Cash",
  "Community": "",
  "Currency": "ZAR",
  "CollapseOtherCommunities": "true",
  "Metadata": ""
}
                """;

        var request = HttpRequest.newBuilder()
                .uri(URI.create("{api-url}/mergeVouchers?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}/mergeVouchers?ns={community}';
    const payload = {
    "Username": "27820000000",
    "VoucherType": "168Cash",
    "Community": "",
    "Currency": "ZAR",
    "CollapseOtherCommunities": "true",
    "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}/mergeVouchers?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 => '{
  "Username": "27820000000",
  "VoucherType": "168Cash",
  "Community": "",
  "Currency": "ZAR",
  "CollapseOtherCommunities": "true",
  "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}/mergeVouchers?ns={community}"
payload = {
  "Username": "27820000000",
  "VoucherType": "168Cash",
  "Community": "",
  "Currency": "ZAR",
  "CollapseOtherCommunities": "true",
  "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}/mergeVouchers?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({
  "Username": "27820000000",
  "VoucherType": "168Cash",
  "Community": "",
  "Currency": "ZAR",
  "CollapseOtherCommunities": "true",
  "Metadata": ""
})

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