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. In case of success, the request will return a response with status 200.
POST
REQUIRED
REQUIRED
REQUIRED
REQUIRED
REQUIRED
400Error.
Invalid file_name_prefix
Invalid file name prefix.
Invalid include_withdraw
Invalid include withdrawal execution.
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.
409Conflict.
Duplicated id
The record already exists.
curl -X POST \
'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
}'{
"file_name_prefix": "settlement-report-USER_ID",
"display_timezone": "GMT-04",
"scheduled": false,
"columns": [
{
"key": "EXTERNAL_REFERENCE"
}
],
"report_translation": "es",
"header_language": "es",
"frequency": {
"hour": 0,
"value": 1,
"type": "monthly"
}
}