https://github.com/mercadopago/sdk-ruby

Mercado Pago's Official Ruby SDK
https://github.com/mercadopago/sdk-ruby

backend-sdk mercadopago ruby sdk

Last synced: 1 day ago
JSON representation

Mercado Pago's Official Ruby SDK

• Host: GitHub
• URL: https://github.com/mercadopago/sdk-ruby
• Owner: mercadopago
• License: mit
• Created: 2012-10-24T13:25:58.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-02-06T21:59:45.000Z (12 months ago)
• Last Synced: 2024-03-25T22:10:14.055Z (10 months ago)
• Topics: backend-sdk, mercadopago, ruby, sdk
• Language: Ruby
• Homepage: https://developers.mercadopago.com/
• Size: 3.26 MB
• Stars: 66
• Watchers: 42
• Forks: 51
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Mercado Pago SDK for Ruby

[![Gem](https://img.shields.io/gem/v/mercadopago-sdk)](https://rubygems.org/gems/mercadopago-sdk)

[![Gem](https://img.shields.io/gem/dt/mercadopago-sdk)](https://rubygems.org/gems/mercadopago-sdk)

![GitHub](https://img.shields.io/github/license/mercadopago/sdk-ruby)

This library provides developers with a simple set of bindings to help you integrate Mercado Pago API to a website and start receiving payments.

## 💡 Requirements

Ruby version **2.3 or greater**.

## 📲 Installation 

Run ```gem install mercadopago-sdk```

## 🌟 Getting Started

First time using Mercado Pago? Create your [Mercado Pago account](https://www.mercadopago.com).

Copy your `Access Token` in the [credentials panel](https://www.mercadopago.com/developers/panel/app) and replace the text `YOUR_ACCESS_TOKEN` with it.

### Simple usage

To generate a `card token` read the [Checkout API](https://www.mercadopago.com/developers/en/guides/online-payments/checkout-api/introduction) documentation.

```ruby

require 'mercadopago'

sdk = Mercadopago::SDK.new('YOUR_ACCESS_TOKEN')

custom_headers = {

 'x-idempotency-key': ''

}

custom_request_options = Mercadopago::RequestOptions.new(custom_headers: custom_headers)

payment_data = {

  transaction_amount: 100,

  token: 'CARD_TOKEN',

  description: 'Payment description',

  payment_method_id: 'visa',

  installments: 1,

  payer: {

    email: '[email protected]'

  }

}

result = sdk.payment.create(payment_data, custom_request_options)

payment = result[:response]

puts payment

```

### Per-request configuration

All methods that make API calls accept an optional `RequestOptions` object. This can be used to configure some special options of the request, such as changing credentials or custom headers.

```ruby

require 'mercadopago'

request_options = Mercadopago::RequestOptions.new(access_token: 'YOUR_ACCESS_TOKEN')

# ...

result = sdk.payment.create(payment_data, request_options: request_options)

payment = result[:response]

```

## 📚 Documentation 

Visit our Dev Site for further information regarding:

 - [Developer Docs](https://www.mercadopago.com/developers/en/docs)

 - [Checkout Bricks](https://www.mercadopago.com/developers/en/docs/checkout-bricks/landing)

 - [Checkout Pro](https://www.mercadopago.com/developers/en/guides/online-payments/checkout-pro/introduction)

 - [Checkout API](https://www.mercadopago.com/developers/en/guides/online-payments/checkout-api/introduction)

Check our official code reference to explore all available functionalities.

## 🤝 Contributing

All contributions are welcome, ranging from people wanting to triage issues, others wanting to write documentation, to people wanting to contribute code.

Please read and follow our [contribution guidelines](CONTRIBUTING.md). 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.

## ❤️ Support

If you require technical support, please contact our support team at [developers.mercadopago.com](https://developers.mercadopago.com).

## 🏻 License

```

MIT license. Copyright (c) 2021 - Mercado Pago / Mercado Libre

For more information, see the LICENSE file.

```