Settle Voucher

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

Use this endpoint to trigger a settlement on a voucher pocket. If the ~2~ override is configured on the underlying voucher type’s TransactionOverrides, the funds will be consumed directly back into the user’s root cash balance. Otherwise, this endpoint will simply regenerate a fresh, secure voucher number for the pocket while retaining the existing balance.

Passing 0 for amount will act upon the full balance of the voucher.

Request

Parameters

Field	Type	Requirement	Description
VoucherNo	String	Required	Source of the funds. A valid Celbux voucher number.
Amount	String	Required	Transaction amount in cents. Pass 0 to consume full balance.
Metadata	String	Optional	Any other detail to store with this transaction.

Example Body

{
  "Amount": "20000",
  "VoucherNo": "168-29543-25430",
  "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}/settleVoucher?ns={community}' \
-H 'Authorization: bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"Amount":"20000","VoucherNo":"168-29543-25430","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}/settleVoucher?ns={community}");
        request.Headers.Add("Authorization", "bearer YOUR_TOKEN");

        var jsonPayload = @"{
  ""Amount"": ""20000"",
  ""VoucherNo"": ""168-29543-25430"",
  ""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}/settleVoucher?ns={community}"
  payload := strings.NewReader(`{"Amount":"20000","VoucherNo":"168-29543-25430","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 = """
                {
  "Amount": "20000",
  "VoucherNo": "168-29543-25430",
  "Metadata": ""
}
                """;

        var request = HttpRequest.newBuilder()
                .uri(URI.create("{api-url}/settleVoucher?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}/settleVoucher?ns={community}';
    const payload = {
    "Amount": "20000",
    "VoucherNo": "168-29543-25430",
    "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}/settleVoucher?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 => '{
  "Amount": "20000",
  "VoucherNo": "168-29543-25430",
  "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}/settleVoucher?ns={community}"
payload = {
  "Amount": "20000",
  "VoucherNo": "168-29543-25430",
  "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}/settleVoucher?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({
  "Amount": "20000",
  "VoucherNo": "168-29543-25430",
  "Metadata": ""
})

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