Skip to content

Latest commit

 

History

History
188 lines (124 loc) · 5.45 KB

README.md

File metadata and controls

188 lines (124 loc) · 5.45 KB

MercadoPago SDK module for Payments integration

Usage

To use this plugin, add mercadopago_sdk as a dependency in your pubspec.yaml file.

  • Basic checkout
  • Customized checkout
  • Generic methods

Basic checkout

Configure your credentials


import 'package:mercadopago_sdk/mercadopago_sdk.dart';

var mp = MP("CLIENT_ID", "CLIENT_SECRET");

Instance with only access token

var mp = MP.fromAccessToken("TOKEN");

Preferences

Get an existent Checkout preference


Future<Map<String, dynamic>> index() async {
    result = await mp.getPreference("PREFERENCE_ID");

    return result;
}

Create a Checkout preference


Future<Map<String, dynamic>> index() async {
    var preference = {
        "items": [
            {
                "title": "Test",
                "quantity": 1,
                "currency_id": "USD",
                "unit_price": 10.4
            }
        ]
    };

    var result = await mp.createPreference(preference);

    return result;
}

Update an existent Checkout preference


Future<Map<String, dynamic>> index() async {
    var preference = {
        "items": [
            {
                "title": "Test Modified",
                "quantity": 1,
                "currency_id": "USD",
                "unit_price": 20.4
            }
        ]
    };

    var result = await mp.updatePreference(id, preference);

    return result;
}

Payments/Collections

Search for payments

Future<Map<String, dynamic>> index() async {
    var filters = {
        "id": None,
        "external_reference": None
    };

    var searchResult = await mp.searchPayment(filters)

    return searchResult;
}

Get payment data

Future<Map<String, dynamic>> index() async {
    paymentInfo = await mp.getPayment("PID");

    return paymentInfo;
}

Cancel (only for pending payments)

Future<Map<String, dynamic>> index() async {
    var result = await mp.cancelPayment("PID");

    // Show result
    return result;
}

Refund (only for accredited payments)

Future<Map<String, dynamic>> index() async {
    var result = await mp.refundPayment("PID");

    // Show result
    return result;
}

Customized checkout

Configure your credentials


import 'package:mercadopago_sdk/mercadopago_sdk.dart';

var mp = MP("ACCESS_TOKEN");

Create payment

mp.post("/v1/payments", data);

Create customer

mp.post("/v1/customers", {"email": "[email protected]"});

Get customer

mp.get("/v1/customers/CUSTOMER_ID");

Generic methods


You can access any other resource from the MercadoPago API using the generic methods:

// Get a resource, with optional URL params. Also you can disable authentication for public APIs
mp.get("/resource/uri", { params, authenticate });

// Create a resource with "data" and optional URL params.
mp.post("/resource/uri", { data, params });

// Update a resource with "data" and optional URL params.
mp.put("/resource/uri", { data, params });

// Delete a resource with optional URL params.
mp.delete("/resource/uri", { params });

For example, if you want to get the Sites list (no params and no authentication):

var result = mp.get("/sites");

print(result);