BluefinPayconex SDK

PayConex 4 client, generated from the OpenAPI spec.

Learn more about PayConex 4 at developers.bluefin.com/payconex.

This is an unofficial SDK for the PayConex 4 public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.

Learn more about Voxgig SDKs at voxgig.com/sdk.

TypeScript, Python, PHP, Golang, Ruby, Lua, C, Clojure, C++, C#, Dart, Elixir, Haskell, Java, JavaScript, Kotlin, OCaml, Perl, Rust, Scala, Swift, Zig SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.

Entities, not endpoints

This SDK exposes the API as 20 semantic entities that you call directly, instead of assembling URL paths and query strings. See the Entities table below for the full list. Entities are Capitalised to mark them as the primary surface, each with the operations they support (list, load, create, update, remove):

const client = new BluefinPayconexSDK()

Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.

Offline unit testing

Every SDK ships a built-in test mode that swaps the HTTP transport for an in-memory mock, so your unit tests run fully offline — no server, no network, and no credentials:

TypeScript

const client = BluefinPayconexSDK.test()
const threedsecurestatus = await client.ThreeDSecureStatus().load({ '3_d_id': 'example_3_d_id', account_id: 'example_account_id' })
// threedsecurestatus is a bare ThreeDSecureStatus populated with mock data
console.log(threedsecurestatus)

Python

client = BluefinPayconexSDK.test()
threedsecurestatus = client.ThreeDSecureStatus().load({"3_d_id": "example", "account_id": "example"})
print(threedsecurestatus)

PHP

// Seed fixture data so offline calls resolve without a live server.
$client = BluefinPayconexSDK::test([
    "entity" => ["threedsecurestatus" => ["test01" => []]],
]);
$threedsecurestatus = $client->ThreeDSecureStatus()->load(["3_d_id" => "example", "account_id" => "example"]);

Golang

client := sdk.Test()
result, err := client.ThreeDSecureStatus(nil).Load(
    nil, nil,
)

Ruby

# Seed fixture data so offline calls resolve without a live server.
client = BluefinPayconexSDK.test({
  "entity" => { "threedsecurestatus" => { "test01" => {} } },
})
threedsecurestatus = client.ThreeDSecureStatus.load({ "3_d_id" => "example", "account_id" => "example" })

Lua

local client = sdk.test()
local result, err = client:ThreeDSecureStatus():load({ ["3_d_id"] = "example", account_id = "example" })

C

#include "core/api.h"

BluefinPayconexSDK* client = test_sdk(NULL, NULL);
PNError* err = NULL;
Entity* three_d_secure_status = bluefinpayconex_three_d_secure_status(client, NULL);
voxgig_value* three_d_secure_status_rec = three_d_secure_status->vt->load(three_d_secure_status, cmap(2, "3_d_id", v_str("example"), "account_id", v_str("example")), NULL, &err);
printf("%s\n", voxgig_to_json(three_d_secure_status_rec));

Clojure

