Criar uma nova configuração

Este endpoint permite a configuração de campos específicos para personalizar as preferências antes de dar início ao processo de criação dos relatórios. As definições serão aplicadas na criação de relatórios posteriormente. Importante: Após criar a configuração, não será possível utilizar este endpoint para criar uma nova. Para aplicar mudanças na configuração do relatório, atualize uma configuração já existente através do endpoint 'Atualizar configurações'. Em caso de sucesso, a requisição retornará uma resposta com o status 200.

POST

https://api.mercadopago.com/v1/account/release_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

Campo com os detalhes das colunas que deverão ser incluídas no relatório. Encontre todos os valores possíveis na seção Glossário (https://www.mercadopago.com/developers/pt/docs/checkout-pro/additional-content/reports/rel...Ver mais
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
Este campo indica se as transações de saque realizadas no final do intervalo de datas especificado no relatório foram 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 a 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

Arquivo de configuração inválido.

Invalid report_language

Idioma do relatório inválido.

401Unauthorized.

Invalid token

Token inválido.

409Conflict.

Duplicated id

O registro já existe.

Request
curl -X POST \
    'https://api.mercadopago.com/v1/account/release_report/config'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer APP_USR-4*********994754-12*********c73b4e1ac*********cef36b27c*********840' \
    -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",
  "include_withdrawal_at_end": false,
  "check_available_balance": false,
  "compensate_detail": false,
  "execute_after_withdrawal": false,
  "scheduled": false
}'
Response
{
  "file_name_prefix": "release-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"
  }
}