Criar relatórios

Os relatórios do Yuno oferecem uma maneira prática de obter informações sobre diferentes estágios de pagamentos. Você pode solicitar e baixar sem esforço vários relatórios associados às suas operações no Yuno. O Yuno oferece quatro tipos de relatórios:

• Payment
• Transação
• Reconciliação de transações
• Assentamento

Você pode verificar a descrição detalhada de cada um deles acessando a documentação dos Campos de relatórios. Os relatórios Reconciliação e Liquidação de Transações fornecem informações relacionadas à reconciliação. Para examinar todos os campos disponíveis em cada relatório e sua descrição, acesse a página Campos de relatórios.

Requisitos

Para solicitar um relatório, você precisará:

• Acesse seu Credenciais da API no Painel de Controle da Yuno, que consistem em:
  • public-api-key
  • private-secrete-key

📘

Explore as coleções de Yuno Postman

A Yuno fornece Postman Collections que você pode usar para replicar os casos de uso localmente.

Resumo das etapas

O processo para receber um relatório ao usar o Yuno é composto de duas etapas:

1. Criar um relatório
2. Faça o download de um relatório

Acessar um relatório

Conforme mostrado no resumo das etapas, é necessário concluir duas etapas antes de acessar o relatório.

Etapa 1: Criar um relatório

Para iniciar o processo de geração de relatórios, solicite ao Yuno que crie o relatório usando o comando Criar um endpoint de relatório. Primeiro, selecione o tipo de relatório desejado (type), que determinará o conteúdo do relatório gerado. Em segundo lugar, defina o intervalo de datas que deseja incorporar aos dados do relatório, configurando os parâmetros start_date e end_date.

Ao criar o relatório, você pode filtrar os dados adicionados especificando os valores de alguns campos. Por exemplo, você pode querer receber dados relacionados apenas a transações realizadas na Argentina e no Brasil. Nesse caso, você forneceria o campo AR,BR conteúdo para o parâmetro country.

Você tem a opção de filtrar os seguintes campos ao criar o relatório:

• payment_status
• payment_sub_status
• payment_method
• currency
• country
• transaction_type
• transaction_status
• updated_at_start
• updated_at_end

📘

Formato dos valores de filtro

Ao definir os valores de filtro, forneça-os em uma lista de valores de cadeia de caracteres, como no exemplo abaixo: "payment_status": "CREATED,READY_TO_PAY,DECLINED"

Para relatórios de Pagamento ou Transação, você também tem a opção de selecionar os campos incluídos no relatório final usando o parâmetro columns.

Quando você usa o Criar um endpoint de relatório para solicitar a criação de um relatório; na resposta, você receberá o relatório id e status. Você usará o id ao solicitar o download do relatório em Etapa 3. O status informa se ele está pronto para download.

Etapa 2: Verifique se o relatório está pronto

Depois de solicitar a criação do relatório, você pode usar endpoints Recuperar um relatório ou Listar todos os relatórios para verificar se ele está pronto para download. Ao usar o Recuperar um endpoint de relatórioVocê precisa fornecer o relatório id. Por outro lado, com o endpoint Listar todos os relatóriosVocê precisa informar seu account_id para receber uma lista de todos os relatórios existentes e seus status.

Quando o relatório tiver o status SUCCEEDEDvocê pode solicitar seu download. Acesse o Página de status do relatório para verificar todos os status de relatório possíveis.

Etapa 3: Faça o download de seu relatório

Use o Faça o download de um relatório para receber seu relatório, fornecendo seus id. Você receberá o relatório em um arquivo .zip. No entanto, para relatórios de liquidação, a API retornará um arquivo .csv.