(require '[sdk.api :as api]
         '[sdk.entity.three_d_secure_status :as e-three_d_secure_status]
         '[voxgig.struct :as vs])

(def client (api/test-sdk nil nil))
(def three_d_secure_status (e-three_d_secure_status/load (api/three_d_secure_status client nil) (vs/jm "3_d_id" "example" "account_id" "example") nil))
(println three_d_secure_status)

C++

auto client = BluefinPayconexSDK::testSDK();
Value three_d_secure_status = client->three_d_secure_status()->load(vmap({{"3_d_id", Value("example")}, {"account_id", Value("example")}}), Value::undef());
std::cout << Struct::jsonify(three_d_secure_status) << std::endl;

C#

var client = BluefinPayconexSDK.TestSDK(null, null);
var threeDSecureStatus = client.ThreeDSecureStatus().Load(new Dictionary<string, object?> { ["3_d_id"] = "example", ["account_id"] = "example" });
Console.WriteLine(threeDSecureStatus);

Dart

import 'package:bluefin_payconex_sdk/BluefinPayconexSDK.dart';

Future<void> main() async {
  final client = BluefinPayconexSDK.test();
  final threedsecurestatus = await client.ThreeDSecureStatus().load({'3_d_id': 'example', 'account_id': 'example'});
  print(threedsecurestatus);
}

Elixir

alias BluefinPayconex.Helpers, as: H

sdk = BluefinPayconex.test()
three_d_secure_status = BluefinPayconex.three_d_secure_status(sdk)
record = BluefinPayconex.Entity.ThreeDSecureStatus.load(three_d_secure_status, H.deep(%{"3_d_id" => "example", "account_id" => "example"}))
IO.inspect(record)

Haskell

import qualified SdkClient as Sdk
import VoxgigStruct (Value (..), emptyMap)
import SdkHelpers (jo)

main :: IO ()
main = do
  sdk <- Sdk.testSdk0
  ent <- Sdk.three_d_secure_status sdk VNoval
  arg <- jo [("3_d_id", VStr "example"), ("account_id", VStr "example")]
  ctrl <- emptyMap
  three_d_secure_status <- Sdk.eLoad ent arg ctrl
  print three_d_secure_status

Java

BluefinPayconexSDK client = BluefinPayconexSDK.testSDK(null, null);
Object threeDSecureStatus = client.threeDSecureStatus(null).load(Map.of("3_d_id", "example", "account_id", "example"), null);
System.out.println(threeDSecureStatus);

JavaScript

const client = BluefinPayconexSDK.test()
const threedsecurestatus = await client.ThreeDSecureStatus().load({ '3_d_id': 'example_3_d_id', account_id: 'example_account_id' })
// threedsecurestatus is a bare entity populated with mock data
console.log(threedsecurestatus)

Kotlin

val client = BluefinPayconexSDK.testSDK(null, null)
val threeDSecureStatus = client.threeDSecureStatus(null).load(mutableMapOf<String, Any?>("3_d_id" to "example", "account_id" to "example"), null)
println(threeDSecureStatus)

OCaml

let () =
  let client = Sdk_client.test () in
  let result = (Sdk_client.three_d_secure_status client Noval).e_load (jo [("3_d_id", (Str "example")); ("account_id", (Str "example"))]) Noval in
  print_endline (stringify result)

Perl

use lib 'perl/lib';
use BluefinPayconexSDK;

my $client = BluefinPayconexSDK->test(undef, undef);
my $threedsecurestatus = $client->ThreeDSecureStatus->load({ '3_d_id' => 'example', 'account_id' => 'example' });
print "$threedsecurestatus->{id}\n";

Rust

use bluefin_payconex_sdk::{jo, test_sdk, Value};

let client = test_sdk(Value::Noval, Value::Noval);
let three_d_secure_status = client.three_d_secure_status(Value::Noval).load(jo(vec![("3_d_id", Value::str("example")), ("account_id", Value::str("example"))]), Value::Noval).unwrap();
println!("{:?}", three_d_secure_status);

Scala

val client = BluefinPayconexSDK.testSDK(null, null)
val threeDSecureStatus = client.threeDSecureStatus(null).load(java.util.Map.of("3_d_id", "example", "account_id", "example"), null)
println(threeDSecureStatus)

Swift

let client = BluefinPayconexSDK.testSDK(nil, nil)
let threeDSecureStatus = try client.ThreeDSecureStatus().load(VMap([("3_d_id", .string("example")), ("account_id", .string("example"))]), nil)
print(threeDSecureStatus)

Zig

const std = @import("std");
const sdk = @import("sdk");
const h = sdk.h;

const client = sdk.test_sdk(h.vnull(), h.vnull());
switch (client.three_d_secure_status(h.vnull()).load(h.jo(&.{.{ "3_d_id", h.vstr("example") }, .{ "account_id", h.vstr("example") }}), h.vnull())) {
    .ok => |three_d_secure_status| std.debug.print("{s}\n", .{h.stringify(three_d_secure_status)}),
    .err => |e| std.debug.print("load failed: {s}\n", .{e.msg}),
}

Packages

Quickstart

TypeScript

import { BluefinPayconexSDK } from '@voxgig-sdk/bluefin-payconex'

const client = new BluefinPayconexSDK({
  apikey: process.env.BLUEFIN_PAYCONEX_APIKEY,
})


// Load a specific accountupdatersubscriptionwithresult (returns a AccountUpdaterSubscriptionWithResult)
const accountupdatersubscriptionwithresult = await client.AccountUpdaterSubscriptionWithResult().load({
  account_id: 'example_account_id',
  subscription_id: 'example_subscription_id',
})
console.log(accountupdatersubscriptionwithresult)

See the TypeScript README for the full guide.

Surfaces

Use it from an AI agent (MCP)

The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:

cd go-mcp && go build -o bluefin-payconex-mcp .

Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):

