Versioning

Pin account to a version

Pin your account to an API version, so you no longer have to send X-Api-Version on every call.

Send the version you want in target_version. The response tells you the version you were on and the one you are on now.

Pins only move forward. A version older than your current pin is refused. Pinning to the version you are already on is safe and changes nothing.

After pinning, X-Api-Version is optional. Send it only when you want one request to use a different version — the header still wins over your pin.

POST

versioning

upgrade

Pin account to a version

curl --request POST \
  --url https://api.balampay.com/sandbox/v1/versioning/upgrade \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "target_version": "2026-04-14"
}
'

import requests

url = "https://api.balampay.com/sandbox/v1/versioning/upgrade"

payload = { "target_version": "2026-04-14" }
headers = {
    "Authorization": "Bearer <token>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({target_version: '2026-04-14'})
};

fetch('https://api.balampay.com/sandbox/v1/versioning/upgrade', 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.balampay.com/sandbox/v1/versioning/upgrade",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'target_version' => '2026-04-14'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.balampay.com/sandbox/v1/versioning/upgrade"

	payload := strings.NewReader("{\n  \"target_version\": \"2026-04-14\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.balampay.com/sandbox/v1/versioning/upgrade")
  .header("Authorization", "Bearer <token>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target_version\": \"2026-04-14\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/sandbox/v1/versioning/upgrade")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"target_version\": \"2026-04-14\"\n}"

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

{
  "previous_version": "2025-01-01",
  "current_version": "2026-04-14"
}

Authorizations

Authorization

string

header

required

The data.access_token value from Get access token.

x-api-key

string

header

required

API key issued by Kira.

Headers

X-Api-Version

string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-04-14"

Body

application/json

target_version

string

required

The version to pin your account to. Use a version this site documents — 2026-04-14 or 2026-06-01.

A version Kira does not support is refused, and so is a version older than your current pin. The error names every version the API accepts.

Example:

"2026-04-14"

Response

Your account is pinned. Both versions come back so you can confirm the move.

previous_version

string

The version your account was on before this call. An account that was never pinned reports 2025-01-01.

current_version

string

The version your account is on now. It equals target_version.

Pin account to a version

curl --request POST \
  --url https://api.balampay.com/sandbox/v1/versioning/upgrade \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "target_version": "2026-04-14"
}
'

import requests

url = "https://api.balampay.com/sandbox/v1/versioning/upgrade"

payload = { "target_version": "2026-04-14" }
headers = {
    "Authorization": "Bearer <token>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({target_version: '2026-04-14'})
};

fetch('https://api.balampay.com/sandbox/v1/versioning/upgrade', 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.balampay.com/sandbox/v1/versioning/upgrade",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'target_version' => '2026-04-14'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.balampay.com/sandbox/v1/versioning/upgrade"

	payload := strings.NewReader("{\n  \"target_version\": \"2026-04-14\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.balampay.com/sandbox/v1/versioning/upgrade")
  .header("Authorization", "Bearer <token>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target_version\": \"2026-04-14\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/sandbox/v1/versioning/upgrade")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"target_version\": \"2026-04-14\"\n}"

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

{
  "previous_version": "2025-01-01",
  "current_version": "2026-04-14"
}

Across the API

Authentication

Versioning

Users

Virtual Accounts

Recipients

Quotations

Payouts

Catalogs

Pin account to a version

Authorizations

Headers

Body

Response