Skip to content

Latest commit

 

History

History
 
 

docs

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Mercado Pago .Net | MercadoPago official .NET SDK </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Mercado Pago .Net | MercadoPago official .NET SDK ">
    <meta name="generator" content="docfx 2.56.6.0">

    <link rel="shortcut icon" href="favicon.ico">
    <link rel="stylesheet" href="styles/docfx.vendor.css">
    <link rel="stylesheet" href="styles/docfx.css">
    <link rel="stylesheet" href="styles/main.css">
    <meta property="docfx:navrel" content="toc">
    <meta property="docfx:tocrel" content="toc">

    <meta property="docfx:rel" content="">

  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>

        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>

              <a class="navbar-brand" href="index.html">
                <img id="logo" class="svg" src="logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>

                <ul class="nav level1 navbar-nav">
                      <li>
                          <a href="index.html" title="Home">Home</a>
                      </li>
                      <li>
                          <a href="sdk/MercadoPago.Client.html" title="SDK Documentation">SDK Documentation</a>
                      </li>
                </ul>    </div>
          </div>
        </nav>

        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div class="container body-content">

        <div id="search-results">
          <div class="search-list">Search Results for <span></span></div>
          <div class="sr-items">
            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
          </div>
          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
        </div>
      </div>
      <div role="main" class="container body-content hide-when-search">
        <div class="article row grid">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="">
<h1 id="mercado-pago-net">Mercado Pago .Net</h1>

<p><a href="README.pt.html">Portuguese</a> / <a href="README.es.html">Spanish</a></p>
<p><img src="https://github.com/mercadopago/sdk-dotnet/workflows/CI/badge.svg" alt="CI">
<a href="https://www.nuget.org/packages/mercadopago-sdk"><img src="http://img.shields.io/nuget/v/mercadopago-sdk.svg" alt="NuGet"></a>
<a href="https://www.nuget.org/packages/mercadopago-sdk/"><img src="https://img.shields.io/nuget/dt/mercadopago-sdk.svg" alt="Download count"></a>
<a href="https://github.com/mercadopago/sdk-dotnet"><img src="https://img.shields.io/apm/l/vim-mode" alt="APM"></a></p>
<p>The official Mercado Pago .NET SDK.</p>
<h2 id="-requirements">💡 Requirements</h2>
<p><strong>.NET Standard 2.1+</strong>, <strong>.NET Core 2.0+</strong>, and <strong>.NET Framework 6.0+</strong>.</p>
<p>If you are using previous versions of .NET Framework in your project, please refer to the <a href="https://github.com/mercadopago/sdk-dotnet/tree/master-dotnet-framework">older versions</a> of the SDK.</p>
<h2 id="-installation">📲 Installation</h2>
<h3 id="using-the-net-core-command-line-interface-cli-tools">Using the <a href="https://docs.microsoft.com/en-us/dotnet/core/tools/">.NET Core command-line interface (CLI) tools</a></h3>
<pre><code class="lang-bash">dotnet add package mercadopago-sdk
</code></pre>
<h3 id="using-the-nuget-command-line-interface-cli">Using the <a href="https://docs.microsoft.com/en-us/nuget/tools/nuget-exe-cli-reference">NuGet Command Line Interface (CLI)</a></h3>
<pre><code class="lang-bash">nuget install mercadopago-sdk
</code></pre>
<h3 id="using-the-package-manager">Using the <a href="https://docs.microsoft.com/en-us/nuget/tools/package-manager-console">Package Manager</a></h3>
<pre><code class="lang-bash">Install-Package mercadopago-sdk
</code></pre>
<h3 id="from-visual-studio">From Visual Studio</h3>
<ol>
<li>Open the <code>Solution Explorer</code>.</li>
<li>Right-click on a project within your solution.</li>
<li>Click on <code>Manage NuGet Packages...</code>.</li>
<li>Click on the <code>Browse</code> tab and search for &quot;mercadopago-sdk&quot;.</li>
<li>Click on the <code>mercadopago-sdk</code> package, select the appropriate version and click Install.</li>
</ol>
<h2 id="-getting-started">🌟 Getting Started</h2>
<p>First time using Mercado Pago? Create your <a href="https://www.mercadopago.com">Mercado Pago account</a>.</p>
<p>Copy your <code>Access Token</code> in the <a href="https://www.mercadopago.com/developers/panel/credentials">credentials panel</a> and replace the text <code>YOUR_ACCESS_TOKEN</code> with it.</p>
<h3 id="simple-usage">Simple usage</h3>
<p>To generate a <code>card token</code> read the <a href="https://www.mercadopago.com/developers/en/guides/online-payments/checkout-api/introduction">Checkout API</a> documentation.</p>
<pre><code class="lang-csharp">using System;
using System.Threading.Tasks;
using MercadoPago.Client.Payment;
using MercadoPago.Config;
using MercadoPago.Resource.Payment;

