MercadopagoAPI

Mercadopago.Requests.Preferences (MercadopagoAPI v0.2.1)

Documentation for Mercadopago.Requests.Preferences

Link to this section Summary

Functions

create(data)

Create preference docs

search()

Search in preferences docs

show(preference_id)

Get preference docs

update(preference_id, data)

Update Preference docs

Link to this section Functions

Link to this function

create(data)

Create preference docs

examples

 Examples 

iex> data =
%{
  "items": [
    %{
      "title": "Dummy Title",
      "description": "Dummy description",
      "picture_url": "http://www.myapp.com/myimage.jpg",
      "category_id": "services",
      "quantity": 1,
      "currency_id": "BRL",
      "unit_price": 10
    }
  ]
}   
iex> Mercadopago.Requests.Preferences.create(data)
Link to this function

search()

Search in preferences docs

examples

 Examples 

iex> Mercadopago.Requests.Preferences.search()
{:ok,%{
"elements": [
  %{
    "id": "202809963-a2201f8d-11cb-443f-adf6-de5a42eed67d",
    "client_id": 6295877106812064,
    "collector_id": 202809963,
    "date_created": "2018-02-02T19:18:51.150Z",
    "items": [
      %{}
    ],
    "marketplace": "NONE",
    "site_id": "MLA",
    "sponsor_id": 0
  }
],
"next_offset": 1,
"total": 1
}
}
Link to this function

show(preference_id)

Get preference docs

examples

 Examples 

iex> Mercadopago.Requests.Preferences.show("1212121")
{:ok,%{
  "back_urls": %{},
  "client_id": 6295877106812064,
  "collector_id": 202809963,
  "date_created": "2018-02-02T19:18:51.150Z",
  "id": "202809963-a2201f8d-11cb-443f-adf6-de5a42eed67d",
  "init_point": "https://www.mercadopago.com/mla/checkout/start?pref_id=202809963-a2201f8d-11cb-443f-adf6-de5a42eed67d",
  "items": [
    %{
      "id": "item-ID-1234",
      "currency_id": "$",
      "title": "Practical Granite Shirt",
      "picture_url": "http://placehold.it/350x150",
      "description": "This is my description",
      "quantity": 2,
      "unit_price": 14.5
    }
  ],
  "marketplace": "MP-MKT-6295877106812064",
  "marketplace_fee": 0,
  "statement_descriptor": "MERCADOPAGO",
  "payer": %{
    "phone": %{
      "number": "631.586.0213"
    },
    "address": %{
      "zip_code": 76336,
      "street_name": "Marjory Stream",
      "street_number": 941
    },
    "identification": %{
      "number": 12345678,
      "type": "DNI"
    }
  },
  "payment_methods": %{
    "excluded_payment_methods": [
      %{}
    ],
    "excluded_payment_types": [
      %{}
    ]
  },
  "sandbox_init_point": "https://sandbox.mercadopago.com/mla/checkout/pay?pref_id=202809963-a2201f8d-11cb-443f-adf6-de5a42eed67d",
  "shipments": %{
    "receiver_address": {}
  }
}
Link to this function

update(preference_id, data)

Update Preference docs

examples

 Examples 

iex> data =
%{
  "items": [
    %{
      "title": "Dummy Title",
      "description": "Dummy description",
      "picture_url": "http://www.myapp.com/myimage.jpg",
      "category_id": "car_electronics",
      "quantity": 1,
      "currency_id": "U$",
      "unit_price": 10
    }
  ],
  "payer": %{
    "phone": %{},
    "identification": %{},
    "address": %{}
  },
  "payment_methods": %{
    "excluded_payment_methods": [
      %{}
    ],
    "excluded_payment_types": [
      %{}
    ]
  },
  "shipments": %{
    "free_methods": [
      %{}
    ],
    "receiver_address": %{}
  },
  "back_urls": %{},
  "differential_pricing": %{},
  "tracks": [
    %{
      "type": "google_ad"
    }
  ],
  "metadata": %{}
}         
iex> Mercadopago.Requests.Preferences.update("12345", data)