Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guibranco/maxipago-sdk-dotnet
:credit_card: :gear: MaxiPago gateway SDK for .NET projects
https://github.com/guibranco/maxipago-sdk-dotnet
api dotnet dotnet-core dotnetcore dotnetframework gateway hacktoberfest maxipago maxipago-api maxipago-platform-sdk maxipago-sdk-dotnet payments sdk
Last synced: 19 days ago
JSON representation
:credit_card: :gear: MaxiPago gateway SDK for .NET projects
- Host: GitHub
- URL: https://github.com/guibranco/maxipago-sdk-dotnet
- Owner: guibranco
- License: mit
- Created: 2020-04-18T07:11:39.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T06:12:46.000Z (7 months ago)
- Last Synced: 2024-04-08T07:29:04.007Z (7 months ago)
- Topics: api, dotnet, dotnet-core, dotnetcore, dotnetframework, gateway, hacktoberfest, maxipago, maxipago-api, maxipago-platform-sdk, maxipago-sdk-dotnet, payments, sdk
- Language: C#
- Homepage: https://guibranco.github.io/MaxiPago-SDK-dotnet/
- Size: 474 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MaxiPago SDK client
The [MaxiPago gateway](https://www.maxipago.com/developers/) SDK for .NET projects
[](https://github.com/guibranco/MaxiPago-SDK-dotnet)
[](https://wakatime.com/badge/github/guibranco/MaxiPago-SDK-dotnet)
---
## CI/CD
| Build status | Last commit | Tests | Coverage | Code Smells | LoC |
|:------------:|:-----------:|:-----:|:--------:|:-----------:|:---:|
| [](https://ci.appveyor.com/project/guibranco/MaxiPago-SDK-dotnet/branch/main) | [](https://github.com/guibranco/MaxiPago-SDK-dotnet) | [](https://ci.appveyor.com/project/guibranco/MaxiPago-SDK-dotnet/branch/main) | [](https://sonarcloud.io/dashboard?id=guibranco_MaxiPago-SDK-dotnet) | [](https://sonarcloud.io/dashboard?id=guibranco_MaxiPago-SDK-dotnet) | [](https://sonarcloud.io/dashboard?id=guibranco_MaxiPago-SDK-dotnet) |
## Code Quality
[](https://www.codacy.com/gh/guibranco/MaxiPago-SDK-dotnet/dashboard?utm_source=github.com&utm_medium=referral&utm_content=guibranco/MaxiPago-SDK-dotnet&utm_campaign=Badge_Grade)
[](https://www.codacy.com/gh/guibranco/MaxiPago-SDK-dotnet/dashboard?utm_source=github.com&utm_medium=referral&utm_content=guibranco/MaxiPago-SDK-dotnet&utm_campaign=Badge_Coverage)
[](https://codecov.io/gh/guibranco/MaxiPago-SDK-dotnet)
[](https://www.codefactor.io/repository/github/guibranco/MaxiPago-SDK-dotnet)
[](https://codeclimate.com/github/guibranco/MaxiPago-SDK-dotnet/maintainability)
[](https://codeclimate.com/github/guibranco/MaxiPago-SDK-dotnet/test_coverage)
[](https://sonarcloud.io/dashboard?id=guibranco_MaxiPago-SDK-dotnet)
[](https://sonarcloud.io/dashboard?id=guibranco_MaxiPago-SDK-dotnet)
[](https://sonarcloud.io/dashboard?id=guibranco_MaxiPago-SDK-dotnet)
[](https://sonarcloud.io/dashboard?id=guibranco_MaxiPago-SDK-dotnet)
[](https://sonarcloud.io/dashboard?id=guibranco_MaxiPago-SDK-dotnet)
[](https://sonarcloud.io/dashboard?id=guibranco_MaxiPago-SDK-dotnet)
[](https://sonarcloud.io/dashboard?id=guibranco_MaxiPago-SDK-dotnet)
[](https://sonarcloud.io/dashboard?id=guibranco_MaxiPago-SDK-dotnet)
---
## Installation
### Github Releases
[](https://github.com/guibranco/MaxiPago-SDK-dotnet) [](https://github.com/guibranco/MaxiPago-SDK-dotnet)
Download the latest zip file from the [Release](https://github.com/guibranco/MaxiPago-SDK-dotnet/releases) page.
### Nuget package manager
| Package | Version | Downloads |
|------------------|:-------:|:-------:|
| **MaxiPago** | [](https://www.nuget.org/packages/MaxiPago/) | [](https://www.nuget.org/packages/MaxiPago/) |
---
## Features
Implements all features of MaxiPago API available at [Integration Documentation](https://www.maxipago.com/developers/apidocs/)
- 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
```cs
//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
```cs
//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
```cs
//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
```cs
//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
```cs
//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
```