{
  "mcpServers": {
    "bluefin-payconex": {
      "command": "/abs/path/to/bluefin-payconex-mcp"
    }
  }
}

Entities

The API exposes 20 entities:

The operations available across these entities are load, list, create, update, remove — see each entity’s own list above for exactly which it supports.

Quickstart in other languages

Python

import os
from bluefinpayconex_sdk import BluefinPayconexSDK

client = BluefinPayconexSDK({
    "apikey": os.environ.get("BLUEFIN_PAYCONEX_APIKEY"),
})

PHP

<?php
require_once 'bluefinpayconex_sdk.php';

$client = new BluefinPayconexSDK([
    "apikey" => getenv("BLUEFIN_PAYCONEX_APIKEY"),
]);

Golang

import sdk "github.com/voxgig-sdk/bluefin-payconex-sdk/go"

client := sdk.NewBluefinPayconexSDK(map[string]any{
    "apikey": os.Getenv("BLUEFIN_PAYCONEX_APIKEY"),
})


// Load a specific accountupdatersubscriptionwithresult
accountUpdaterSubscriptionWithResult, err := client.AccountUpdaterSubscriptionWithResult(nil).Load(
    map[string]any{"account_id": "example_account_id", "subscription_id": "example_subscription_id"}, nil,
)
if err != nil {
    panic(err)
}
fmt.Println(accountUpdaterSubscriptionWithResult)

Ruby

require_relative "BluefinPayconex_sdk"

client = BluefinPayconexSDK.new({
  "apikey" => ENV["BLUEFIN_PAYCONEX_APIKEY"],
})

Lua

local sdk = require("bluefin-payconex_sdk")

local client = sdk.new({
  apikey = os.getenv("BLUEFIN_PAYCONEX_APIKEY"),
})

C

#include "core/api.h"

BluefinPayconexSDK* client = bluefinpayconex_sdk_new(cmap(1,
    "apikey", v_str(getenv("BLUEFIN_PAYCONEX_APIKEY"))));
PNError* err = NULL;

Clojure

