Mercado Pago

https://www.mercadopago.com.br/developers/pt/docs/
Admin
Mercado Pago provides comprehensive documentation and tools for developers to integrate its online...
Tokens:1,111,434
Snippets:5,107
Trust Score:9.3
Update:1 day ago
Show doc for...
Tokens:
Raw
### GET Notifier por ID - JSON response

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-api-payments/additional-content/reports/sales-report/queries-and-validations

Example response for the GET Notifier by ID endpoint. Shows a single notifier object with the same structure as the list response.

```json
{
    "id": {{notifier_id}},
    "type": "email",
    "data": {
        "recipients": [
            "test@mercadolibre.com"
        ]
    },
    "description": null,
    "version": 0,
    "status": "ACTIVE",
    "is_pii_data": true
}
```

--------------------------------

### Instalar SDK Go com go get

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-pro-preferences/configure-development-enviroment

Execute este comando no terminal para instalar o SDK do Mercado Pago para Go.

```go
go get -u github.com/mercadopago/sdk-go
```

--------------------------------

### GET Notifiers - JSON response

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-api-payments/additional-content/reports/sales-report/queries-and-validations

Example response for the GET Notifiers endpoint. Shows an array of notifier objects with fields like id, type, data, status, and is_pii_data.

```json
[
    {
        "id": {{notifier_id}},
        "type": "email",
        "data": {
            "recipients": [
                "test@mercadolibre.com"
            ]
        },
        "description": null,
        "version": 0,
        "status": "ACTIVE",
        "is_pii_data": true
    },
    {
       ... // more responses
    }
]
```

--------------------------------

### Instalar SDK C# com NuGet

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-pro-preferences/configure-development-enviroment

Execute este comando no terminal para instalar o SDK do Mercado Pago para C# usando NuGet.

```csharp
nuget install mercadopago-sdk
```

--------------------------------

### Get Installments (getInstallments) in Kotlin

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-api-payments/integration-configuration/card/integration-via-core-methods-native

Retrieves all valid installment options for a given card and transaction amount. Must be called for all card types (debit and credit). Use the BIN from CardNumberTextFieldEvent.OnBinChanged.

```Kotlin
val coreMethods = MercadoPagoSDK.getInstance().coreMethods
coroutineScope { 
   // Se deve usar o bin retornado do CardNumberTextFieldEvent.OnBinChanged
   val result = coreMethods.getInstallments(
       bin = bin,
       amount = BigDecimal("100.00")
   )
   when (result) {
       is Result.Success -> {
           // Sucesso da chamada
           print("Sucesso de request: ${result.data}")
       }

       is Result.Error -> {
           when (result.error) {
               is ResultError.Request -> {
                   // Erro da chamada do tipo request
                   print("Erro de request: ${result.error}")
               }

               is ResultError.Validation -> {
                   // Erro da chamada do tipo validation
                   print("Erro de validação: ${result.error}")
               }
           }
       }
   }
}
```

--------------------------------

### Instalar SDK React do Mercado Pago via npm

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-bricks/common-initialization

Instale o pacote @mercadopago/sdk-react para usar os Bricks em projetos React.

```bash
npm install @mercadopago/sdk-react
```

--------------------------------

### GET Events - JSON response

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-api-payments/additional-content/reports/sales-report/queries-and-validations

Example response for the GET Events endpoint. Shows an array of event objects with fields like id, type, data, description, structure_id, notifiers, status, and version.

```json
[
    {
        "id": {{event_id}},
        "type": "frequency",
        "data": {
            "period": "daily",
            "value": 1,
            "hour": 20,
            "skip_non_working_days": false
        },
        "description": "Mail diario a las 20:00",
        "structure_id": {{structure_id}},
        "notifiers": [
            {{notifier_id}}
        ],
        "status": "ACTIVE",
        "version": 1
    },
    {
      ... // more responses
    }
]
```

--------------------------------

### Prompt para testar a conexão com a tool search-documentation

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-api-orders/resources/mcp-server/connection

Execute este prompt no assistente para testar a conexão ao MCP Server usando a tool search-documentation. Substitua o texto da busca pela informação desejada.

