MaxiPago 3.0.601

There is a newer version of this package available.
See the version list below for details.
dotnet add package MaxiPago --version 3.0.601                
NuGet\Install-Package MaxiPago -Version 3.0.601                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MaxiPago" Version="3.0.601" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MaxiPago --version 3.0.601                
#r "nuget: MaxiPago, 3.0.601"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MaxiPago as a Cake Addin
#addin nuget:?package=MaxiPago&version=3.0.601

// Install MaxiPago as a Cake Tool
#tool nuget:?package=MaxiPago&version=3.0.601                

MaxiPago SDK client

The MaxiPago gateway SDK for .NET projects

GitHub license Time tracker

MaxiPago


CI/CD

Build status Last commit Tests Coverage Code Smells LoC
Build status GitHub last commit AppVeyor tests (branch) Coverage Code Smells Lines of Code

Code Quality

Codacy Badge Codacy Badge

codecov CodeFactor

Maintainability Test Coverage

Quality Gate Status Maintainability Rating

Technical Debt Duplicated Lines (%)

Reliability Rating Security Rating

Bugs Vulnerabilities


Installation

Github Releases

GitHub last release Github All Releases

Download the latest zip file from the Release page.

Nuget package manager

Package Version Downloads
MaxiPago MaxiPago NuGet Version MaxiPago NuGet Downloads

Features

Implements all features of MaxiPago API available at Integration Documentation

  • Add customer
  • Delete customer
  • Update customer
  • Add a card on file
  • Delete card on file
  • Cancel recurring
  • Sale (with card data)
  • Sale (with saved card)
  • Sale (with card data, saving the card for future use)
  • Auth (with card data)
  • Auth (with saved card)
  • Auth (with card data, saving the card for future use)
  • Boleto (bank slip/bank bill - Brazil only!)
  • Capture (capture a pre-auth request)
  • Return
  • Void
  • Recurring (with card data)
  • Recurring (with saved card)
  • Online Debit (Brazil only!)
  • Transactions report
  • Transaction detailed report
  • Transaction detailed report by order ID
  • Check request status

Usage

Adding a customer


//For each environment (TEST and LIVE) this information is different!
var merchantId = "your-merchant-id"; //get this information with MaxiPago
var merchantKey = "your-merchant-key"; //get this information with MaxiPago

var api = new Api { Environment = "TEST" }; //TEST or LIVE
var response = api.AddConsumer(
    MerchantId,
    MerchantKey,
    userIdInYourSystem,
    firstName,
    lastName,
    addressLineOne, //if you don't have this information, use null instead
    addressLineTwo, //if you don't have this information, use null instead
    city, //if you don't have this information, use null instead
    state, //if you don't have this information, use null instead
    zipCode, //if you don't have this information, use null instead
    phone, //if you don't have this information, use null instead
    email,
    dateOfBirth, //if you don't have this information, use null instead
    document,
    gender); //M for Male and F for Female

if(!string.IsNullOrWhiteSpace(response.ErrorMessage))
    //handle the error message.
return response.Result.CustomerId; //store this customer ID value for updating or deleting the customer in future.

Delete customer


//For each environment (TEST and LIVE) this information is different!
var merchantId = "your-merchant-id"; //get this information with MaxiPago
var merchantKey = "your-merchant-key"; //get this information with MaxiPago

var api = new Api { Environment = "TEST" }; //TEST or LIVE

var response = api.DeleteCustomer(merchantId, merchantKey, customerId); //this information was returned by the AddCustomer method.
if(!string.IsNullOrWhiteSpace(response.ErrorMessage))
    //handle the error message.

Update customer


//For each environment (TEST and LIVE) this information is different!
var merchantId = "your-merchant-id"; //get this information with MaxiPago
var merchantKey = "your-merchant-key"; //get this information with MaxiPago

var api = new Api { Environment = "TEST" }; //TEST or LIVE

var response = api.UpdatedCustomer(
    merchantId,
    merchantKey,
    customerId,
    userIdOnYourSystem,
    firstName,
    lastName,
    null,
    null,
    null,
    null,
    null,
    "+5511123456789", //updates the telephone
    email,
    null,
    null,
    "M");

