PayrixApiSDK 1.0.0
dotnet add package PayrixApiSDK --version 1.0.0
NuGet\Install-Package PayrixApiSDK -Version 1.0.0
<PackageReference Include="PayrixApiSDK" Version="1.0.0" />
<PackageVersion Include="PayrixApiSDK" Version="1.0.0" />
<PackageReference Include="PayrixApiSDK" />
paket add PayrixApiSDK --version 1.0.0
#r "nuget: PayrixApiSDK, 1.0.0"
#:package PayrixApiSDK@1.0.0
#addin nuget:?package=PayrixApiSDK&version=1.0.0
#tool nuget:?package=PayrixApiSDK&version=1.0.0
Getting Started with Payrix
Install the Package
If you are building with .NET CLI tools then you can also use the following command:
dotnet add package PayrixApiSDK --version 1.0.0
You can also view the package at: https://www.nuget.org/packages/PayrixApiSDK/1.0.0
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| Environment | Environment |
The API environment. <br> Default: Environment.Sandbox |
| Timeout | TimeSpan |
Http client timeout.<br>Default: TimeSpan.FromSeconds(100) |
| HttpClientConfiguration | Action<HttpClientConfiguration.Builder> |
Action delegate that configures the HTTP client by using the HttpClientConfiguration.Builder for customizing API call settings.<br>Default: new HttpClient() |
| ApiKeyCredentials | ApiKeyCredentials |
The Credentials Setter for Custom Header Signature |
| SessionKeyCredentials | SessionKeyCredentials |
The Credentials Setter for Custom Header Signature |
| TxnSessionKeyCredentials | TxnSessionKeyCredentials |
The Credentials Setter for Custom Header Signature |
| UsernameCredentials | UsernameCredentials |
The Credentials Setter for Custom Header Signature |
| PasswordCredentials | PasswordCredentials |
The Credentials Setter for Custom Header Signature |
The API client can be initialized as follows:
using Payrix.Standard;
using Payrix.Standard.Authentication;
namespace ConsoleApp;
PayrixClient client = new PayrixClient.Builder()
.ApiKeyCredentials(
new ApiKeyModel.Builder(
"APIKEY"
)
.Build())
.SessionKeyCredentials(
new SessionKeyModel.Builder(
"SESSIONKEY"
)
.Build())
.TxnSessionKeyCredentials(
new TxnSessionKeyModel.Builder(
"TXNSESSIONKEY"
)
.Build())
.UsernameCredentials(
new UsernameModel.Builder(
"USERNAME"
)
.Build())
.PasswordCredentials(
new PasswordModel.Builder(
"PASSWORD"
)
.Build())
.Environment(Payrix.Standard.Environment.Sandbox)
.Build();
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| sandbox | Default |
| canada sandbox | - |
Authorization
This API uses the following authentication schemes.
apiKey (Custom Header Signature)sessionKey (Custom Header Signature)txnSessionKey (Custom Header Signature)username (Custom Header Signature)password (Custom Header Signature)
List of APIs
- API Keys
- Apple Domains
- Apple Domains Mass Enablement
- Accounts Verifications
- Aggregation Result Groups
- Aggregation Results
- Alert Actions
- Alert Triggers
- Authentication Tokens
- Batches Settlements
- Billing Modifiers
- Billing Events
- Change Requests
- Chargeback Documents
- Chargeback Message Results
- Chargeback Messages
- Chargeback Statuses
- Confirmation Codes
- Decision Actions
- Decision Rules
- Disbursement Entries
- Disbursement Reference
- Disbursement Results
- Embedded Finance
- Entity Debts
- Entity Reserves
- Entity Returns
- Entity Terms
- Entry Origin
- Fee Modifiers
- Fee Rules
- Fraud Sight Enablements
- Host Themes
- Fund Origins
- IP Address Lists
- Invoice Items
- Invoice Parameters
- Invoice Line Items
- Invoice Results
- Logins Helpers
- Merchant Results
- Merchant Platform Statuses
- Message Threads
- Note Documents
- Orgs VAS Efe Products
- Orgs VAS Omni Tokens
- Orgs VAS Revenue Boosts
- Orgs VAS Safer Payments
- Orgs VA Stax Form Enablements
- Org Entities
- Org Flow Actions
- Org Flows
- Org Flow Rules
- Payment Update Groups
- Payment Updates
- Payout Flows
- Pending Entry
- Profit Share Results
- Profit Share Rules
- Profit Shares
- Reserve Entry
- Revenue Boosts
- Rev Share Schedules
- Rev Share Statements
- Safer Payments
- Statement Entry
- Subscription Tokens
- Tax Form Requests
- Team Logins
- Terminal Transaction Reference
- Terminal Transactions Datas
- Terminal Transactions
- Terminal Transaction Results
- Terminal Transactions Metadatas
- Token Results
- Transaction Datas
- Transaction Metadatas
- Transaction Holds
- Transaction Items
- Transactions Results
- Fee Refunds
- Transactions Txns
- Tax Form Enablements
- Txn Sessions
- VAS Efe Offers
- VAS Efe Offer Updates
- Orgs VA Sfraud Sight Enablements
- Fraud Sight Results
- Accounts
- Adjustments
- Aggregations
- Alerts
- Assessments
- Billing
- Bins
- Chargebacks
- Contacts
- Credentials
- Customers
- Decisions
- Disbursements
- Divisions
- Entities
- Entity Refs
- Entity Data
- Entities Custom Fields
- Entries
- Fees
- Funds
- Invoices
- Logins
- Mappings
- Members
- Merchants
- Messages
- Notes
- Omni Tokens
- Orgs
- Payouts
- Plans
- Reserves
- Secrets
- Sessions
- Statements
- Subscriptions
- Teams
- Terminals
- Tokens
- Vendors
SDK Infrastructure
Configuration
HTTP
Utilities
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- APIMatic.Core (>= 0.4.13 && < 0.5.0)
- Microsoft.CSharp (>= 4.7.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 1.0.0 | 222 | 11/6/2025 |