```plain
Busque na documentação do Mercado Pago como integrar o Checkout Pro.
```

--------------------------------

### GET Statement por ID - JSON response

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-api-payments/additional-content/reports/sales-report/queries-and-validations

Example JSON response returned by the GET statement endpoint. It includes the statement details, report information, download URLs for JSON and CSV formats, origin data, structure, notifiers, and status.

```json
{
    "id": {{statement_id}},
    "date_start": "2023-07-18T00:00:00Z",
    "date_end": "2023-07-20T19:00:00Z",
    "date_created": "2023-07-21T17:25:25.764122Z",
    "created_by": "automatic",
    "description": "statement de pruebas",
    "report": {
        "id": "marketplace_sellers_sales",
        "name": "Marketplace OP",
        "topic": "financial_statements",
        "version": "1"
    },
    "files": [
        {
            "type": "json",
            "url": "https://api.mercadopago.com/v1/reporting/reports/marketplace_sellers_sales/statements/{{statement_id}}/download?format=json"
        },
        {
            "type": "csv",
            "url": "https://api.mercadopago.com/v1/reporting/reports/marketplace_sellers_sales/statements/{{statement_id}}/download?format=csv"
        }
    ],
    "event": null,
    "origin": {
        "type": "date_range",
        "data": {
            "date_end": "2023-07-20T19:00:00Z",
            "date_start": "2023-07-18T00:00:00Z"
        }
    },
    "report_extra_data": {},
    "structure": {
        "id": {{structure_id}},
        "version": 0
    },
    "notifiers": [
        {
            "id": {{notifier_id_1}},
            "version": 0,
            "type": "email",
            "data": {}
        },
        {
            "id": {{notifier_id_n}},
            "version": 0,
            "type": "ftp",
            "data": {}
        }
    ],
    "status": "available",
    "reason_code": {
        "code": ""
    }
}
```

--------------------------------

### Inicializar MercadoPagoDevicesSDK no AppDelegate (Swift)

Source: https://www.mercadopago.com.br/developers/pt/docs/subscriptions/how-tos/improve-payment-approval/recommendations

Inicialize o SDK no evento `didFinishLaunchingWithOptions` do AppDelegate. Importe o módulo e chame `MercadoPagoDevicesSDK.shared.execute()`.

```swift
import MercadoPagoDevicesSDK
...
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  ... 
  MercadoPagoDevicesSDK.shared.execute()
  ...
}
```

--------------------------------

### List cards response (JSON)

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-api-orders/payment-management/improve-payment-approval/saved-cards

Example JSON response from the GET /v1/customers/{customer_id}/cards endpoint, showing an array of card objects.

```json
[{
    "id": "1490022319978",
    "expiration_month": 12,
    "expiration_year": 2020,
    "first_six_digits": "415231",
    "last_four_digits": "0001",
    ...
}]
```

--------------------------------

### Instalar Mercado Pago CLI via Homebrew

Source: https://www.mercadopago.com.br/developers/pt/docs/mp-cli/install-mp-cli

Instala a versão atual do Mercado Pago CLI usando o pacote Homebrew `mercadopago/tap/mpcli`. Execute após desinstalar a versão anterior, se aplicável.

```bash
brew install mercadopago/tap/mpcli
```

--------------------------------

### List customer cards response (JSON)

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-pro-orders/saved-cards

Example JSON response from the GET /v1/customers/{customer_id}/cards endpoint, showing customer details including saved cards and default_card.

```json
{
    "paging": {
        "limit": 10,
        "offset": 0,
        "total": 1
    },
    "results": [
        {
            "address": {
                "id": null,
                "street_name": null,
                "street_number": null,
                "zip_code": null
            },
            "addresses": [],
            "cards": [
                {
                    ...
                }
            ],
            "date_created": "2017-05-05T00:00:00.000-04:00",
            "date_last_updated": "2017-05-05T09:23:25.021-04:00",
            "date_registered": null,
            "default_address": null,
            "default_card": "1493990563105",
            "description": null,
            "email": "test_payer@testuser.com",
            "first_name": null,
            "id": "123456789-jxOV430go9fx2e",
            "identification": {
                "number": null,
                "type": null
            },
            "last_name": null,
            "live_mode": false,
            "metadata": {},
            "phone": {
                "area_code": null,
                "number": null
            }
        }
    ]
}
```

