👁 Image
VantagePay.Models 1.2026.523.5

VantagePay.Models

VantagePay.Models is the public model package for the VantagePay platform.
It provides strongly typed request/response models, lookup enums, and shared value objects for payments, merchants, consumers, tokens, notifications, and reporting.

This package can be used on its own, without the SDK, in any integration where you need the VantagePay data contracts.

Installation

dotnet add package VantagePay.Models

Or via NuGet Package Manager Console:

Install-Package VantagePay.Models

Supported Target Frameworks

Package Scope

The package contains data models and related helpers only. It does not include:

• HTTP client implementations
• authentication/session orchestration
• request execution/retry logic

Namespace Overview

Basic Usage

Building a Payment Request

using System.Collections.Generic;
using VantagePay.Models.Lookups;
using VantagePay.Models.Payments;
using VantagePay.Models.Payments.Requests;

var request = new PaymentRequest
{
 YourReference = "ORDER-9001",
 PaymentSources = new PaymentSources
 {
 MobileWallets = new List<MobileWalletSource>
 {
 new MobileWalletSource
 {
 MobileWalletOperator = MobileWalletOperator.MTN,
 Msisdn = "233241234567",
 AmountInCents = 10000,
 Currency = Currency.GHS,
 }
 }
 },
 PaymentDestinations = new PaymentDestinations
 {
 Merchants = new List<MerchantDestination>
 {
 new MerchantDestination
 {
 MerchantReference = "merchant-reference",
 AmountInCents = 10000,
 Currency = Currency.GHS,
 PaymentType = MerchantPaymentType.BuyingGoods,
 }
 }
 }
};

Building a Card Tokenization Request

using VantagePay.Models.Lookups;
using VantagePay.Models.Tokens;

var tokenRequest = new CardRequest
{
 CardNumber = "4111111111111111",
 NameOnCard = "Jane Doe",
 ExpiryMonth = Month.March,
 ExpiryYear = 2027,
};

Key Model Concepts

Payment Composition

• PaymentRequest contains PaymentSources (debit side) and PaymentDestinations (credit side).
• Each side can contain multiple transaction legs (for example split-source or split-destination flows).
• Common per-transaction fields such as AmountInCents and Currency are defined on shared base models.

Amounts Use Minor Units

All monetary amounts are integer minor units (for example cents, kobo, ngwe).
Example: 2550 represents 25.50.

Payment References

• PaymentResponse.Reference is the primary payment reference returned after submission.
• PaymentStatusResponse.PaymentReference links status payloads back to the same payment.

Status & Lifecycle

TransactionStatus represents transaction lifecycle states such as Processing, Success, Failed, and Indeterminate.

Lookups and Enums

The VantagePay.Models.Lookups namespace includes enums such as:

Bank, Channel, Country, Currency, IdentityDocumentType, Language, MerchantCategory, MobileWalletOperator, Month, ProductType, and RepeatInterval.

It also includes static lookup datasets such as:

BankData, CurrencyData, CountryData, GhanaBankData, SouthAfricaBankData, NigeriaBankData, MobileWalletOperatorData, and LanguageData.

Use GetEnumDescription() from VantagePay.Models.Extensions to read [Description] values.

Serialization

Models are designed for JSON and contract-based serialization, including:

• System.Text.Json
• Newtonsoft.Json
• DataContract / DataMember workflows

The package also includes JsonSettings.Default (Newtonsoft.Json) for consistent VantagePay-oriented serialization settings.