Busca inteligente powered by OpenAI
Criar uma nova configuração
POST
Produtos relacionados:
Parâmetros de requisição
BODY
columns
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.br/developers/pt/docs/checkout-pro/additional-content/reports/...Ver maisarray
OBRIGATÓRIO
file_name_prefix
Prefixo que compõe o nome do relatório uma vez gerado e pronto para download, não permitindo valores vazios ou nulos.string
OBRIGATÓRIO
frequency
Este campo indica a frequência com a qual o relatório deve ser gerado, podendo ser diária, semanal ou mensal.object
OBRIGATÓRIO
sftp_info
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.object
Parâmetros de resposta
file_name_prefix
Prefixo que compõe o nome do relatório uma vez gerado e pronto para download, não permitindo valores vazios ou nulos.string
notification_email_list
Campo que contém um grupo de destinatários de e-mail que receberão notificações quando um relatório estiver pronto e disponível para download. Certifique-se de incluir o e-mail associado à sua conta do Mercado Pago para ...Ver maisarray
display_timezone
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 maisstring
include_withdrawal_at_end
Este campo indica se as transações de saque realizadas no final do intervalo de datas especificado no relatório foram incluídas.boolean
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.
Invalid notification_email_list
Lista de e-mails para notificação inválida.
401Unauthorized.
invalid token
Token inválido.
409Conflict.
Duplicated id
O registro já existe.
Requisição
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 '{
"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",
"notification_email_list": [
{}
],
"include_withdrawal_at_end": false,
"check_available_balance": false,
"compensate_detail": false,
"execute_after_withdrawal": false,
"scheduled": false
}'Resposta de exemplo
{
"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"
}
}