if(!string.IsNullOrWhiteSpace(response.ErrorMessage))
    //handle the error message.

Save card


//For each environment (TEST and LIVE) this information is different!
var merchantId = "your-merchant-id"; //get this information with MaxiPago
var merchantKey = "your-merchant-key"; //get this information with MaxiPago

var api = new Api { Environment = "TEST" }; //TEST or LIVE

var response = api.AddCardOnFile(
    merchantId,
    merchantKey,
    customerId,
    creditCardNumber,
    expirationMonth,
    expirationYear,
    billingName,
    billingAddressLineOne,
    billingAddressLineTwo,
    billingCity,
    billingState,
    billingZip,
    billingCountry,
    billingPhone,
    billingEmail,
    onFileEndDate, //Deadline to keep the card in the base
    onFilePermission, //Limit duration for the use of the saved card. "ongoing" = indefinitely / "use_once" = only once after the 1st payment
    onFileComment,
    onFileMaxChargeAmount); //Maximum amount that this card is authorized to be charged.

if(!string.IsNullOrWhiteSpace(response.ErrorMessage))
    //handle the error message.
return response.Result.Token; //store this token for future use (remove card, sale, auth...)

Create a recurring payment


//For each environment (TEST and LIVE) this information is different!
var merchantId = "your-merchant-id"; //get this information with MaxiPago
var merchantKey = "your-merchant-key"; //get this information with MaxiPago

var transaction = new Transaction { Environment = "TEST" }; //TEST or LIVE

var response = transaction.Recurring(
        merchantId,
        merchantKey,
        transactionId,
        value,
        creditCardNumber,
        expirationMonth,
        expirationYear,
        null,
        creditCardSecureCode,
        processorId, //TEST SIMULATOR = 1 | Rede = 2 | GetNet = 3 | Cielo = 4 | TEF = 5 | Elavon = 6 | ChasePaymentech = 8 
        6, //installments
        "N", //charge interest
        ipAddress,
        "new",
        startDate, //the date of first charge
        frequency, //combined with period, so if the frequency is 1, every "period" will be charged. So if the period is "weekly" and the frequency is "2", every two weeks will be charged.
        period, //The charge recurring period: daily, weekly, monthly
        numberOfTimes, //The number of times to repeat the charge (use 999 as max value for "indefinitely" time, after 999 times, this recurring will need to be created again).
        failureThreshold, //Number of failed attempts needed to trigger an email notification to the merchant.
        "BRL"); //currency of the charge.

if(response.IsErrorResponse){
    if(response is ErrorResponse errorResult)
        Console.WriteLine(errorResult.ErrorMsg); //handle the error message.
}
if(!(response is TransactionResponse result))
    //some other error, handle it

