MercadoPago icon

MercadoPago

Consume MercadoPago API

Reporting → Create or Update Release Report Config

AI-generated

Summary

Create or update the Release Report configuration for the MercadoPago account by specifying report columns, file name prefix, frequency, and additional optional settings. Automatically uses POST to create the config or PUT to update if it already exists.

Inputs

  • Columns (required) — Select one or more columns to include in the Release Report, each specified by a predefined key or a custom key.
  • File Name Prefix (required) — Prefix string that will be added to each generated report file name.
  • Frequency (required) — Schedule settings specifying the hour (0-23), frequency value (positive integer), and frequency type (daily, weekly, or monthly) for automatic report generation.
  • Additional Fields — Optional configuration settings including CSV separator, display timezone, report translation language code, list of notification emails, and boolean toggles for including withdrawals, checking available balance, compensation details, execution after withdrawal, and scheduling the report.
  • SFTP Credentials — Optional SFTP connection details (server, username, password, remote directory, port) for automatic report delivery via SFTP.

Output shape

a single object representing the created or updated report configuration response from MercadoPago's API

When submitting this operation, it will first attempt to create a new Release Report configuration via POST. If a configuration already exists (409 conflict), it will update the configuration via PUT automatically. The returned object contains the API response data confirming the current configuration state.

Examples

Example 1: Create a new Release Report configuration with columns DATE and NET_CREDIT_AMOUNT, a file name prefix 'monthly-', frequency set to run daily at hour 0, and notifications sent to a specified email.

Columns: DATE, NET_CREDIT_AMOUNT; File Name Prefix: 'monthly-'; Frequency: daily at 00:00; Notifications: email 'finance@example.com'.

Links

Discussion