--------------------------------

### Instalar SDK Java com Maven

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-pro-preferences/configure-development-enviroment

Adicione esta dependência ao arquivo pom.xml e execute 'maven install' para instalar o SDK do Mercado Pago para Java.

```java
<dependency>
   <groupId>com.mercadopago</groupId>
   <artifactId>sdk-java</artifactId>
   <version>2.1.7</version>
</dependency>
```

--------------------------------

### Initialize PHP SDK with Access Token

Source: https://www.mercadopago.com.br/developers/pt/docs/sdks-library/overview

Initialize the Mercado Pago PHP SDK by setting your access token. Use your private key from 'Suas integrações > Dados da integração > Testes > Credenciais de teste'.

```php
require_once('vendor/autoload.php');
use MercadoPago\MercadoPagoConfig;
MercadoPagoConfig::setAccessToken("YOUR_ACCESS_TOKEN");
```

--------------------------------

### List customer cards response (JSON)

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-api-orders/payment-management/improve-payment-approval/saved-cards

Example JSON response from the GET /v1/customers/{customer_id}/cards endpoint, showing a paging object and a results array with customer card details.

```json
{
    "paging": {
        "limit": 10,
        "offset": 0,
        "total": 1
    },
    "results": [
        {
            "address": {
                "id": null,
                "street_name": null,
                "street_number": null,
                "zip_code": null
            },
            "addresses": [],
            "cards": [
                {
                    ...
                }
            ],
            "date_created": "2017-05-05T00:00:00.000-04:00",
            "date_last_updated": "2017-05-05T09:23:25.021-04:00",
            "date_registered": null,
            "default_address": null,
            "default_card": "1493990563105",
            "description": null,
            "email": "test@testuser.com",
            "first_name": null,
            "id": "123456789-jxOV430go9fx2e",
            "identification": {
                "number": null,
                "type": null
            },
            "last_name": null,
            "live_mode": false,
            "metadata": {},
            "phone": {
                "area_code": null,
                "number": null
            }
        }
    ]
}
```

--------------------------------

### Report configuration response (JSON)

Source: https://www.mercadopago.com.br/developers/pt/docs/reports/account-money/api

Example JSON response returned by the GET endpoint when the request is successful. Shows the structure of the report configuration, including file name prefix, frequency, and columns.

```json
{
    "file_name_prefix": "settlement-report-USER_ID",
    "show_fee_prevision": false,
    "show_chargeback_cancel": true,
    "scheduled": false,
    "coupon_detailed": true,
    "include_withdraw": true,
    "shipping_detail": true,
    "refund_detailed": true,
    "display_timezone": "GMT-04",
    "header_language": "pt",
    "frequency": {
        "hour": 0,
        "type": "monthly",
        "value": 1
    },
     "columns": [
        {
            "key": "TRANSACTION_DATE"
        },
        {
            "key": "SOURCE_ID"
        },
        {
            "key": "EXTERNAL_REFERENCE"
        }
    ]
}
```

--------------------------------

### Inicializar SDK de pagamento em Java (MainApplication)

Source: https://www.mercadopago.com.br/developers/pt/docs/smartapps/development-environment

Equivalente em Java da configuração do SDK: crie uma classe Application, configure MPConfigBuilder com Bluetooth e BluetoothUIConfig, e inicialize com MPManager.INSTANCE.initialize.

```java
public class MainApplication extends Application {
 @Override
 public void onCreate() {
   super.onCreate();
   MPConfig config = new MPConfigBuilder(this, "CLIENT_ID")
     .withBluetoothConfig()
     .withBluetoothUIConfig()
     .build();
   MPManager.INSTANCE.initialize(this, config);
 }
}
```

--------------------------------

### mpcli --help e mpcli payments --help

