Access API

## Sections
• [Accesstage Tecnologia](https://developer.accesstage.com.br/developer/accesstage-tecnologia.md): A Accesstage é uma empresa especializada em pagamentos B2B e gestão financeira que surgiu como solução para atender a complexidade das transações no mercado financeiro para empresas que precisam conectar diferentes interfaces, integrar contas a pagar e contas a receber de múltiplas fontes, com origens e destinos diversos no ecossistema financeiro. Somos o parceiro de negócio ideal para plugar a sua empresa aos seus diversos bancos de relacionamento de forma automatizada, além de complementar o seu ERP com informações financeiras que apoiarão na sua tomada de decisão. Principais áreas de atuação da Accesstage: 1. Soluções de Pagamentos e Cobrança: A Accesstage oferece uma variedade de soluções para simplificar a gestão de pagamentos e cobranças de empresas de diferentes segmentos. Seus serviços incluem boletos bancários, débito automático, pagamento eletrônico de contas, entre outros. Essas soluções são projetadas para proporcionar eficiência e segurança nas transações financeiras das empresas, além de oferecer uma experiência conveniente para seus clientes. 2. Integração e Conciliação Financeira: A empresa disponibiliza soluções de integração e conciliação financeira que permitem que as empresas gerenciem seus dados financeiros de forma centralizada e automatizada. Isso inclui a conciliação de pagamentos, recebimentos, extratos bancários e informações contábeis, o que facilita o processo de tomada de decisões e a obtenção de insights financeiros relevantes. 3. Troca Segura de Arquivos: A Accesstage oferece soluções para a troca segura de arquivos entre empresas e seus parceiros de negócios. Isso inclui a API Rest Apus Fenix, que permite a transmissão segura de arquivos em diferentes formatos, garantindo a confidencialidade e a integridade dos dados compartilhados. Somos reconhecidos pela qualidade de seus serviços e pela inovação tecnológica. Com uma equipe altamente capacitada e uma infraestrutura robusta, a empresa está preparada para atender às necessidades do mercado corporativo e contribuir para o crescimento e sucesso de seus clientes. Sua dedicação em fornecer soluções financeiras confiáveis e eficientes tem fortalecido sua posição como uma das principais parceiras de negócios no setor financeiro brasileiro.
• [API - Transferencia de Dados](https://developer.accesstage.com.br/developer/api-transferencia-de-dados.md): A Accesstage apresenta a API Fênix, uma solução robusta para troca de informações entre parceiros comerciais. Com capacidade para manusear qualquer formato, esta ferramenta proporciona agilidade e confiabilidade, aliadas aos mais altos padrões de segurança. Pensando em aproveitar ao máximo da API Fênix, elaboramos um guia minucioso que facilita a integração, melhorando a comunicação e a troca de informações com seus parceiros comerciais. Com a API Fênix, a Accesstage se dedica a simplificar e otimizar as operações comerciais de nossos parceiros. Nossa solução, projetada para segurança e confiabilidade, tem o propósito de aprimorar a colaboração, ao mesmo tempo que assegura a integridade e privacidade dos dados compartilhados
  • [Autenticação](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/autenticacao.md): Este endpoint é utilizado para obter o token de acesso ( OAuth2 ) necessário para utilizar os demais endpoints da API Fenix. Em Authorization deve-se informar suas credenciais clientID e clienteSecret O exemplo abaixo é usando o postman. Passo a Passo 1º - copie o link " https://apus-hml.accesstage.com.br/api/apus/v1/auth " 2º - o metodo é POST 3º - na aba "Authorization" selecione "Basic Auth" 4º - Preencha os dados de Usuario e Senha que lhe foi informado pela equipe Accesstage. 5º - faça a chamada. Receberá um token valido por um tempo pré-definido conforme exemplo abaixo.
  • [Inicio](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/inicio.md): 1. Usuario e Senha da API: Antes de começar a utilizar a API, é necessário ter em mãos um Usuario (clientID) e uma Senha (clientSecret). Essas dados serão enviados por nossa equipe de implementação. 2. Como se Autenticar na API: Com o Usuario e Senha em mãos, é possível acionar o endpoint "{{baseUrlProd}}/api/apus/v1/auth" e obter um token de acesso. Esse token deve ser utilizado em todas as chamadas da API, ele garantirá sua segurança e autenticidade. 3. Identificar o parceiro de negócio: É necessário identificar o parceiro de negócio com o qual deseja realizar a troca de informações. Utilize o endpoint Partnership para recuperar as informações do parceiro. 4. Fazer um Pagamento ou Cobrança Utilize o endpoint Upload File para enviar o CNAB contendo pagamentos ou utilize o endpoint Upload para digitar as informações do pagamento. 5. Verificar mensagens disponíveis: Utilize o endpoint Available Files para verificar se alguma mensagem de retorno está disponivel para consulta. Considerações Finais: Nesta documentação, você encontrou um passo a passo detalhado para utilizar a API Fenix com eficiência e segurança. Certifique-se de seguir corretamente cada etapa e utilizar as credenciais de autenticação (clientID e ClientSecret) fornecidas pela Accesstage. Mantenha o token de acesso gerado durante a autenticação para realizar as chamadas às APIs subsequentes. Utilize os endpoints adequados e forneça os parâmetros corretos para garantir o funcionamento correto da API e a segurança das suas transações. Fique tranquilo! Ao recebermos seu arquivo CNAB iremos processa-lo de forma segura e confiável entregando ao destino final.
  • [API de Tráfego](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-de-trafego.md): Nossa API de Arquivos foi projetada para simplificar e aprimorar as integrações financeiras, facilitando o envio e recebimento de arquivos entre parceiros, proporcionando maior eficiência e precisão nas transações. É possivel automatizar processos, reduzir erros e otimizar sua operação financeira mantendo a segurança e rapidez. - Empresa faz a requisição na API anexando seu arquivo CNAB que é enviado para nossa plataforma; (Enviar CNAB) - A API recebe o arquivo e encaminha para nossa plataforma; - O arquivo é enviado para o Banco/Parceiro (Itaú, Bradesco, Santander, Empresa Parceira, etc...) - O Banco/Parceiro processa o arquivo enviado e devolve um arquivo retorno, informando o status do processamento; - A Informação é recebida pela Accesstage, que disponibiliza o arquivo retorno para consulta da empresa; (Retornos Disponiveis) - Empresa recebe o arquivo. (Receber CNAB)
    • [Enviar CNAB](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-de-trafego/enviar-cnab.md): Descrição do funcionamento do Endpoint Este endpoint tem como objetivo enviar um arquivo CNAB ( ou qualquer formato) em anexo à chamada. Passo a Passo 1º - copie o link " https://apus-hml.accesstage.com.br/api/apus/v1/:pdsid/upload " 2º - o metodo é POST 3º - na aba "Authorization" selecione "Bearer Token" 4º - Preencha o Token que você recebeu na chamada de Autenticação. 5º - na aba "Params" crie a variavel "pdsid" que a Accesstage te passou. ( este campo é responsável pela identificação de onde seu arquivo irá ser direcionado ) 6º - na aba "Body" selecione "form-data" e preencha os seguintes parametros: "hash - type text", "file - type text" "hash" é literalmente o valor em hash(sha256) e lowcase do arquivo que irá ser enviado. Você pode fazer sua conversão no link “ https://hash.online-convert.com/sha256-generator ”
    • [Receber CNAB](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-de-trafego/receber-cnab.md): A API de download de arquivos disponibilizados pelos parceiros de negócio é uma solução eficiente e segura para facilitar o acesso às informações essenciais compartilhadas entre empresas. Essa API permite que os usuários obtenham de forma rápida e organizada os arquivos fornecidos pelos parceiros, promovendo uma colaboração fluida e eficaz. Com opções de download personalizáveis, os usuários podem selecionar os arquivos desejados e recebê-los diretamente em seus sistemas. Request URL URL: /api/apus/v1/download/{tracking} Método: GET Parâmetros: {tracking} (Path) - Identificador único do arquivo a ser baixado. (Obrigatório) Bearer (header, string, obrigatório): Token de acesso (OAuth2).
    • [Retornos Disponiveis](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-de-trafego/retornos-disponiveis.md): A API de download de arquivos disponibilizados pelos parceiros de negócio é uma solução eficiente e segura para facilitar o acesso às informações essenciais compartilhadas entre empresas. Essa API permite que os usuários obtenham de forma rápida e organizada os arquivos fornecidos pelos parceiros, promovendo uma colaboração fluida e eficaz. Com opções de download personalizáveis, os usuários podem selecionar os arquivos desejados e recebê-los diretamente em seus sistemas Request URL: URL: /api/apus/v1/list/files Método: GET Parâmetros Request: from (query, string, obrigatório): Data de início da busca (formato: YYYY-MM-DD). to (query, string, obrigatório): Data de término da busca (formato: YYYY-MM-DD). Bearer (header, string, obrigatório): Token de acesso (OAuth2).
    • [Listar Parceiros](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-de-trafego/listar-parceiros-1.md): [{"type":"p","children":[{"text":"A API irá fornecer uma lista completa dos parceiros de negócio disponíveis para envio de arquivos. Cada parceiro será identificado com informações detalhadas. Essa funcionalidade permitirá aos usuários identificar facilmente os parceiros adequados para o envio de arquivos, tornando o processo de comunicação e colaboração mais eficiente e eficaz"}],"id":1690201566384},{"type":"p","children":[{"text":"URL Request:"}],"id":1690201622741},{"type":"ul","children":[{"type":"li","children":[{"type":"lic","align":"left","children":[{"text":"URL: /api/apus/v1/list/partnership ","fontSize":"11pt"}],"id":1690201674956}],"id":1690201674956},{"type":"li","children":[{"type":"lic","align":"left","children":[{"text":"Método: GET ","fontSize":"11pt"}],"id":1690201674956}],"id":1690201674956}],"id":1690201674955},{"type":"p","align":"left","children":[{"text":"Parâmetros Request: ","fontSize":"11pt"}],"id":1690201674956},{"type":"ul","children":[{"type":"li","children":[{"type":"lic","align":"left","children":[{"text":"Bearer (header, string, obrigatório): Token de acesso (OAuth2). ","fontSize":"11pt"}],"id":1690201674956}],"id":1690201674956}],"id":1690201684223},{"type":"p","align":"left","children":[{"text":"Exemplo de Response (JSON) ","fontSize":"11pt"}],"id":1690201674957},{"type":"requestEditor","children":[{"text":""}],"pointsTo":"requestEditor","id":"ab8764a4-9b9e-4970-b0b7-fdbc706a74f2"},{"type":"p","children":[{"text":""}]},{"type":"p","children":[{"text":""}]},{"type":"responseEditor","children":[{"text":""}],"pointsTo":"responseEditor","id":"b76c9b92-50d4-416f-8a1a-c7fdb3233d18"},{"type":"p","children":[{"text":""}]}]
  • [API Pagamentos](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-pagamentos.md): - Empresa faz a requisição na API Fenix com os Pagamentos que serão enviados para nossa plataforma. - A API Fenix recebe a requisição e encaminha para nossa plataforma. - As informaçoes serão processadas e enviadas ao banco (Itaú, Bradesco, Santander, etc...) - Banco processa o pagamento e devolve uma mensagem de retorno, informando o status do processamento. - A Informação é recebida pela Accesstage que disponibiliza a mensagem para consulta da Empresa. A API Fênix disponibiliza duas formas para fazer seus pagamentos, é possivel escolher qual forma se adapta melhor ao seu negócio. Request na API Fenix com os parametros de um pagamento; Request na API Fenix com um CNAB em anexo contendo um ou mais pagamentos.
    • [Enviar Pagamentos](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-pagamentos/enviar-pagamentos.md): Request na API Fenix com os parametros de um pagamento;
    • [Status Pagamentos](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-pagamentos/status-pagamentos.md): Request na API Fenix com os parametros de um pagamento;
    • [Listar Parceiros](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-pagamentos/listar-parceiros.md): A API irá fornecer uma lista completa dos parceiros de negócio disponíveis para envio de arquivos. Cada parceiro será identificado com informações detalhadas. Essa funcionalidade permitirá aos usuários identificar facilmente os parceiros adequados para o envio de arquivos, tornando o processo de comunicação e colaboração mais eficiente e eficaz URL Request: URL: /api/apus/v1/list/partnership Método: GET Parâmetros Request: Bearer (header, string, obrigatório): Token de acesso (OAuth2). Exemplo de Response (JSON)
  • [API Cobrança](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-cobranca.md): - Empresa faz a requisição na API Fenix com as Cobranças que serão enviadas/registradas para nossa plataforma. - A API Fenix recebe a requisição e encaminha para nossa plataforma. - As informaçoes serão processadas e enviadas ao banco (Itaú, Bradesco, Santander, etc...) - Banco processa/registra a Cobrança e devolve uma mensagem de retorno, informando o status do processamento. - A Informação é recebida pela Accesstage que disponibiliza a mensagem para consulta da Empresa. A API Fênix disponibiliza duas formas para registrar suas cobranças, é possivel escolher qual forma se adapta melhor ao seu negócio. Request na API Fenix com os parametros de uma cobrança; Request na API Fenix com um CNAB em anexo contendo um ou mais cobranças.
    • [Registrar Cobranças](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-cobranca/registrar-cobrancas.md): [{"type":"ol","children":[{"type":"li","children":[{"type":"lic","id":1696274338716,"children":[{"text":"Request na API Fenix com os parametros de uma cobrança;"}]}],"id":1696274449365}],"id":1696275890778},{"type":"p","children":[{"text":""}],"id":1696275890778},{"type":"requestEditor","children":[{"text":""}],"pointsTo":"requestEditor","id":1696275890778},{"type":"p","children":[{"text":""}],"id":1696275890778},{"type":"p","children":[{"text":""}],"id":1696275890779},{"type":"p","children":[{"text":""}],"id":1696275162697},{"type":"p","id":1696275163307,"children":[{"text":""}]},{"type":"p","id":1696275163466,"children":[{"text":""}]}]
    • [Status Cobranças](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-cobranca/status-cobrancas.md): [{"type":"ol","children":[{"type":"li","children":[{"type":"lic","id":1696274338716,"children":[{"text":"Request na API Fenix com os parametros de uma cobrança;"}]}],"id":1696274449365}],"id":1696275890778},{"type":"p","children":[{"text":""}],"id":1696275890778},{"type":"requestEditor","children":[{"text":""}],"pointsTo":"requestEditor","id":1696275890778},{"type":"p","children":[{"text":""}],"id":1696275890778},{"type":"p","children":[{"text":""}],"id":1696275890779},{"type":"p","children":[{"text":""}],"id":1696275162697},{"type":"p","id":1696275163307,"children":[{"text":""}]},{"type":"p","id":1696275163466,"children":[{"text":""}]}]
    • [CNAB](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-cobranca/cnab-1.md): Request na API Fenix com um CNAB em anexo contendo uma ou mais cobranças.
  • [API Extrato](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-extrato.md): [{"type":"p","id":1696273457421,"listStyleType":"","indent":"0","children":[{"text":""}]},{"type":"img","url":"https://theneo-prod-public.s3.amazonaws.com/images-1696447235044.jpg","children":[{"text":""}],"id":1696447245452},{"type":"ol","children":[{"type":"li","children":[{"type":"lic","id":1696273458083,"listStyleType":"","children":[{"text":"- Empresa faz a requisição na API Fenix com as Cobranças que serão enviadas/registradas para nossa plataforma.\r"}]}],"id":1696279331217},{"type":"li","children":[{"type":"lic","id":1696279335258,"listStyleType":"","children":[{"text":"- A API Fenix recebe a requisição e encaminha para nossa plataforma.\r"}]}],"id":1696279335259},{"type":"li","children":[{"type":"lic","id":1696279337108,"listStyleType":"","children":[{"text":"- As informaçoes serão processadas e enviadas ao banco (Itaú, Bradesco, Santander, etc...)\r"}]}],"id":1696279337108},{"type":"li","children":[{"type":"lic","id":1696279338813,"listStyleType":"","children":[{"text":"- Banco processa/registra a Cobrança e devolve uma mensagem de retorno, informando o status do processamento.\r"}]}],"id":1696279338814},{"type":"li","children":[{"type":"lic","id":1696279340183,"listStyleType":"","children":[{"text":"- A Informação é recebida pela Accesstage que disponibiliza a mensagem para consulta da Empresa."}]}],"id":1696279340184}],"id":1696279331216},{"type":"p","id":1696274294924,"children":[{"text":"A API Fênix disponibiliza duas formas para registrar suas cobranças, é possivel escolher qual forma se adapta melhor ao seu negócio. "}]},{"type":"ol","children":[{"type":"li","children":[{"type":"lic","id":1696274338716,"children":[{"text":""},{"type":"a","url":"https://app.theneo.io/accesstage/developer/fenix-api/registrar-cobranca/parametros","children":[{"text":"Request na API Fenix com os parametros de uma cobrança;"}],"id":1696278323444},{"text":""}],"listStyleType":""}],"id":1696274449365},{"type":"li","children":[{"type":"lic","id":1696274868133,"children":[{"text":""},{"type":"a","url":"https://app.theneo.io/accesstage/developer/fenix-api/registrar-cobranca/cnab","children":[{"text":"Request na API Fenix com um CNAB em anexo contendo um ou mais cobranças."}],"id":1696278335002},{"text":""}]}],"id":1696274868134}],"id":1696274449366},{"type":"p","children":[{"text":""}],"id":1696275674638},{"type":"p","children":[{"text":""}],"id":1696275674639},{"type":"p","id":1696275116460,"children":[{"text":""}]}]
  • [Enviar Duplicatas](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/api-risco-sacado/enviar-pagamentos-copy-7.md): Request na API Fenix com os parametros de uma duplicata;
  • [Reenviar Arquivo](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/reenviar-arquivo.md): [{"type":"p","children":[{"text":"Este endpoint permite solicitar o reenvio de arquivos que foram retirados\nanteriormente. Isso agiliza o processo de obtenção de informações\ncríticas, eliminando a burocracia de solicitar novamente os\ndocumentos aos parceiros"}],"id":1690201825118},{"type":"p","align":"left","id":1690201889890,"children":[{"text":"Request URL: ","fontSize":"11pt"}]},{"type":"ul","children":[{"type":"li","children":[{"type":"lic","align":"left","children":[{"text":"URL: /api/apus/v1/resubmit/{tracking} ","fontSize":"11pt"}],"id":1690201934104}],"id":1690201934104},{"type":"li","children":[{"type":"lic","align":"left","children":[{"text":"Método: GET ","fontSize":"11pt"}],"id":1690201934105}],"id":1690201934105}],"id":1690201934104},{"type":"p","align":"left","children":[{"text":"Parâmetros Request: ","fontSize":"11pt"}],"id":1690201934106},{"type":"ul","children":[{"type":"li","children":[{"type":"lic","align":"left","children":[{"text":"{tracking} (path, string, obrigatório): ID de rastreamento do arquivo. ","fontSize":"11pt"}],"id":1690201934108}],"id":1690201934108},{"type":"li","children":[{"type":"lic","align":"left","children":[{"text":"Bearer (header, string, obrigatório): Token de acesso (OAuth2). ","fontSize":"11pt"}],"id":1690201934108}],"id":1690201934108}],"id":1690201934108},{"type":"p","align":"left","children":[{"text":" ","fontSize":"11pt"}],"id":1690201934110},{"type":"requestEditor","children":[{"text":""}],"pointsTo":"requestEditor","id":"e095cb6c-6bd8-4d2b-a92e-f6a0ab17f766"},{"type":"p","children":[{"text":""}]},{"type":"p","children":[{"text":""}]},{"type":"responseEditor","children":[{"text":""}],"pointsTo":"responseEditor","id":"dce4a47d-6798-47ae-a598-181bdd6bbf13"},{"type":"p","children":[{"text":""}]}]
  • [Listar Transações (Remessa/Retorno)](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/listar-arquivos.md): A API fornecerá uma lista detalhada das transações de tráfego referentes aos arquivos transacionados na plataforma. Essa lista incluirá informações como a origem e destino de cada transação, o tamanho dos arquivos transferidos, o horário em que ocorreram as transações e outros dados relevantes. Essa funcionalidade permitirá aos usuários acompanhar de forma precisa e transparente todas as atividades relacionadas à transferência de arquivos na plataforma, facilitando a auditoria e o controle do fluxo de dados. Request URL: URL: /api/apus/v1/ list/transactions Método: GET Parâmetros Request: from (query, string, obrigatório): Data de início da busca (formato: YYYY-MM-DD). to (query, string, obrigatório): Data de término da busca (formato: YYYY-MM-DD). Bearer (header, string, obrigatório): Token de acesso (OAuth2).
  • [Consultar Arquivos](https://developer.accesstage.com.br/developer/api-transferencia-de-dados/consultar-arquivos.md): A API de download de arquivos disponibilizados pelos parceiros de negócio é uma solução eficiente e segura para facilitar o acesso às informações essenciais compartilhadas entre empresas. Essa API permite que os usuários obtenham de forma rápida e organizada os arquivos fornecidos pelos parceiros, promovendo uma colaboração fluida e eficaz. Com opções de download personalizáveis, os usuários podem selecionar os arquivos desejados e recebê-los diretamente em seus sistemas Request URL: URL: /api/apus/v1/list/files Método: GET Parâmetros Request: from (query, string, obrigatório): Data de início da busca (formato: YYYY-MM-DD). to (query, string, obrigatório): Data de término da busca (formato: YYYY-MM-DD). Bearer (header, string, obrigatório): Token de acesso (OAuth2).