Antom SDK for .NET

Latest release: 2.4.2

Installation

Requires a project targeting .NET 8 (net8.0) or a compatible newer framework. Run this command in the directory containing your project file:

dotnet add package global-open-sdk-dotnet

Quick start

• RSA: follow the configuration and inline example below.
• API Key (limited availability): follow the setup guide and run the sandbox example.
• Browse more examples and the API documentation.

RSA and API Key clients share request/response models. File uploads and notification verification still require RSA credentials.

RSA configuration

Before using the RSA client, prepare these values from your Antom integration:

gatewayUrl=your_regional_https_gateway
clientId=your_client_id
merchantPrivateKey=your_merchant_private_key
alipayPublicKey=your_antom_public_key

The examples read them from ANTOM_GATEWAY_URL, ANTOM_CLIENT_ID, ANTOM_MERCHANT_PRIVATE_KEY, and ANTOM_PUBLIC_KEY, respectively. Keep keys in server-side configuration. Replace sample order data and callback URLs with your own values before sending a request.

RSA client

The following C# method-body fragment initializes the client. Select the single operation you need from the payment examples. The repository's Program.cs runs multiple operations, including refunds and cancellations; do not run it unchanged as a payment quick start.

var client = new com.alipay.ams.api.DefaultAlipayClient(
    System.Environment.GetEnvironmentVariable("ANTOM_GATEWAY_URL"),
    System.Environment.GetEnvironmentVariable("ANTOM_CLIENT_ID"),
    System.Environment.GetEnvironmentVariable("ANTOM_MERCHANT_PRIVATE_KEY"),
    System.Environment.GetEnvironmentVariable("ANTOM_PUBLIC_KEY"));

API Key client (limited availability)

API Key access is not yet available to all merchants. Use this client only if API Key access has been enabled for your account; otherwise, use RSA.

Set ANTOM_GATEWAY_URL and ANTOM_API_KEY in your server environment. This initializes the client; see the setup guide for a complete sandbox request and its additional configuration. Place the using directive at file scope and the initialization statements inside a method.

using com.alipay.ams.api;

using var client = new ApiKeyAlipayClient(
    Environment.GetEnvironmentVariable("ANTOM_GATEWAY_URL"),
    Environment.GetEnvironmentVariable("ANTOM_API_KEY"));

Exact amount conversion

Available in SDK version 2.4.0 and later.

Convert a decimal amount string into Antom's integer-string Amount.value, convert it back to a fixed-precision decimal string, or validate an outbound value. Conversion returns a string, not an Amount object, and uses bundled currency rules without a network request.

Place the using directive at file scope and the calls inside a method.

using com.alipay.ams.util;

string value = AmountUtil.ToAmount("10.25", "USD"); // "1025"
string amount = AmountUtil.FromAmount(value, "USD"); // "10.25"
AmountUtil.Validate(value, "USD");

Validate returns normally on success. Invalid input throws ArgumentException (or ArgumentNullException for null); bundled-rule loading failures throw InvalidOperationException. Error messages include categories such as UNSUPPORTED_CURRENCY, EXCESS_PRECISION, VALUE_TOO_LONG, and RULE_VIOLATION.

• Pass amounts, values, and currency codes as strings. Use uppercase currency codes and unsigned ASCII numbers, without spaces, separators, or exponents.
• Supported currencies: AUD, BDT, BRL, CAD, CLP, CNY, EUR, GBP, HKD, IDR, JPY, KRW, MXN, MYR, NZD, PEN, PHP, PKR, PLN, SGD, THB, TWD, USD, VND. Other codes are rejected; there is no default conversion multiplier.
• Conversion is exact and never rounds. Extra non-zero decimal places are rejected; trailing zero decimal places are allowed. Zero is accepted, but callers must check whether the target API permits a zero amount.
• The 16-digit limit applies to Amount.value, not to the decimal input string or the business transaction limit. Conversion to a value checks the normalized result; conversion from a value and validation count all input digits, including leading zeros.
• For IDR, conversion to a value and outbound validation require the value to be a multiple of 100. Conversion from a value does not apply this outbound restriction and never rounds the response amount.

See Antom's amount rules for the conversion convention. Supported payment-method currencies, transaction limits, and method-specific constraints (such as JKOPay TWD or Octopus HKD multiples) must be checked separately; this utility does not validate payment-method context.

Upgrade notes

Billing integrations: availableAmount now uses Amount; the AvailableAmount model has been removed.

Meter event upload

meter/createSession uses the regular signed AMS transport. Use its session ID to call meter/uploadEvent through ExecuteWithHeaders:

The fragment below assumes an initialized RSA client, a valid session ID from meter/createSession, and a populated collection of meter event batches.

// Requires: using com.alipay.ams.api.request.billing;
//           using System.Collections.Generic;
var request = new AlipayMeterUploadEventRequest { Meters = meters };
var response = client.ExecuteWithHeaders(
    request,
    new Dictionary<string, string> { ["X-Session-Id"] = sessionId });

The SDK sends meter/uploadEvent to the gateway URL configured on the client, without sandbox path rewriting, request signing, response signature verification, or automatic retries. This API requires HTTP/2.

Support

For integration questions, contact overseas_support@service.alibaba.com.