Update configurationshttps://api.mercadopago.com/v1/account/settlement_report/config
This endpoint updates the default settings of your reports. Keep in mind that when updating a configuration, you will need to execute the 'Create report' endpoint and then 'Download report'. In case of success, the request will return a response with status 200.
PUT
Request parameters
Header
Authorization
Access Token obtained through the developer panel. Must be sent in all requests.string
REQUIRED
Body
columns
Details of the columns to be included in the report. See all possible values in the Glossary section.array
REQUIRED
file_name_prefix
Prefix that composes the report name once generated and ready for download. It does not allow empty or null values.string
REQUIRED
frequency
This field indicates the frequency with which the report should be generated, which can be daily, weekly, or monthly.object
REQUIRED
sftp_info
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.object
Response parameters
file_name_prefix
Prefix that composes the report name once generated and ready for download, not allowing empty or null values.string
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
Indicates whether withdrawal transactions made at the end of the date range should be included.boolean
scheduled
Informative field indicating whether there are already scheduled reports in the user's account. It will be 'true' if automatic generation is enabled, and 'false' if it is disabled.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.
401Unauthorized.
Invalid token
Invalid token.
Request
curl -X PUT \
'https://api.mercadopago.com/v1/account/settlement_report/config'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer APP_USR-8*********932064-12*********edf6d3c99*********2236c703f*********668' \
-d '{
"columns": [
{
"key": "EXTERNAL_REFERENCE"
}
],
"file_name_prefix": "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",
"header_language": "es",
"scheduled": false,
"include_withdraw": false,
"refund_detailed": false,
"shipping_detail": false,
"coupon_detailed": false,
"show_chargeback_cancel": false,
"show_fee_prevision": false
}'Response
{
"file_name_prefix": "settlement-report-USER_ID",
"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"
}
}