var orderId = result.OrderId;
var responseCode = result.ResponseCode;
if(responseCode != 0) {
    Console.WriteLine(result.ErrorMessage); //handle it

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 is compatible.  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 is compatible.  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. 
.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 is compatible. 
.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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
3.0.604 27 12/23/2024
3.0.601 23 12/23/2024
3.0.598 94 12/9/2024
3.0.595 92 11/25/2024
3.0.590 88 11/18/2024
3.0.587 104 10/28/2024
3.0.583 106 10/14/2024
3.0.580 102 10/3/2024
3.0.577 96 10/3/2024
3.0.572 105 9/23/2024
3.0.569 137 9/16/2024
3.0.566 116 9/9/2024
3.0.563 106 9/9/2024
3.0.558 112 9/2/2024
3.0.555 117 8/28/2024
3.0.547 106 8/28/2024
3.0.544 101 8/27/2024
3.0.537 110 8/26/2024
3.0.528 136 8/24/2024
3.0.522 111 8/19/2024
3.0.519 118 8/12/2024
3.0.516 76 8/5/2024
3.0.504 114 7/15/2024
3.0.501 97 7/15/2024
3.0.496 104 7/8/2024
3.0.493 116 7/3/2024
3.0.489 134 6/16/2024
3.0.484 103 6/16/2024
3.0.481 102 6/16/2024
3.0.476 127 5/27/2024
3.0.473 115 5/27/2024
3.0.468 109 5/27/2024
3.0.461 120 5/19/2024
3.0.457 102 5/14/2024
3.0.454 126 4/30/2024
3.0.451 119 4/30/2024
3.0.444 113 4/29/2024
3.0.435 96 4/22/2024
3.0.432 106 4/22/2024
3.0.427 111 4/22/2024
3.0.422 121 4/15/2024
3.0.419 127 4/15/2024
3.0.414 127 4/8/2024
3.0.411 186 3/18/2024
3.0.408 207 2/26/2024
3.0.405 223 2/20/2024
3.0.401 239 2/19/2024
3.0.389 244 2/14/2024
3.0.386 222 2/14/2024
3.0.380 236 2/12/2024
3.0.377 226 2/12/2024
3.0.372 317 1/30/2024
3.0.369 273 1/29/2024
3.0.364 284 1/29/2024
3.0.356 304 1/22/2024
3.0.353 304 1/22/2024
3.0.350 314 1/22/2024
3.0.343 307 1/16/2024
3.0.340 315 1/16/2024
3.0.335 336 1/15/2024
3.0.328 355 1/8/2024
3.0.325 340 12/25/2023
3.0.322 313 12/25/2023
3.0.317 367 12/18/2023
3.0.297 386 12/14/2023
3.0.291 381 12/11/2023
3.0.288 377 12/11/2023
3.0.283 372 12/11/2023
3.0.280 405 12/11/2023
3.0.271 445 12/4/2023
3.0.268 439 12/4/2023
3.0.263 371 11/27/2023
3.0.260 345 11/20/2023
3.0.255 381 11/20/2023
3.0.250 380 11/20/2023
3.0.243 398 11/14/2023
3.0.238 406 11/14/2023
3.0.235 340 11/13/2023
3.0.230 316 11/9/2023
3.0.224 327 11/6/2023
3.0.221 379 11/6/2023
3.0.216 401 10/30/2023
3.0.213 408 10/30/2023
3.0.206 456 10/23/2023
3.0.203 408 10/16/2023
3.0.200 415 10/16/2023
3.0.195 412 10/16/2023
3.0.188 417 10/8/2023
3.0.179 449 9/23/2023
3.0.176 478 9/19/2023
3.0.173 504 9/19/2023
3.0.168 461 9/19/2023
3.0.152 466 9/12/2023
3.0.149 502 9/12/2023
3.0.144 494 9/4/2023
3.0.141 551 8/24/2023
3.0.138 503 8/14/2023
3.0.135 542 8/14/2023
3.0.132 489 8/14/2023
3.0.123 530 8/14/2023
3.0.118 498 8/8/2023
3.0.115 542 7/23/2023
3.0.112 499 7/23/2023
3.0.102 551 7/23/2023
3.0.98 529 7/23/2023
3.0.96 537 7/23/2023
3.0.76 512 7/19/2023
3.0.70 631 7/14/2023
3.0.65 543 7/14/2023
3.0.62 509 7/13/2023
3.0.59 564 7/11/2023
3.0.56 459 7/11/2023
3.0.51 550 7/3/2023
3.0.48 516 6/19/2023
3.0.47 564 6/15/2023
3.0.44 505 6/5/2023
3.0.43 523 6/5/2023
3.0.40 484 6/5/2023
3.0.35 512 5/22/2023
3.0.32 507 5/22/2023
3.0.25 517 5/4/2023
3.0.22 553 5/3/2023
3.0.17 620 4/8/2023
3.0.11 545 4/4/2023
3.0.6 736 3/26/2023
3.0.2 559 3/26/2023
2.0.95 616 3/26/2023
2.0.80 500 3/26/2023
2.0.73 588 3/26/2023
2.0.70 592 3/22/2023
2.0.65 681 3/5/2023
2.0.61 601 3/3/2023
2.0.58 612 3/3/2023
2.0.50 599 3/3/2023
2.0.0 630 2/27/2023
1.0.49 1,262 4/18/2020
1.0.41 904 4/18/2020
1.0.24 907 4/18/2020

Add support to .NET 6, 7, and 8