Home
Documentation
Resources
Certifications
Community

Resources

Check for updates on our solutions and system performance, or request technical support.

Community

Get the latest news, ask others for help and share your knowledge.

Create new configuration - Releases - Mercado Pago Developers

Intelligent search powered by OpenAI 

Create a new configuration

POST

https://api.mercadopago.com/v1/account/release_report/config
This endpoint allows for the configuration of specific fields to customize preferences before initiating the report creation process. The settings will be applied in the generation of reports afterwards. Important: After creating the configuration, it will not be possible to use this endpoint to create a new one. To apply changes to the report configuration, update an existing configuration through the 'Update configurations' endpoint.
Request's parameters
BODY
columns
array

REQUIRED

Field with the details of the columns to be included in the report. Find all possible values in the Glossary section (https://www.mercadopago.com.co/developers/en/docs/checkout-pro/additional-content/reports/released-mon...View more
file_name_prefix
string

REQUIRED

Prefix that composes the report name once generated and ready for download, not allowing empty or null values.
frequency
object

REQUIRED

This field indicates the frequency with which the report should be generated, which can be daily, weekly, or monthly.
sftp_info
object
This field provides the necessary connection data for us to access your server. It is optional and should only be sent if you want to receive the reports via SFTP.
Response parameters
file_name_prefix
string
Prefix that composes the report name once generated and ready for download, not allowing empty or null values.
notification_email_list
array
Field containing a group of email recipients who will receive notifications when a report is ready and available for download. Make sure to include the email associated with your Mercado Pago account to also receive noti...View more
display_timezone
string
This field sets the date and time displayed in the reports. In the absence of a specific time zone configuration, the system defaults to GMT-04. For time zones subject to daylight saving time, manual adjustments will be ...View more
include_withdrawal_at_end
boolean
This field indicates whether withdrawal transactions made at the end of the specified date range in the report have been included.
Errors

400Error.

Invalid file_name_prefix

Invalid file name prefix.

Invalid execute_after_withdrawal

Invalid execute after withdrawal.

Invalid columns

Invalid columns.

Invalid frequency

Invalid frequency.

Invalid sftp info

Invalid SFTP info.

Invalid webhook

Invalid webhook.

Invalid file config

Invalid file config.

Invalid report_language

Invalid report language.

Invalid notification_email_list

Invalid notification email list.

401Unauthorized.

invalid token

Invalid token.

409Conflict.

Duplicated id

The record already exists.

Request
curl -X POST \
    'https://api.mercadopago.com/v1/account/release_report/config'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer TEST-2151*********762-03031*********750b665b7*********4dac477-1*********' \
    -d '{
  "columns": [
    {
      "key": "SOURCE_ID"
    }
  ],
  "file_name_prefix": "conciliation-settlement-report",
  "frequency": {
    "hour": 0,
    "value": 1,
    "type": "monthly"
  },
  "sftp_info": {
    "server": "sftp.myserver.com",
    "password": "mypassword",
    "remote_dir": "/myfolder",
    "port": 22,
    "username": "username"
  },
  "separator": ";",
  "display_timezone": "GMT-04",
  "report_translation": "es",
  "notification_email_list": [
    {}
  ],
  "include_withdrawal_at_end": false,
  "check_available_balance": false,
  "compensate_detail": false,
  "execute_after_withdrawal": false,
  "scheduled": false
}'
Sample answer
{
  "file_name_prefix": "release-report-USER_ID",
  "notification_email_list": [
    {}
  ],
  "display_timezone": "GMT-04",
  "include_withdrawal_at_end": true,
  "scheduled": false,
  "execute_after_withdrawal": false,
  "columns": [
    {
      "key": "SOURCE_ID"
    }
  ],
  "report_translation": "es",
  "frequency": {
    "hour": 0,
    "value": 1,
    "type": "monthly"
  }
}