MercadoPagoConfig.AccessToken = &quot;YOUR_ACCESS_TOKEN&quot;;

var request = new PaymentCreateRequest
{
    TransactionAmount = 10,
    Token = &quot;CARD_TOKEN&quot;,
    Description = &quot;Payment description&quot;,
    Installments = 1,
    PaymentMethodId = &quot;visa&quot;,
    Payer = new PaymentPayerRequest
    {
        Email = &quot;[email protected]&quot;,
    }
};

var client = new PaymentClient();
Payment payment = await client.CreateAsync(request);

Console.WriteLine($&quot;Payment ID: {payment.Id}&quot;);
</code></pre>
<h3 id="per-request-configuration">Per-request configuration</h3>
<p>All methods that make API calls accept an optional <code>RequestOptions</code> object. This can be used to configure some special options of the request, such as changing credentials or custom headers.</p>
<pre><code class="lang-csharp">using MercadoPago.Client;

var requestOptions = new RequestOptions();
requestOptions.AccessToken = &quot;YOUR_ACCESS_TOKEN&quot;;
// ...

var client = new PaymentClient();
Payment payment = await client.CreateAsync(request, requestOptions);

</code></pre>
<h2 id="advanced-usage">Advanced usage</h2>
<h3 id="using-a-proxy-server">Using a proxy server</h3>
<pre><code class="lang-csharp">using System.Net;
using System.Net.Http;
using MercadoPago.Config;
using MercadoPago.Http;

var handler = new HttpClientHandler
{
    Proxy = new WebProxy(proxyUrl),
    UseProxy = true,
};
var httpClient = new HttpClient(handler);
MercadoPagoConfig.HttpClient = new DefaultHttpClient(httpClient);

</code></pre>
<h3 id="configuring-automatic-retries">Configuring automatic retries</h3>
<p>The SDK automatically retries requests on intermittent failures. The default max number of attempts is <strong>2</strong>.</p>
<pre><code class="lang-csharp">using MercadoPago.Config;
using MercadoPago.Http;

var retryStrategy = new DefaultRetryStrategy(5);
MercadoPagoConfig.RetryStrategy = retryStrategy;

</code></pre>
<h2 id="-documentation">📚 Documentation</h2>
<p>Visit our Developer Site for further information regarding:</p>
<ul>
<li><a href="https://www.mercadopago.com/developers/en/reference">APIs</a></li>
<li><a href="https://www.mercadopago.com/developers/en/guides/online-payments/checkout-pro/introduction">Checkout Pro</a></li>
<li><a href="https://www.mercadopago.com/developers/en/guides/online-payments/checkout-api/introduction">Checkout API</a></li>
<li><a href="https://www.mercadopago.com/developers/en/guides/online-payments/web-tokenize-checkout/introduction">Web Tokenize Checkout</a></li>
</ul>
<p>Check our <a href="https://mercadopago.github.io/sdk-dotnet/">SDK docs</a> to explore all available functionalities.</p>
<h2 id="-contributing">🤝 Contributing</h2>
<p>All contributions are welcome, ranging from people wanting to triage issues, others wanting to write documentation, to people wanting to contribute code.</p>
<p>Please read and follow our <a href="CONTRIBUTING.html">contribution guidelines</a>. Contributions not following this guidelines will be disregarded. The guidelines are in place to make all of our lives easier and make contribution a consistent process for everyone.</p>
<h2 id="-support">❤️ Support</h2>
<p>If you require technical support, please contact our support team at <a href="https://developers.mercadopago.com">developers.mercadopago.com</a>.</p>
<h2 id="-license">🏻 License</h2>
<pre><code>MIT license. Copyright (c) 2021 - Mercado Pago / Mercado Libre
For more information, see the LICENSE file.
</code></pre>
</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                  <li>
                    <a href="https://github.com/mercadopago/dx-dotnet/blob/release/2.0.0/README.md/#L1" class="contribution-link">Improve this Doc</a>
                  </li>
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In This Article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>

      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>

            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>

    <script type="text/javascript" src="styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="styles/docfx.js"></script>
    <script type="text/javascript" src="styles/main.js"></script>
  </body>
</html>