Skip to content

SDKs

VantagePay publishes official client SDKs for JavaScript/TypeScript and .NET. Both are generated from the same API and are kept in lockstep with the API Reference.

Coverage matrix

CapabilityJavaScript.NET
Client APIs (auth, consumers, merchants, payments, ...)yesyes (VantagePayClient)
Admin APIs (user mgmt, KYC/KYB, templates, ...)noyes (VantagePayAdminClient)
Automatic token refreshyesyes
SignalR real-time updatesyesyes

Install

sh
npm install @vantagepay/vantagepay
shell
dotnet add package VantagePay.SDK

Quickstart

ts
import { VantagePay } from '@vantagepay/vantagepay'

const client = new VantagePay({ baseUrl: 'https://sandbox-api.vantagepay.dev/' })
await client.auth.login('233548306110', 'Password123!')
const currencies = await client.lookups.getCurrencies()
csharp
using VantagePay.SDK;

var client = new VantagePayClient("https://sandbox-api.vantagepay.dev");
await client.Authentication.LoginAsync("233548306110", "Password123!");
var currencies = await client.Lookups.GetCurrenciesAsync();

Reference

Payments for Africa