Atualizar configurações

Este endpoint permite atualizar as configurações padrão dos seus relatórios. Tenha em mente que ao atualizar uma configuração, será necessário executar o endpoint 'Criar relatório' e, em seguida, 'Baixar relatório'. Em caso de sucesso, a requisição retornará uma resposta com o status 200.

PUT

https://api.mercadopago.com/v1/account/settlement_report/config
Request parameters
Header
Authorization
string

OBRIGATÓRIO

Access Token obtido através do painel de desenvolvedores. Obrigatório ser enviado em todas as requisições.
Body
columns
array

OBRIGATÓRIO

Detalhes das colunas que devem ser incluídas no relatório. Consulte todos os valores possíveis na seção Glossário.
file_name_prefix
string

OBRIGATÓRIO

Prefixo que compõe o nome do relatório uma vez gerado e pronto para download. Não permite valores vazios ou nulos.
frequency
object

OBRIGATÓRIO

Este campo indica a frequência com a qual o relatório deve ser gerado, podendo ser diária, semanal ou mensal.
sftp_info
object
Este campo fornece os dados de conexão necessários para que possamos acessar seu servidor. Ele é opcional, e somente deverá ser enviado caso queira receber os relatórios via SFTP.
Response parameters
file_name_prefix
string
Prefixo que compõe o nome do relatório uma vez gerado e pronto para download, não permitindo valores vazios ou nulos.
display_timezone
string
Este campo define a data e a hora exibidas nos relatórios. Na ausência de uma configuração específica de fuso horário, o sistema adota por padrão o valor GMT-04. Para fusos horários sujeitos ao horário de verão, ajustes ...Ver mais
include_withdrawal_at_end
boolean
Indica se as transações de retirada realizadas ao final do intervalo de datas devem ser incluídas.
scheduled
boolean
Campo informativo que indica se já existem relatórios programados na conta do usuário. Será 'true' se a criação automática está ativada, e 'false' se está desativada.
Erros

400Erro.

Invalid file_name_prefix

Prefixo de nome de arquivo inválido.

Invalid execute_after_withdrawal

Execução inválida após retirada.

Invalid columns

Colunas inválidas.

Invalid frequency

Frequência inválida.

Invalid SFTP info

Informações SFTP inválidas.

Invalid webhook

Webhook inválido.

Invalid file config

Configuração de arquivo inválida.

Invalid report_language

Idioma do relatório inválido.

401Não autorizado.

Invalid token

Token inválido.

Request
curl -X PUT \
    'https://api.mercadopago.com/v1/account/settlement_report/config'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer APP_USR-4*********994754-12*********c73b4e1ac*********cef36b27c*********840' \
    -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"
  }
}