What are you looking for?
Do not know how to start integrating?
Check the first stepsCreate a new configuration
POST
Products that use it:
Request's parameters
BODY
check_available_balance
This configuration displays the account balance before and after a withdrawal, offering an explanatory view of balance variations. It should be excluded for balance and/or account balance checks, and if you wish to use i...View moreboolean
columns
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 morearray
REQUIRED
compensate_detail
Locks and unlocks of money that offset each other and do not affect the final balance. This functionality facilitates the understanding of the formation of the final balance of the report through a chronological sequence...View moreboolean
display_timezone
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 morestring
Response parameters
file_name_prefix
Prefix that composes the report name once generated and ready for download, not allowing empty or null values.string
notification_email_list
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 morearray
display_timezone
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 morestring
include_withdrawal_at_end
This field indicates whether withdrawal transactions made at the end of the specified date range in the report have been included.boolean
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.
Did you find this information useful?
Yes
Not
Request
curl -X POST \
'https://api.mercadopago.com/v1/account/release_report/config'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
-d '{
"check_available_balance": false,
"columns": [
{
"key": "SOURCE_ID"
}
],
"compensate_detail": false,
"display_timezone": "GMT-04",
"execute_after_withdrawal": false,
"file_name_prefix": "conciliation-settlement-report",
"frequency": {
"hour": 0,
"value": 1,
"type": "monthly"
},
"include_withdrawal_at_end": false,
"notification_email_list": [
{}
],
"report_translation": "es",
"scheduled": false,
"separator": ";",
"sftp_info": {
"server": "sftp.myserver.com",
"password": "mypassword",
"remote_dir": "/myfolder",
"port": 22,
"username": "username"
}
}'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"
}
}