(require '[sdk.api :as api]
         '[sdk.entity.account_updater :as e-account_updater]
         '[voxgig.struct :as vs])

(def client (api/make-sdk (vs/jm "apikey" (System/getenv "BLUEFIN_PAYCONEX_APIKEY"))))

C++

#include <cstdlib>
#include "core/sdk.hpp"

using namespace sdk;

const char* apikey = std::getenv("BLUEFIN_PAYCONEX_APIKEY");
auto client = std::make_shared<BluefinPayconexSDK>(vmap({
    {"apikey", Value(apikey ? apikey : "")},
}));

C#

using BluefinPayconexSdk;

var client = new BluefinPayconexSDK(new Dictionary<string, object?>
{
    ["apikey"] = Environment.GetEnvironmentVariable("BLUEFIN_PAYCONEX_APIKEY"),
});

Dart

import 'dart:io';
import 'package:bluefin_payconex_sdk/BluefinPayconexSDK.dart';

Future<void> main() async {
  final client = BluefinPayconexSDK({
    'apikey': Platform.environment['BLUEFIN_PAYCONEX_APIKEY'],
  });

}

Elixir

alias BluefinPayconex.Helpers, as: H

sdk = BluefinPayconex.new(H.deep(%{"apikey" => System.get_env("BLUEFIN_PAYCONEX_APIKEY")}))

account_updater = BluefinPayconex.account_updater(sdk)

Haskell

import System.Environment (lookupEnv)
import qualified SdkClient as Sdk
import VoxgigStruct (Value (..), emptyMap)
import SdkHelpers (jo)

main :: IO ()
main = do
  mkey <- lookupEnv "BLUEFIN_PAYCONEX_APIKEY"
  opts <- jo [("apikey", maybe VNoval VStr mkey)]
  sdk <- Sdk.newSdk opts

Java

import voxgig.bluefinpayconexsdk.core.BluefinPayconexSDK;

Map<String, Object> options = new java.util.LinkedHashMap<>();
options.put("apikey", System.getenv("BLUEFIN_PAYCONEX_APIKEY"));
BluefinPayconexSDK client = new BluefinPayconexSDK(options);

JavaScript

const { BluefinPayconexSDK } = require('@voxgig-sdk/bluefin-payconex-js')

const client = new BluefinPayconexSDK({
  apikey: process.env.BLUEFIN_PAYCONEX_APIKEY,
})


// Load a specific accountupdatersubscriptionwithresult (returns the entity)
const accountupdatersubscriptionwithresult = await client.AccountUpdaterSubscriptionWithResult().load({
  account_id: 'example_account_id',
  subscription_id: 'example_subscription_id',
})
console.log(accountupdatersubscriptionwithresult)

Kotlin

import voxgig.bluefinpayconexsdk.core.BluefinPayconexSDK

val client = BluefinPayconexSDK(mutableMapOf<String, Any?>(
    "apikey" to System.getenv("BLUEFIN_PAYCONEX_APIKEY"),
))

OCaml

open Voxgig_struct
open Sdk_helpers

let () =
  let client = Sdk_client.make (jo [("apikey", Str (Sys.getenv "BLUEFIN_PAYCONEX_APIKEY"))]) in

Perl

use lib 'perl/lib';
use BluefinPayconexSDK;

my $client = BluefinPayconexSDK->new({
    'apikey' => $ENV{'BLUEFIN_PAYCONEX_APIKEY'},
});

Rust

use bluefin_payconex_sdk::{jo, BluefinPayconexSDK, Value};

let client = BluefinPayconexSDK::new(jo(vec![
    ("apikey", Value::str(std::env::var("BLUEFIN_PAYCONEX_APIKEY").unwrap_or_default())),
]));

Scala

import voxgig.bluefinpayconexsdk.core.BluefinPayconexSDK

val options = new java.util.LinkedHashMap[String, Object]()
options.put("apikey", System.getenv("BLUEFIN_PAYCONEX_APIKEY"))
val client = new BluefinPayconexSDK(options)

Swift

import BluefinPayconexSdk

let options = VMap()
options.entries["apikey"] = .string(
    ProcessInfo.processInfo.environment["BLUEFIN_PAYCONEX_APIKEY"] ?? "")
let client = BluefinPayconexSDK(options)

Zig

const std = @import("std");
const sdk = @import("sdk");
const h = sdk.h;

const client = sdk.BluefinPayconexSDK.new(h.jo(&.{
    .{ "apikey", h.vstr(std.posix.getenv("BLUEFIN_PAYCONEX_APIKEY") orelse "") },
}));

Direct and prepare

For endpoints the entity model doesn’t cover, use the low-level methods:

• direct(fetchargs) — build and send an HTTP request in one step.
• prepare(fetchargs) — build the request without sending it.

Both accept a map with path, method, params, query, headers, and body. See the How-to guides below.

How-to guides

Make a direct API call

When the entity interface does not cover an endpoint, use direct:

TypeScript:

const result = await client.direct({
  path: '/api/resource/{id}',
  method: 'GET',
  params: { id: 'example' },
})
if (result instanceof Error) {
  throw result
}
console.log(result.data)

Python:

result = client.direct({
    "path": "/api/resource/{id}",
    "method": "GET",
    "params": {"id": "example"},
})

PHP:

$result = $client->direct([
    "path" => "/api/resource/{id}",
    "method" => "GET",
    "params" => ["id" => "example"],
]);

Go:

result, err := client.Direct(map[string]any{
    "path":   "/api/resource/{id}",
    "method": "GET",
    "params": map[string]any{"id": "example"},
})
if err != nil {
    panic(err)
}
fmt.Println(result)

Ruby:

result = client.direct({
  "path" => "/api/resource/{id}",
  "method" => "GET",
  "params" => { "id" => "example" },
})

Lua:

local result, err = client:direct({
  path = "/api/resource/{id}",
  method = "GET",
  params = { id = "example" },
})

C:

PNError* err = NULL;
voxgig_value* result = sdk_direct(client, cmap(3,
    "path", v_str("/api/resource/{id}"),
    "method", v_str("GET"),
    "params", cmap(1, "id", v_str("example"))), &err);

Clojure:

(def result
  (api/direct client
    (vs/jm "path" "/api/resource/{id}"
           "method" "GET"
           "params" (vs/jm "id" "example"))))

C++:

Value result = client->direct(vmap({
    {"path", Value("/api/resource/{id}")},
    {"method", Value("GET")},
    {"params", vmap({{"id", Value("example")}})},
}));

C#:

var result = client.Direct(new Dictionary<string, object?>
{
    ["path"] = "/api/resource/{id}",
    ["method"] = "GET",
    ["params"] = new Dictionary<string, object?> { ["id"] = "example" },
});

Dart:

final result = await client.direct({
  'path': '/api/resource/{id}',
  'method': 'GET',
  'params': {'id': 'example'},
});

Elixir:

result = BluefinPayconex.direct(sdk, BluefinPayconex.Helpers.deep(%{
  "path" => "/api/resource/{id}",
  "method" => "GET",
  "params" => %{"id" => "example"}
}))

Haskell:

import qualified SdkClient as Sdk
import qualified SdkFeatures as F
import VoxgigStruct (Value (..))
import SdkHelpers (jo)

main :: IO ()
main = do
  sdk <- Sdk.newSdk0
  params <- jo [("id", VStr "example")]
  args <- jo [("path", VStr "/api/resource/{id}"), ("method", VStr "GET"), ("params", params)]
  result <- F.direct sdk args
  print result

Java:

Map<String, Object> result = client.direct(Map.of(
    "path", "/api/resource/{id}",
    "method", "GET",
    "params", Map.of("id", "example")));

JavaScript:

const result = await client.direct({
  path: '/api/resource/{id}',
  method: 'GET',
  params: { id: 'example' },
})
if (result instanceof Error) {
  throw result
}
console.log(result.data)

Kotlin:

val result = client.direct(mutableMapOf<String, Any?>(
    "path" to "/api/resource/{id}",
    "method" to "GET",
    "params" to mapOf("id" to "example")))

OCaml:

let result = Sdk_client.direct client (jo [
    ("path", Str "/api/resource/{id}");
    ("method", Str "GET");
    ("params", jo [("id", Str "example")]);
]) in
ignore result

Perl:

my $result = $client->direct({
    'path' => '/api/resource/{id}',
    'method' => 'GET',
    'params' => { 'id' => 'example' },
});

Rust:

let result = client.direct(jo(vec![
    ("path", Value::str("/api/resource/{id}")),
    ("method", Value::str("GET")),
    ("params", jo(vec![("id", Value::str("example"))])),
]));

Scala:

val result = client.direct(java.util.Map.of(
    "path", "/api/resource/{id}",
    "method", "GET",
    "params", java.util.Map.of("id", "example")))

Swift:

let result = client.direct(VMap([
    ("path", .string("/api/resource/{id}")),
    ("method", .string("GET")),
    ("params", .map([("id", .string("example"))])),
]))

Zig:

const result = client.direct(h.jo(&.{
    .{ "path", h.vstr("/api/resource/{id}") },
    .{ "method", h.vstr("GET") },
    .{ "params", h.jo(&.{.{ "id", h.vstr("example") }}) },
}));

Advanced

Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.

Every SDK call runs the same five-stage pipeline:

1. Point — resolve the API endpoint from the operation definition.
2. Spec — build the HTTP specification (URL, method, headers, body).
3. Request — send the HTTP request.
4. Response — receive and parse the response.
5. Result — extract the result data for the caller.

A feature hook fires at each stage (e.g. PrePoint, PreSpec, PreRequest), so features can inspect or modify the pipeline without forking the SDK.

Features

Pass custom features via the extend option at construction time.

Per-language documentation

• TypeScript
• Python
• PHP
• Golang
• Ruby
• Lua
• C
• Clojure
• C++
• C#
• Dart
• Elixir
• Haskell
• Java
• JavaScript
• Kotlin
• OCaml
• Perl
• Rust
• Scala
• Swift
• Zig

Upstream API

This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.

• Upstream API: https://api.payconex.net/

Security

Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.

Generated from the PayConex 4 OpenAPI spec by @voxgig/sdkgen.