Source: https://www.mercadopago.com.br/developers/pt/docs/mp-cli/commands

Use a flag --help para consultar as opções disponíveis de qualquer comando do CLI. O padrão é `mpcli [recurso] [ação] [flags]`.

```bash
mpcli --help
mpcli payments --help
```

--------------------------------

### Configure Payment Methods Preference

Source: https://www.mercadopago.com.br/developers/pt/docs/checkout-bricks/payment-brick/advanced-features/preferences

Shows how to set the payment_methods preference to exclude specific payment types and methods, and define the maximum number of installments. Examples are provided in PHP, JavaScript, Java, Ruby, C#, and Python.

```APIDOC
## Configure Payment Methods Preference

### Description
Sets the `payment_methods` preference to customize payment options in Payment Brick, including excluding payment types (e.g., ticket) and methods (e.g., master), and limiting installments.

### Attributes
- **payment_methods** (object) - Required - Class describing payment method attributes and methods.
- **excluded_payment_types** (array) - Optional - List of payment types to exclude (e.g., ticket).
- **excluded_payment_methods** (array) - Optional - List of payment method IDs to exclude (e.g., master, amex).
- **installments** (integer) - Optional - Maximum number of installments allowed.
- **purpose** (string) - Optional - Set to `wallet_purchase` to restrict payments to registered Mercado Pago users.

### Request Example (PHP)
```php
<?php
$preference = new MercadoPago\Preference();
// ...
$preference->payment_methods = array(
  "excluded_payment_methods" => array(
    array("id" => "master")
  ),
  "excluded_payment_types" => array(
    array("id" => "ticket")
  ),
  "installments" => 12
);
// ...
?>
```

### Request Example (JavaScript)
```javascript
var preference = {}
preference = {
//...
"payment_methods": {
    "excluded_payment_methods": [
        {
            "id": "master"
        }
    ],
    "excluded_payment_types": [
        {
            "id": "ticket"
        }
    ],
    "installments": 12
	}
//...
}
```

### Request Example (Java)
```java
PreferenceClient client = new PreferenceClient();
//...
List<PreferencePaymentMethodRequest> excludedPaymentMethods = new ArrayList<>();
excludedPaymentMethods.add(PreferencePaymentMethodRequest.builder().id("master").build());
excludedPaymentMethods.add(PreferencePaymentMethodRequest.builder().id("amex").build());

List<PreferencePaymentTypeRequest> excludedPaymentTypes = new ArrayList<>();
excludedPaymentTypes.add(PreferencePaymentTypeRequest.builder().id("ticket").build());

PreferencePaymentMethodsRequest paymentMethods =
   PreferencePaymentMethodsRequest.builder()
       .excludedPaymentMethods(excludedPaymentMethods)
       .excludedPaymentTypes(excludedPaymentTypes)
       .installments(12)
       .build();

PreferenceRequest request = PreferenceRequest.builder().paymentMethods(paymentMethods).build();

client.create(request);
//...
```

### Request Example (Ruby)
```ruby
#...
preference_data = {
  # ...
  payment_methods: {
    excluded_payment_methods: [
      { id: 'master' }
    ],
    excluded_payment_types: [
      { id: 'ticket' }
    ],
    installments: 12
  }
  # ...
}
#...
```

### Request Example (C#)
```csharp
var paymentMethods = new PreferencePaymentMethodsRequest
{
    ExcludedPaymentMethods = new List<PreferencePaymentMethodRequest>
    {
        new PreferencePaymentMethodRequest
        {
            Id = "master",
        },
    },
    ExcludedPaymentTypes = new List<PreferencePaymentTypeRequest>
    {
        new PreferencePaymentTypeRequest
        {
            Id = "ticket",
        },
    },
    Installments = 12,
};

var request = new PreferenceRequest
{
    // ...
    PaymentMethods = paymentMethods,
};
```

### Request Example (Python)
```python
#...
preference_data = {
    "excluded_payment_methods": [
        { "id": "master" }
    ],
    "excluded_payment_types": [
        { "id": "ticket" }
    ],
    "installments": 12
}
#...
```
```
Tokens:
Raw