# Como criar módulo conector do Asaas Este guia orienta a integração entre o **Skyone Studio** e o sistema financeiro **Asaas**. Ao final desta documentação, você terá configurado um módulo conector pronto para ser utilizado em fluxos de automação de cobranças, pagamentos e assinaturas. ### Introdução do módulo conector Asaas O módulo conector do Asaas permite a sincronização em tempo real de eventos financeiros via Webhooks. Através dele, sua aplicação ganha acesso a recursos como: * Cobranças * Pagamentos * Assinaturas * Notificações por webhook O conector executa internamente as chamadas à API do Asaas, sem necessidade de manipulação direta de endpoints. A API suporta: * PIX * Boleto * Cartão de crédito * Régua de cobrança * Antecipação de recebíveis * Link de pagamento * Cofre de cartão * Gestão de assinaturas * PCI-DSS #### Ambientes | Ambiente | Endpoint | | -------- | ---------------------------------- | | Sandbox | `https://api-sandbox.asaas.com/v3` | | Produção | `https://api.asaas.com/v3` | *** #### Como obter as credenciais no portal Asaas 1. Acesse o painel web do[ Asaas](https://www.asaas.com/) com um perfil de Administrador. {% hint style="warning" %} Apenas administradores podem criar chaves. {% endhint %} 2. No menu lateral, siga para **Integrações** > **Chaves de API**. 3. Clique em **Criar Chave.** 4. Defina um nome descritivo (ex: Skyone\_Sandbox) e selecione o ambiente desejado (Sandbox ou Produção). 5. Clique em **Gerar**. O token será exibido apenas uma vez. Copie e salve-o em um cofre de senhas seguro. * **Sandbox:** token identificado pelo prefixo $aact\_hmlg\_. * **Produção:** token identificado pelo prefixo $aact\_prod\_. Nunca compartilhe suas chaves por e-mail ou as insira diretamente no código-fonte. Utilize sempre variáveis de ambiente ou cofres de segredos. 6. Anote também o **ID da chave** localizado ao lado do token, caso precise referenciá-lo especificamente no módulo conector. 7. Identifique se sua integração exige um cabeçalho User-Agent personalizado. Caso contrário, deixe o campo vazio para que o **Skyone Studio** o gere automaticamente. *** ### Configuração no Skyone Studio 1. No **Skyone Studio**, [crie um módulo](https://docs.skyone.cloud/skyone-studio/modulos/gestao-de-modulos/criacao-de-modulos) chamado Asaas. 2. No módulo do Asaas, na área de Configurações, escolha as seguintes opções: * **Conectividade:** * **Tipo de Autenticação:** * **Conta conectada:** clique em **Adicionar conta conectada** 3. Preencha os campos conforme abaixo: * **Nome da Conta:** Asaas | Campo | Valor para Sandbox (testes) | Valor para Produção | | :-----------------: | :------------------------------------------------------------------------------: | :--------------------------------------------------------------: | | Endpoint (Base URL) | [https://api-sandbox.asaas.com/v3]() | [https://api.asaas.com/v3]() | | Access Token | Insira sua chave $aact\_hmlg\_ | Insira sua chave $aact\_prod\_ | | User-Agent | O nome da sua aplicação | Deixe vazio (o Skyone Studio gera automaticamente) | 4. Salve as alterações e selecione a conta criada no campo **Conta conectada**. *** ## ENTIDADES Abaixo listamos as entidades (temas e suas respectivas operações) mapeadas neste conector. ### Cobranças A entidade Cobranças permite gerenciar o ciclo de vida completo de pagamentos no **Skyone Studio**. Com ela, você automatiza a emissão de faturas (Boleto, Pix e Cartão), aplica juros, multas e executa o *split* de valores entre carteiras. A ferramenta possibilita monitorar o status de pagamentos em tempo real e realizar consultas avançadas com paginação e filtros de auditoria. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta: #### Operações
Criar nova cobrança Registra definitivamente uma fatura no Asaas, vinculando cliente, valor e método de pagamento para automatizar o faturamento e a gestão de recebíveis no seu fluxo de integração. \ **Método:** POST **Endpoint:** `/v3/payments` **Parâmetros:**
ParâmetroTipoObrigatórioObservação
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar cobrança O componente Listar cobranças realiza requisições `GET` para recuperar listas paginadas de pagamentos, permitindo aplicar filtros por cliente, data ou status. No **Skyone Studio**, ele é essencial para fluxos de reconciliação bancária e monitoramento de inadimplência. Ao consumir esses dados, a integração pode automatizar relatórios, atualizar bancos de dados internos e sincronizar o cenário financeiro em tempo real. \ **Método:** GET **Endpoint:** `/v3/payments` **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
installmentstringNãoinstallment_123Filtrar pelo ID único do parcelamento.
offsetstringNão0Índice do primeiro item a ser retornado (usado para paginação). Padrão: 0.
limitstringNão10Quantidade máxima de itens por página. Padrão: 10 (Máximo: 100).
customerstringNãocus_123456Filtrar pelo ID único do cliente.
customerGroupNamestringNãoGrupo VIPFiltrar pelo nome do grupo de clientes.
billingTypestringNãoBOLETOFiltrar pelo tipo de cobrança (ex: BOLETO, CREDIT_CARD, PIX).
statusstringNãoPENDINGFiltrar pelo status da cobrança (ex: PENDING, PAID, OVERDUE).
subscriptionstringNãosub_123Filtrar pelo ID único da assinatura relacionada.
externalReferencestringNãopedido_999Filtrar pelo identificador externo do seu próprio sistema.
paymentDatestringNão2024-01-01Filtrar pela data exata do pagamento (AAAA-MM-DD).
invoiceStatusstringNãoSCHEDULEDFiltrar pelo status da Nota Fiscal (ex: SCHEDULED, SENT).
estimatedCreditDatestringNão2024-01-05Filtrar pela data estimada para o crédito cair na conta.
pixQrCodeIdstringNãoqr_abc123Filtrar pelo ID de um QR Code estático Pix.
anticipatedstringNãofalseFiltrar se o pagamento foi antecipado (true ou false).
anticipablestringNãotrueFiltrar se o pagamento está disponível para antecipação (true ou false).
dateCreated[ge]stringNão2024-01-01Data de criação: igual ou posterior a esta data (Início do período).
dateCreated[le]stringNão2024-01-31Data de criação: igual ou anterior a esta data (Fim do período).
paymentDate[ge]stringNão2024-01-01Data do pagamento: igual ou posterior a esta data (Início do período).
paymentDate[le]stringNão2024-01-31Data do pagamento: igual ou anterior a esta data (Fim do período).
estimatedCreditDate[ge]stringNão2024-01-01Data estimada de crédito: igual ou posterior a esta data.
estimatedCreditDate[le]stringNão2024-01-31Data estimada de crédito: igual ou anterior a esta data.
dueDate[ge]stringNão2024-01-01Data de vencimento: igual ou posterior a esta data.
dueDate[le]stringNão2024-01-31Data de vencimento: igual ou anterior a esta data.
userstringNãousuario@exemplo.comFiltrar pelo e-mail do usuário que criou a cobrança.
Criar cobrança com cartão de crédito O componente Criar cobrança com cartão de crédito realiza uma requisição `POST` para registrar faturas e processar pagamentos no Asaas. Ele envia dados do cliente, valor e informações do cartão, retornando o status da autorização em tempo real. Integrado ao fluxo após a coleta de dados, o componente permite a captura ou pré-autorização imediata da transação, garantindo agilidade na confirmação da venda. \ **Método:** POST **Endpoint:** `/v3/payments` **Parâmetros:**
ParâmetroTipoObrigatórioObservação
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica."
Capturar cobrança pré-autorização Esta operação finaliza pagamentos via cartão previamente autorizados. No fluxo do **Skyone Studio**, este componente utiliza o ID da transação para efetivar o débito junto ao Asaas assim que o status atinge `AUTHORIZED`. É ideal para processos onde o faturamento ocorre apenas após a validação do pedido ou disponibilidade do produto, garantindo que o valor seja transferido para a conta da empresa de forma automatizada e segura.\ **Método:** POST **Endpoint:** /v3/payments/{id}/captureAuthorizedPayment **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
idstringsimexample

Identificador único da cobrança a ser

capturada, usado para localizar a

transação no Asaas.

Pagar uma cobrança com cartão de crédito O componente automatiza a liquidação de faturas enviando os dados do cartão (ou token) para uma cobrança já existente. No **Skyone Studio**, basta arrastar o componente para o fluxo e configurar o ID da transação para efetivar o pagamento junto ao provedor. Essa etapa finaliza o ciclo de faturamento, integrando a autorização e a baixa do título em uma única operação automatizada. \ **Método:** POST **Endpoint:** /v3/payments/{id}/payWithCreditCard **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
idstringsimexample

Identificador único da cobrança a ser

capturada, usado para localizar a

transação no Asaas.

Recuperar informações de pagamento de uma cobrança Realiza uma requisição `GET` para obter os detalhes completos de um pagamento registrado no Asaas, como dados do pagador e instruções de cobrança. Ao configurar o ID da transação no **Skyone Studio**, o fluxo disponibiliza essas informações para etapas subsequentes, como envios de confirmação ou atualizações de banco de dados. Essa operação é fundamental para auditar registros e garantir a integridade dos dados antes de prosseguir com o faturamento. \ **Método:** GET **Endpoint:** /v3/payments/{id}/billingInfo **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexampleObtém as informações de pagamento associadas à cobrança identificada por esse ID.
Informações sobre visualização de cobrança A operação consulta o histórico de visualizações de uma cobrança específica no Asaas. Quando você arrasta ou configura esse componente no **Skyone Studio**, o sistema executa uma chamada GET ao endpoint do Asaas utilizando o ID da cobrança. O API retorna as datas em que o cliente abriu o boleto e/ou a fatura, fornecendo informações sobre quando o cliente visualizou a cobrança. Essa informação pode ser usada para disparar lembretes, avaliar o engajamento ou registrar no histórico interno, sendo uma etapa de leitura que alimenta as próximas ações do fluxo de integração. **Método:** GET **Endpoint:** /v3/payments/{id}/viewingInfo **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexample

Usado para indicar a cobrança

específica cujo histórico de visualização (boleto e fatura) será

retornado.

Recuperar uma única cobrança Realiza uma requisição `GET` para obter os detalhes completos de um pagamento registrado no Asaas, como dados do pagador e instruções de cobrança. Ao configurar o ID da transação no **Skyone Studio**, o fluxo disponibiliza essas informações para etapas subsequentes, como envios de confirmação ou atualizações de banco de dados. Essa operação é fundamental para auditar registros e garantir a integridade dos dados antes de prosseguir com o faturamento. \ **Método:** GET **Endpoint:** /v3/payments/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexample

Especifica o identificador único da

cobrança a ser recuperada.

Atualizar cobrança existente Permite modificar faturas pendentes ou vencidas no Asaas via requisição para a API. No Skyone Studio, ele é utilizado para ajustar valores, datas de vencimento, encargos (juros e multas) e regras de *split* de receita. Integrado ao fluxo após a criação ou consulta da cobrança, o componente garante flexibilidade para corrigir dados ou realocar valores antes da liquidação final do faturamento. **Método:** PUT **Endpoint:** /v3/payments/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexample

Identificador único da cobrança que

será atualizada.

bodystringsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Excluir cobrança A operação exclui da conta Asaas um registro de cobrança já existente. Ela recebe o identificador único da cobrança e, ao ser acionada, faz o pedido de remoção no sistema externo, garantindo que o lançamento não apareça mais nos relatórios e nos saldos. No fluxo de integração, o usuário pode arrastar essa ação depois de uma etapa que obtenha ou gere o ID da cobrança – por exemplo, após criar ou pesquisar uma cobrança – e, caso o negócio exija cancelar ou remover informações duplicadas, a exclusão ocorre de forma automática, permitindo que o próximo passo continue sem o registro excluído.\ **Método:** DELETE **Endpoint:** /v3/payments/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexampleEspecifica o identificador único da cobrança a ser excluída.
Restaurar cobrança removida Ao usar este componente no **Skyone Studio**, o fluxo faz uma chamada POST para o endpoint */v3/payments/{id}/restore*, enviando o identificador da cobrança que havia sido removida. O serviço externo reativa essa cobrança, devolvendo um registro confirmado. Isso permite que usuários corrijam remoções acidentais ou reativem pagamentos suspensos dentro de um pipeline de automatização, mantendo a consistência dos dados de faturamento. **Método:** POST **Endpoint:** /v3/payments/{id}/restore **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexampleObtém as informações de pagamento associadas à cobrança identificada por esse ID.
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar status de uma cobrança Executa uma consulta pontual ao Asaas para verificar o estágio atual de um pagamento (como Pendente, Aprovado ou Cancelado). No **Skyone Studio**, essa etapa elimina a necessidade de verificações manuais contínuas, permitindo que o fluxo tome decisões automáticas — como disparar notificações ou liberar pedidos — com base na resposta em tempo real. É uma ferramenta essencial para o controle de fluxo e governança financeira dentro da integração. \ **Método:** GET **Endpoint:** /v3/payments/{id}/status **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexample

Identificador único da cobrança no

Asaas, usado para recuperar o status

da cobrança.

Estornar cobrança Ao usar o componente Estornar cobrança no **Skyone Studio**, você envia uma solicitação ao Asaas para reverter um pagamento já registrado. O sistema remove o valor da conta da empresa, devolve o dinheiro ao cliente e cancela a cobrança no cartão ou na fatura. No fluxo de integração, o usuário posiciona este bloco após a etapa de confirmação de pagamento, fornece o identificador da cobrança e opcionalmente detalhes de valor e motivo. Assim, o processo automatiza o estorno dentro do fluxo de pagamentos, garantindo que as transações sejam revertidas rapidamente e de forma transparente. \ **Método:** POST **Endpoint:** /v3/payments/{id}/refund **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexample

Identificador único da cobrança a ser

estornada; obrigatório na URL.

bodystringsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Obter linha digitável do boleto O componente “Obter linha digitável do boleto” permite que o seu fluxo no **Skyone Studio** busque, a partir do identificador da cobrança no Asaas, a sequência numérica que representa o código de barras do boleto. Essa linha digitável pode ser usada para exibir ao cliente a forma de pagamento via Internet Banking, facilitando o pagamento direto pelo banco. Ao arrastar e configurar esse bloco em seu fluxo, você garante que, sempre que a cobrança for atualizada, a linha correta seja recuperada e exibida, mantendo o processo de cobrança alinhado ao estado atual no sistema externo.\ **Método:** GET **Endpoint:** /v3/payments/{id}/identicationField **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexample

Identificador único da cobrança no

Asaas usado para recuperar a linha

digitável do boleto.

Obter QR Code para pagamentos via Pix O componente *Obter QR Code para pagamentos via Pix* recupera os dados para pagamento instantâneo de uma cobrança específica. Ao informar o ID da transação, o **Skyone Studio** extrai da API do Asaas o QR Code em Base64, a linha digitável (copia e cola) e a data de expiração. No fluxo de integração, essa ação permite embutir o código de pagamento em e-mails, PDFs ou comprovantes logo após a criação da fatura, automatizando a entrega dos dados de checkout ao cliente. \ **Método:** GET **Endpoint:** /v3/payments/{id}/pixQrCode **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexample

Indica a identificação única da

cobrança no Asaas para a qual o QR

Code será gerado.

Confirmar recebimento em dinheiro O componente *Confirmar recebimento em dinheiro* registra a quitação manual de uma cobrança no Asaas. No **Skyone Studio**, o usuário configura o ID da fatura e os detalhes do pagamento (data e valor) para que o sistema atualize o status financeiro e, opcionalmente, notifique o cliente. Esta etapa é fundamental para encerrar o ciclo de faturamento de cobranças pagas em espécie, garantindo a conciliação entre o recebimento físico e o registro digital na plataforma. \ **Método:** POST **Endpoint:** /v3/payments/{id}/receiveInCash **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexample

Identificador único da cobrança na

qual o pagamento em dinheiro será

registrado.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Desfazer confirmação de recebimento em dinheiro Realiza uma requisição `GET` para obter os detalhes completos de um pagamento registrado no Asaas, como dados do pagador e instruções de cobrança. Ao configurar o ID da transação no **Skyone Studio**, o fluxo disponibiliza essas informações para etapas subsequentes, como envios de confirmação ou atualizações de banco de dados. Essa operação é fundamental para auditar registros e garantir a integridade dos dados antes de prosseguir com o faturamento. \ **Método:** POST **Endpoint:** /v3/payments/{id}/undoReceiveInCash **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexample

Identificador único da cobrança no

Asaas, usado para especificar qual

pagamento terá a confirmação de

recebimento em dinheiro revertida.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Simulador de vendas O componente *Simulador* de vendas permite calcular os valores líquidos e as taxas de parcelamento antes de efetivar uma transação no Asaas. Ao enviar os dados do pedido via **Skyone Studio**, a API retorna o detalhamento de custos para cada modalidade (cartão, boleto ou Pix), permitindo que o fluxo valide a viabilidade financeira da operação. Integrado antes da criação da cobrança, o simulador garante que o sistema tome decisões automáticas — como escolher o melhor método de pagamento ou ajustar juros — com base nos custos reais informados pelo provedor.\ **Método:** POST **Endpoint:** /v3/payments/{id}/simulate **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperando limites de cobranças Esta operação permite que o **Skyone Studio** consulte os limites máximos de cobrança e pagamento que podem ser feitos por meio da API do Asaas. Ao arrastar e configurar esse componente no Studio, ele envia uma requisição GET para o endpoint “*/v3/payments/limits”*, recuperando as informações de limite de forma simples e direta. O retorno fornece os valores máximos permitidos por transação ou por período, o que auxilia no planejamento financeiro e evita que pagamentos programados ultrapassem os limites configurados pela plataforma. Assim, serve como controle de risco e garante que as operações ocorram dentro das políticas da conta de cobrança.\ **Método:** GET **Endpoint:** `/v3/payments/limits`
Recuperar garantia da cobrança na Conta Escrow Consulta os detalhes de proteção financeira associados a pagamentos em Conta Escrow no Asaas. No **Skyone Studio**, ao informar o ID da transação, o fluxo recupera dados críticos, como o montante coberto e o status da proteção, permitindo validar se o pagamento está garantido antes de sua liberação. Esta operação é ideal para etapas de aprovação e gestão de risco, fornecendo a base necessária para decisões automáticas de faturamento ou notificações de segurança ao cliente.\ **Método:** GET **Endpoint:** /v3/payments/{id}/escrow **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
idstringsimexample

Identifica a cobrança específica cujo

escopo de garantia escrow será

recuperado.

*** ### Cobranças com dados resumidos A entidade Cobranças (Payments) centraliza a gestão financeira no **Skyone Studio**, permitindo a automação completa do faturamento. Com ela, você emite cobranças via boleto, cartão ou Pix, configurando regras de parcelamento, juros e descontos diretamente no fluxo. A estrutura suporta desde a captura de pagamentos pré-autorizados e atualizações de dados até a listagem filtrada para reconciliação bancária. Essa flexibilidade garante controle total sobre o ciclo de vida dos recebíveis, integrando a emissão, o monitoramento de status e a auditoria em processos eficientes e escaláveis. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Criar nova cobrança com dados resumidos na resposta O componente *Criar nova cobrança com dados resumidos* automatiza a geração de faturas no Asaas, otimizando o tráfego de dados ao retornar apenas as informações essenciais da transação. No **Skyone Studio**, ele envia os dados do cliente e do pagamento (valor, vencimento e método) e disponibiliza um resumo imediato para as próximas etapas. Essa resposta simplificada é ideal para fluxos de alta performance que precisam registrar o ID da cobrança em sistemas internos ou disparar alertas sem processar payloads extensos. \ **Método:** POST **Endpoint:** /v3/lean/payments **Parâmetros:**
ParâmetroTipoObrigatórioExemploObservação
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar cobranças com dados resumidos Consulta no sistema externo as faturas pendentes, retornando informações básicas de cada cobrança. Ela pode ser configurada no Skyone Studio como um bloco de ação que o usuário arrasta e conecta a outros passos. Ao ser executado, o componente faz uma requisição GET ao endpoint de pagamentos, enviando parâmetros opcionais para refinar a busca – por cliente, grupo, tipo de pagamento, status, datas de criação, pagamento ou vencimento, entre outros. O resultado disponibiliza uma lista paginada (offset/limit) de registros, que pode ser filtrada, ordenada ou analisada em etapas subsequentes do fluxo de integração. Assim, ele integra dados de cobrança ao seu aplicativo, permitindo monitorar, exportar ou disparar processos baseados na situação das faturas.\ **Método:** GET **Endpoint:** /v3/lean/payments **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
offsetstringNão0

Define a partir de qual item da

lista de cobranças a consulta

deve começar.

limitstringNão10

Define o número máximo de

registros a serem retornados na

lista, limitado a 100 itens.

customerstringNãoexample

Filtra a listagem por cliente

usando seu identificador único.

customerGroupNamestringNãoexampleFiltrar pelo nome do grupo de clientes.
billingTypestringNãoUndefined

Filtra os resultados da listagem

de cobranças pelo tipo de

pagamento (ex.: BOLETO,

CARTÃO, PIX).

statusstringNãoPENDING

Filtra as cobranças de acordo

com seu status, permitindo

buscar somente registros com o

status especificado (ex.:

PENDING, PAID, CANCELLED).

subscriptionstringNãoexample

Filtra pagamentos usando o

identificador único da

assinatura.

installmentstringNãoexample

Filtra cobranças pertencentes a

um parcelamento específico

usando seu identificador único.

externalReferencestringNãoexample

iltra cobranças usando a

referência externa atribuída

pelo seu sistema.

paymentDatestringNãoexample

Filtra cobranças pelo valor da

data de pagamento.

invoiceStatusstringNãoSCHEDULED

Filtra cobranças de acordo com

a presença ou ausência de nota

fiscal.

estimatedCreditDatestringNãoexample

Filtra os pagamentos por data

estimada de crédito.

pixQrCodeIdstringNãoexample

Filtra cobranças geradas por

QRCode estático, usando o

identificador

anticipatedstringNãoexampleFiltrar se o pagamento foi antecipado (true ou false).
anticipablestringNãoexampleFiltrar se o pagamento está disponível para antecipação (true ou false).
dateCreated[ge]stringNão2024-01-01Data de criação: igual ou posterior a esta data (Início do período).
dateCreated[le]stringNão2024-01-31Data de criação: igual ou anterior a esta data (Fim do período).
paymentDate[ge]stringNão2024-01-01Data do pagamento: igual ou posterior a esta data (Início do período).
paymentDate[le]stringNão2024-01-31Data do pagamento: igual ou anterior a esta data (Fim do período).
estimatedCreditDate[ge]stringNão2024-01-01Data estimada de crédito: igual ou posterior a esta data.
estimatedCreditDate[le]stringNão2024-01-31Data estimada de crédito: igual ou anterior a esta data.
dueDate[ge]stringNão2024-01-01Data de vencimento: igual ou posterior a esta data.
dueDate[le]stringNão2024-01-31Data de vencimento: igual ou anterior a esta data.
userstringNãousuario@exemplo.comFiltrar pelo e-mail do usuário que criou a cobrança.
Criar cobrança com cartão de crédito com dados resumidos na resposta Criar uma cobrança usando cartão de crédito e receber um retorno resumido sobre a operação. Ao executá‑lo, o **Skyone Studio** envia os dados do cartão e do cliente ao provedor externo, que processa o pagamento, gera as informações essenciais (como status, id da transação e valor final) e devolve um objeto simplificado. Isso facilita inserir a cobrança em um fluxo de checkout, atualizar o status do pedido ou enviar notificações ao cliente, mantendo a sequência de integração limpa e focada no resultado principal.antir a integridade dos dados antes de prosseguir com o faturamento. \ **Método:** POST **Endpoint:** /v3/lean/payments/ **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Capturar cobrança com pré-autorização com dados resumidos na resposta Ao usar esta operação em um módulo o **Skyone Studio**, o fluxo executará uma captura de cobrança pré‑autorizada. No sistema externo, o serviço confirma a cobrança que já tinha sido autorizada e a finaliza, convertendo o saldo reservado em débito efetivo. O API retorna um resumo dos dados da transação, permitindo que o fluxo continue com confirmação ou geração de notas. Assim, a ação conclui a etapa de faturamento já que o pagamento estava aguardando captura, integrando este passo ao fim de processos de pagamento, pós‑autorização no seu fluxo de negócios.\ **Método:** POST **Endpoint:** /v3/lean/payments/{id}/captureAuthorizedPayment **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

id – Identifica a cobrança que será

capturada

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar uma única cobrança com dados resumidos Essa ação recupera o resumo de uma cobrança específica do Asaas. No fluxo do **Skyone Studio**, a operação deve ser utilizada no ponto onde precisa obter informações de uma fatura já cadastrada, passando o identificador da cobrança proveniente de etapa anterior. O serviço consulta o Asaas, devolve os dados abreviados da cobrança — como número, valor, status e data — e os disponibiliza para as próximas etapas do processo, como exibição ao usuário ou avaliação de condições de pagamento.\ **Método:** GET **Endpoint:** /v3/lean/payments/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Usado para indicar o identificador

único da cobrança que será

recuperada pelo serviço.

Atualizar cobrança existente com dados resumidos na resposta Esta operação atualiza uma cobrança já existente no Asaas e devolve somente um resumo dos dados atualizados. No **Skyone Studio** o usuário simplesmente arrasta o bloco “*Atualizar cobrança existente*” para a sua sequência de ações, conecta‑o ao resultado de um passo anterior (por ex., consulta de cobrança) e define os parâmetros de entrada. Quando a execução chega nesse bloco, o Studio envia uma requisição PUT ao Asaas, substituindo as informações da cobrança indicada pelo ID e retornando apenas os campos resumidos que o fluxo precisa continuar processando. Isso permite manter registros de cobrança sempre atualizados dentro de um fluxo de integração automatizado.\ **Método:** PUT **Endpoint:** /v3/lean/payments/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Especifica a cobrança específica a ser

atualizada.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Excluir cobrança com dados resumidos Permite que o usuário remova de forma definitiva uma cobrança já cadastrada no sistema externo, identificada por seu ID. Ele envia uma solicitação de exclusão ao serviço, fazendo com que o registro deixe de existir no repositório de pagamentos. No fluxo de integração, é útil quando se precisa descompactar transações duplicadas, corrigir erros de faturamento ou limpar cobranças que não foram pagas e que já foram confirmadas como canceladas. Ao utilizar esta operação em um fluxo no **Skyone Studio**, ela conecta a variável que contém o ID da cobrança que deseja remover e o componente executa a operação no sistema externo, encerrando a transação no ponto de pagamento.\ **Método:** DELETE **Endpoint:** /v3/lean/payments/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica a cobrança que será

excluída pelo sistema.

Restaurar cobrança removida com dados resumidos na resposta Retoma uma cobrança previamente excluída no sistema externo. Quando acionada, o componente envia a identificação da cobrança e um corpo de configuração ao endpoint que efetua o retorno do registro ao seu estado original. O serviço devolve apenas os principais dados resumidos da cobrança, facilitando a verificação rápida do status restaurado. Essa ação costuma ser usada em fluxos de reconciliação de pagamentos, onde as transações canceladas precisam ser recuperadas sem reprocessar o pagamento, ou em cenários de teste de integração que demandam a reversão de operações anteriores. No **Skyone Studio**, o módulo Asaas com a operação “Restaurar cobrança removida” no fluxo de automação conecta o identificador da cobrança proveniente de um passo anterior e opcionalmente configura parâmetros adicionais. Assim, a integração restaura a cobrança de forma automática, mantendo o processo de negócio em continuidade e permitindo que o próximo passo opere com dados atualizados.\ **Método:** POST **Endpoint:** /v3/lean/payments/{id}/restore **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único da cobrança que

será restaurada.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Estornar cobrança com dados resumidos na resposta Cria uma ação que reversa uma cobrança previamente emitida no sistema externo. Quando acionada, o componente envia uma requisição para estornar o valor da cobrança, podendo indicar um valor parcial, fornecer uma descrição do motivo e, opcionalmente, dividir o estorno entre partes da transação. Em retorno, o serviço devolve um resumo da transação estornada, o que permite que o fluxo de integração continue com dados atualizados do status do pagamento.\ **Método:** POST **Endpoint:** /v3/lean/payments/{id}/refund **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único da cobrança que

será estornada.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Confirmar recebimento em dinheiro com dados resumidos na resposta Esta ação confirma que uma cobrança foi paga em dinheiro no Asaas, marcando o pagamento como concluído. Ao executá‑la, o Asaas atualiza o status da cobrança com a data, valor e opções de notificação ao cliente, retornando um resumo com as informações mais relevantes. No Skyone Studio, o usuário arrasta e configura este componente para inserir o ID da cobrança e os dados de pagamento. Depois de disparado, ele serve para registrar pagamentos recebidos manualmente, automatizando a atualização do sistema externo dentro de um fluxo de integração que envolve coleta de pagamentos e notificação ao cliente.\ **Método:** POST **Endpoint:** /v3/lean/payments/{id}/receiveInCash **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica a cobrança na plataforma

Asaas que será marcada como

recebida em dinheiro.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Desfazer confirmação de recebimento em dinheiro com dados resumidos na resposta Permite reverter a confirmação de que um pagamento foi recebido em dinheiro. Isso é utilizado quando a empresa percebe que o dinheiro não chegou à conta ou houve erro na anotação de recebimento e precisa invalidar o status “recebido” do pagamento. O componente envia no Asaas um pedido que reatribui o pagamento ao estado pendente, permitindo que o pagamento seja reprocessado ou recolhido novamente. Assim, ele serve para corrigir registros de recebimento e garantir que o status do pagamento reflita a situação real do recurso.\ **Método:** POST **Endpoint:** /v3/lean/payments/{id}/undoReceivedInCash **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

dentificador único da cobrança no

Asaas, obrigatório para indicar qual

pagamento será desfeito

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### Cartão de crédito A entidade de Cartão de Crédito habilita, dentro dos fluxos de integração do **Skyone Studio**, a captura, validação e cobrança de recursos financeiros de maneira segura e automatizada. Por meio de tokenização, o sistema converte atributos sensíveis de um cartão em um token único, garantindo que esses dados sejam armazenados apenas por cliente e nunca enviados novamente em transações. Após a geração do token, todas as cobranças – eventuais pagamentos únicos, parcelamentos, pré‑autenticações e inscrições recorrentes – podem ser realizadas usando apenas esse identificador, simplificando a interação e reduzindo a exposição de dados. O fluxo cobre também a geração de faturas, o controle de ciclos de cobrança, a aplicação de descontos, juros e multas, além de permitir a configuração de splits e callbacks para pós‑pagamento. Em suma, a entidade de Cartão de Crédito oferece um conjunto completo de funcionalidades que asseguram pagamentos recorrentes e instantâneos, com segurança e conformidade na gestão fiscal e cartária. A seguir, conheça a operação disponível. Para mais detalhes, clique na seta:
Tokenização de cartão de crédito Retoma uma cobrança previamente excluída no sistema externo. Quando acionada, o componente envia a identificação da cobrança e um corpo de configuração ao endpoint que efetua o retorno do registro ao seu estado original. O serviço devolve apenas os principais dados resumidos da cobrança, facilitando a verificação rápida do status restaurado. Essa ação costuma ser usada em fluxos de reconciliação de pagamentos, onde as transações canceladas precisam ser recuperadas sem reprocessar o pagamento, ou em cenários de teste de integração que demandam a reversão de operações anteriores. No **Skyone Studio**, o módulo Asaas com a operação “Restaurar cobrança removida” no fluxo de automação conecta o identificador da cobrança proveniente de um passo anterior e opcionalmente configura parâmetros adicionais. Assim, a integração restaura a cobrança de forma automática, mantendo o processo de negócio em continuidade e permitindo que o próximo passo opere com dados atualizados.\ **Método:** POST **Endpoint:** /v3/creditCard/tokenizeCreditCard **Parâmetro:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### Estorno A entidade Cobranças do **Skyone Studio** representa todo o ciclo de pagamentos que sua organização realiza, seja recebendo valores por cartão de crédito, Pix, boleto bancário ou outros meios de pagamento. Essa entidade possibilita o monitoramento e o controle dos valores em transação, a verificação de status de pagamento (recebido, confirmado, pendente) e a gestão de informações de cobrança que são essenciais para a contabilidade, reconciliação bancária e compliance financeiro. Por meio da Cobranças, os usuários do Skyone Studio podem automatizar processos de faturamento e, quando necessário, efetuar estornos em diversas modalidades de pagamento, garantindo que eventuais devoluções de valores sejam registradas de forma transparente e em conformidade com a legislação. A entidade de Cobranças oferece flexibilidade para atender a necessidades de negócios que exigem reembolsos detalhados, como devoluções parciais, estornos completos ou a emissão de relatórios de cobrança para auditoria interna. De modo que os fluxos de integração podem avançar, corrigir ou ajustar valores de forma ágil, mantendo a integridade de todos os registros de transações. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Listar estornos de uma cobrança Envia uma solicitação ao sistema externo para recuperar todas as notas de estorno relacionadas a uma cobrança específica. Ele permite que seu fluxo de integração obtenha o histórico completo de devoluções, facilitando a validação de pagamentos, a reconciliação de documentos ou a atualização de registros internos. No **Skyone Studio**, o usuário configura esse passo no fluxo, conectando‑o a etapas anteriores como a busca de uma cobrança ou a geração de relatórios. Isso garante que os processos de faturamento ou auditoria tenham acesso imediato às informações de estorno necessárias, sem a necessidade de codificar chamadas HTTP manualmente.\ **Método:** GET **Endpoint:** /v3/payments/{id}/refund **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica a cobrança da qual os

estornos devem ser listados.

Estornar boleto Permite que o usuário do **Skyone Studio** solicite o cancelamento de um pagamento de boleto bancário já gerado no Asaas. Ao ativar essa ação, o sistema envia uma requisição ao Asaas para iniciar o estorno. O Asaas, por sua vez, devolve um link que o cliente deve usar para preencher detalhes bancários e enviar documentos que comprovem a titularidade da conta, completando o processo de estorno. Este passo normalmente se insere em fluxos de cobrança quando, por exemplo, um pagamento não atinge a data de vencimento ou o cliente solicita a devolução do valor. Assim, a ação ajuda a automatizar a solicitação de estorno e a garantir que o cliente final tenha que validar as informações bancárias, facilitando a conformidade e a precisão do processo de reembolso.\ **Método:** POST **Endpoint:** /v3/payments/{id}/bankSlip/refund **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador da cobrança que será

estornada.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### Splits A entidade “Splits de Pagamento” representa a granularização dos valores que são distribuídos entre diferentes participantes de uma transação no sistema. Em fluxos de integração do **Skyone Studio**, os splits permitem que uma única cobrança seja dividida entre vários beneficiários, podendo ser classificados como pagos (já liberados para o beneficiário) ou recebidos (após confirmação do pagamento). Essa funcionalidade possibilita integrar contabilidade, gestão de comissões, relatórios de desempenho e controle de fluxo financeiro de forma automatizada, assegurando que cada parte reciba a proporção correta do total faturado. Os splits são filtráveis por estado de processamento, data de confirmação, data de crédito e identificador da cobrança, facilitando buscas eficientes e auditoria de transações. Você pode recuperar detalhes de um split específico ou listar conjuntos de splits pagas e recebidas dentro de um intervalo de tempo ou condição de status. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Recuperar um único split pago Permite buscar no Asaas todas as informações de uma divisão de pagamento que já foi concluída, usando o identificador único fornecido. Quando acionado, o **Skyone Studio** envia uma requisição GET para o endpoint de splits pagos do Asaas e devolve detalhes como valor, data, status e conta credenciada. Esta ação é usada para validar ou exibir o resultado de um pagamento já processado, alimentar outro passo na lógica de fluxo ou atualizar registros internos com dados do pagamento. O usuário arrasta o componente para o fluxo, define o ID do split e conecta a saída ao próximo passo, sem precisar digitar código ou rotas.\ **Método:** GET **Endpoint:** /v3/payments/splits/paid/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica de forma única o split que

já foi pago, permitindo recuperar

exatamente esse registro.

Listar splits pagos Consulta o sistema externo para obter a lista de splits já pagos, permitindo filtrar os resultados por status, identificação da cobrança, datas de confirmação e datas de envio. Ao usar esta operação em um módulo no **Skyone Studio**, o usuário configura os filtros desejados e, após a execução, tem acesso à coleção de splits pagos. Essa lista pode ser usada em etapas subsequentes, como gerar relatórios, enviar notificações ou atualizar registros internos, oferecendo uma visão controlada esegmentada das transações pagas dentro do fluxo de integração. **Método:** GET **Endpoint:** /v3/payments/splits/paid **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
offsetstringNão0

Define a posição inicial da lista

de registros retornados,

permitindo paginação.

limitstringNão10

Define o número máximo de

itens retornados na página de

resultados, limitado a 100.

paymentIdstringNãoexample

Filtra a lista para mostrar

apenas os splits que pertencem

a uma cobrança específica,

identificada pelo ID fornecido.

statusstringNãoPENDING

Filtra o resultado para exibir

apenas os splits com o status

especificado.

paymentConfirmedDate[ge]stringNãoexample

Filtra registros a partir da data

de confirmação da cobrança.

paymentConfirmedDate[le]stringNãoexample

Filtra os splits pagos cuja data

de confirmação da cobrança

seja anterior ou igual à data

fornecida.

creditDate[ge]stringNãoexample

Filtra os splits pagos a partir da

data de envio especificada.

creditDate[le]stringNãoexample

Filtra os splits pagos cuja data

de envio seja igual ou anterior

à data informada.

### Conta Escrow A Conta Escrow representa um mecanismo de custódia de valores que garante a liquidação de cobranças até que as condições pré‑definidas sejam atendidas. Ela permite que os recursos sejam bloqueados na conta do prestador de serviços enquanto a cobrança está em análise, assegurando ao pagador que o valor será liberado apenas após a confirmação de que a transação foi concluída corretamente. Esta entidade facilita a criação e a aplicação de uma configuração padrão para todas as subcontas de uma empresa, de modo que cada subconta herde automaticamente parâmetros como prazo de expiração, habilitação do escrow e responsabilidade pelo pagamento de eventuais taxas. Além disso, a Conta Escrow oferece a possibilidade de encerrar a garantia de cobrança quando a obrigação é considerada cumprida, liberando o valor para o destinatário. Em suma, a Conta Escrow facilita a gestão de pagamentos em ambiente com múltiplas subcontas, proporcionando segurança, controle e flexibilidade aos processos de cobrança. A seguir, conheça a operação disponível. Para mais detalhes, clique na seta:
Encerrar garantia da cobrança na Conta Escrow Esta ação conclui uma garantia de cobrança registrada em uma Conta Escrow. Quando acionada, o **Skyone Studio** envia uma requisição ao serviço externo que efetua o encerramento da garantia, liberando, então, os valores bloqueados para o vendedor ou para o parceiro que esteja habilitado a receber o recurso. No processo de integração típica, a função funciona como um passo final em fluxos de pagamento ou financiamento, onde, após a confirmação de condições de liberação (por exemplo, a entrega do produto ou o cumprimento de prazos contratuais), o módulo conector do **Skyone Studio** usa a operação “Encerrar garantia da cobrança na Conta Escrow” na sequência, garantindo a movimentação segura e automatizada dos valores entre as partes envolvidas.\ **Método:** POST **Endpoint:** /v3/escrow/{id}/finish **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único da garantia de

cobrança na Conta Escrow que será

encerrada pelo endpoint.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### Documentos de cobranças A entidade de Documentos de Cobrança permite gerenciar os arquivos vinculados a cada pagamento processado no sistema externo. Ela facilita a anexação de papéis, faturas, contratos, mídia ou planilhas ao registro de cobrança, definindo se o documento ficará acessível ao cliente apenas após a liquidação. Com esta entidade, as soluções integradas podem controlar o ciclo de vida completo do arquivo: upload, catalogação, obtenção de detalhe único, listagem de todos os documentos associados e exclusão quando necessário. O objetivo principal é centralizar e disponibilizar a documentação relevante para o pagador, garantindo transparência e conformidade com as práticas de cobrança. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Fazer upload de documentos da cobrança Ao adicionar o módulo Asaas e utilizar esta operação no **Skyone Studio**, você cria um passo que envia um arquivo para uma cobrança específica no Asaas. O arquivo fica anexo à fatura e pode ser configurado para ficar visível apenas depois que o pagamento for concluído. Assim, o usuário que for efetuar o pagamento podevisualizar e baixar o documento direto na sua visualização da fatura. Este passo é comumente usado em fluxos de faturamento para anexar contratos, comprovantes ou qualquer outro documento relevante à nota fiscal ou ao pagamento, garantindo que o pagador tenha acesso apenas quando permitido.\ **Método:** GET **Endpoint:** /v3/payments/{id}/documents **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica a cobrança à qual o

documento será anexado.

Listar documentos de uma cobrança Essa ação solicita ao Asaas a lista completa de documentos associados a uma cobrança específica. No fluxo de integração, o usuário pode usar o módulo Asaas e usar a operação “Listar documentos de uma cobrança” no **Skyone Studio**, configurar o identificador da cobrança e, ao ser executado, o fluxo obtém todos os arquivos vinculados ao pagamento, como comprovantes de pagamento. Esses documentos podem então ser usados em etapas subsequentes, por exemplo, para anexar à geração de relatórios ou para exportar e arquivar documentos de custódia. O componente é essencial quando se precisa consolidar dados de pagamento e garantir que os arquivos de assinatura, recibos ou notas fiscais estejam disponíveis para automações posteriores. \ **Método:** GET **Endpoint:** /v3/payments/{id}/documents **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica a cobrança específica para

a qual os documentos de

pagamento devem ser listados.

Atualizar definições de um documento da cobrança Essa ação permite alterar as definições de um documento já associado a uma cobrança. Ela atualiza o tipo de arquivo e controla se o documento ficará disponível apenas após o pagamento. No **Skyone Studio**, é possível utilizar em um fluxo de integração para ajustar, em tempo real, a forma como os documentos são gerenciados e disponibilizados junto às cobranças, garantindo que o processo de emissão atenda aos requisitos específicos de cada cliente.\ **Método:** PUT **Endpoint:** /v3/payments/{id}/documents/{documentId} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
documentIdstringsimexample

Identifica o documento de cobrança

que será atualizado.

idstringsimexample

Identifica a cobrança que será

atualizada com o documento.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar um único documento da cobrança Essa ação permite que o integrador busque o documento específico de um pagamento no sistema do Asaas. Ao usar essa operação no **Skyone Studio**, a automação chama a API do Asaas para obter, por exemplo, um comprovante ou recibo PDF que acompanha a cobrança, permitindo o armazenamento ou envio posterior dentro do fluxo de negócio. Assim, a operação funciona como um passo de consulta que traz o arquivo de cobrança vinculado à transação, facilitando o controle documental no fluxo de integração.\ **Método:** GET **Endpoint:** /v3/payments/{id}/documents/{documentId} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único da cobrança no

Asaas que permite recuperar o

documento associado.

documentIdstringsim

Especifica qual documento do

pagamento deve ser recuperado e

retornado pela API.

Excluir documento de uma cobrança Ao usar a operação “Excluir documento de uma cobrança” no **Skyone Studio**, a integração removerá um arquivo associado a um pagamento no Asaas. O fluxo identifica a cobrança pelo seu ID e o documento pelo seu ID interno, enviando uma requisição DELETE. Esse passo é útil quando um documento enviado incorretamente deve ser retirado antes que o pagamento seja finalizado ou consolidado em relatórios, mantendo a base de dados limpa e atualizada.\ **Método:** DELETE **Endpoint:** /v3/payments/{id}/documents/{documentId} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
documentIdstringsimexample

Identifica o documento que será

excluído da cobrança.

idstringsimexample

Id: Identificador único da cobrança

no Asaas, usado para localizar qual

pagamento está sendo manipulado.

documentId: Identificador único do

documento dentro da cobrança,

usado para indicar qual arquivo será

excluído. access_token: Chave de API

que autentica o cliente, garantindo

acesso autorizado à rota. Accept:

Indica que o cliente aceita resposta

no formato JSON.

### Clientes A entidade de Clientes representa os consumidores com quem o seu negócio mantém relacionamento financeiro. No **Skyone Studio**, o cliente é considerado a unidade básica de cobrança, parcelamento e gestão de pagamentos, portanto todas as ações de integração giram em torno deste objeto. Com ele, você pode criar um novo cadastro, preenchendo nome, CPF/CNPJ, contato e endereço; recuperar dados individuais ou navegar por uma lista filtrada por nome, e‑mail, CPF/CNPJ, grupo ou referência externa; atualizar informações sempre que houver alteração de dados; remover e, se necessário, restaurar registros excluídos. Além disso, a entidade permite consultar as notificações associadas a cada cliente, facilitando o monitoramento de envio de faturas e lembretes. Essas funcionalidades permitem que você construa fluxos de integração completos: desde a criação do cliente na hora de abrir um contrato, passando pela emissão de cobranças e acompanhamento de notificações, até a exclusão ou restauração de cadastros conforme as políticas de retenção de dados da sua organização. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Criar novo cliente Esta operação cria um cliente na plataforma Asaas, produzindo um identificador que será usado em passos seguintes, como gerar cobranças ou serviços vinculados a essa entidade. No **Skyone Studio,** é possível usar essa ação para a sequência de integração e fornece as informações do cliente. Após a execução, o ID retornado pode ser passado para os módulos que criarão cobranças, garantindo que cada transação esteja corretamente associada a um cliente válido no sistema externo.\ **Método:** POST **Endpoint:** /v3/customers **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar cliente Executa no sistema externo uma solicitação que devolve uma lista paginada de clientes cadastrados. Ele permite inserir critérios de filtragem por nome, e‑mail, CPF/CNPJ, grupo ou referência externa do seu sistema. O objetivo é recuperar rapidamente um conjunto de clientes que atendam a essas condições, facilitando etapas subsequentes como geração de relatórios, exportação de dados ou disparo de notificações. No **Skyone Studio**, é possível adicionar o módulo com esta operação, configurar os filtros desejados e o componente entrega a lista de clientes para ser usada nos passos seguintes do processo de integração.\ **Método:** POST **Endpoint:** /v3/customers **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
offsetstringNão0

Define a partir de qual registro a

lista de clientes deve começar a ser

retornada.

limitstringNão10

Limita a quantidade de clientes

retornados na lista, com valor

máximo 100.

namestringNãoJohn Doe Filtra clientes pelo nome informado.
emailstringNãojohn.doe@asaas.com.br

Filtra clientes com base no e‑mail

informado.

CPF/CNJPstringNão24971563792

offset: Especifica o índice do

primeiro registro a ser retornado na

lista. limit: Define a quantidade de

registros retornados, com limite

máximo de 100. name: Filtra clientes

cujo nome contenha o valor

informado. email: Filtra clientes

usando o endereço de e‑mail exato.

cpfCnpj: Filtra clientes por CPF ou

CNPJ. groupName: Filtra clientes

pertencentes a um grupo específico.

externalReference: Filtra clientes

utilizando o identificador interno do

seu sistema.

groupNamestringNãoexample

Filtra a lista de clientes pertencentes

a um grupo específico.

externalReferencestringNãoexample

Filtra clientes usando o identificador

de referência externo do seu

sistema.

Recuperar um único cliente Ao usar esta operação, o fluxo faz uma chamada GET ao endpoint de clientes do Asaas, passando o identificador único do cliente. O sistema externo devolve os detalhes daquele cliente, como nome, e‑mail e status. Essa ação permite integrar dados de clientes em processos automatizados, como preencher templates de mensagens, validar cadastro ou alimentar relatórios. Assim, o componente funciona como um ponto de leitura dentro do fluxo de integração, trazendo informações necessárias para outras etapas que dependem dos dados do cliente.\ **Método:** GET **Endpoint:** /v3/customers/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Usado para indicar o identificador

único do cliente na API, permitindo

recuperar os dados desse cliente.

Atualizar cliente existente Esta ação leva o ID de um cliente já existente na plataforma ASAAS e envie um pacote JSON com as informações atualizadas, como nome, telefone, endereço, e dados de cadastro. Quando acionado no **Skyone Studio**, o módulo envia esses dados ao serviço de faturamento, permitindo que o cadastro no ASAAS reflita as alterações realizadas em outra aplicação ou em um formulário do usuário. Assim, o fluxo típico é: o usuário captura ou importa dados de cliente, usa o módulo Asaas com a operação “Atualizar cliente existente” no fluxo, vincula o campo que contém o ID e o payload, e a integração mantém os registros sincronizados, assegurando que o cliente no sistema externo tenha a informação mais recente. **Método:** PUT **Endpoint:** /v3/customers/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica o cliente que será

atualizado na solicitação.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Remover cliente Ao usar esta operação, o **Skyone Studio** envia uma solicitação para o sistema externo que exclui o cliente identificado pelo seu id. Quando executado, não apenas apaga o registro do cliente, mas também remove automaticamente todas as assinaturas em andamento e cobranças pendentes ou vencidas que pertençam a ele. Isso garante que, ao terminar o relacionamento com o cliente, nenhuma cobrança ou contrato siga ativo, evitando inconsistências no faturamento. Ao ser usado no fluxo, deve ser configurado o campo identificador e o sistema realiza a exclusão, mantendo a base de dados limpa e os processos financeiros corretos. **Método:** DELETE **Endpoint:** /v3/customers/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica o cliente que será excluído

pela requisição DELETE.

Restaurar cliente removido Para reativar um cliente excluído no sistema do Asaas, o **Skyone Studio** envia uma requisição que devolve o cliente ao estado ativo. Isso permite recuperá‑lo em cenários onde a exclusão foi acidental ou quando o cliente volta a fazer negócios, mantendo os dados associados. Na prática, ao utilizar o módulo Asaas com a operação “Restaurar cliente removido” no fluxo, ele passa o ID do cliente e, opcionalmente, detalhes de configuração, e o **Skyone Studio** executa a chamada para restaurá‑lo, continuando o fluxo de integração normalmente. **Método:** POST **Endpoint:** /v3/customers/{id}/restore **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexampleID do cliente que será restaurado.
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar notificações de um cliente Esta operação instrui o **Skyone Studio** a buscar todas as mensagens e alertas vinculados a um cliente específico no sistema externo. Ao inserir este módulo em seu fluxo de integração, a operação realiza uma consulta à base de dados de notificações. O resultado é um conjunto estruturado de eventos que podem ser apresentados ao cliente final, processados para análise ou roteados para serviços externos. Essa etapa costuma ocorrer logo depois que o cliente é identificado com sucesso, permitindo que o fluxo exiba seu histórico de avisos, atualize dashboards ou acione regras de automação baseadas nas notificações recuperadas. **Método:** GET **Endpoint:** /v3/customers/{id}/notifications **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador exclusivo do cliente

utilizado para recuperar as

notificações associadas a ele.

### Notificações A entidade de Notificações permite que os usuários do **Skyone Studio** configurem e personalizem as mensagens automáticas enviadas pelo Asaas em diversos canais (e‑mail, SMS, WhatsApp, correios e robô de voz). Seu objetivo principal é manter tanto o gestor quanto o cliente informado sobre eventos cruciais das cobranças – como lembretes de vencimento, confirmações de pagamento, atrasos e alterações de cadastro – garantindo transparência e melhor gerenciamento do fluxo financeiro. Por meio dessa entidade, é possível habilitar ou desabilitar cada tipo de notificação, definir quem recebe a mensagem (você ou o cliente), escolher os canais preferidos e estipular o número de dias antes do vencimento em que cada alerta deve ser disparado. Assim, os fluxos de integração do **Skyone Studio** podem adaptar o comportamento das notificações de acordo com as regras de negócio de cada cliente, otimizando a comunicação e reduzindo a probabilidade de inadimplência. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Atualizar notificação existente Ao executar a operação “Atualizar notificação existente”, o **Skyone Studio** dispara uma requisição de atualização diretamente para a API do sistema externo. Com isso, é possível selecionar uma notificação já criada, identificada por seu ID, e altere suas configurações – como habilitar ou desabilitar a notificação, escolher quais canais (e‑mail, SMS, voz ou WhatsApp) serão usados tanto para o provedor quanto para o cliente, e definir quanto tempo antes do vencimento a mensagem deve ser enviada. Essa ação é normalmente empregada em fluxos de integração que exigem ajustes finos nas campanhas de alerta de pagamento, garantindo que as comunicações estejam sempre alinhadas às preferências e políticas de negócio em cada etapa do processo de faturamento. **Método:** PUT **Endpoint:** /v3/notifications/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Especifica a notificação que será

atualizada.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Atualizar notificações existentes em lote Ao executar a operação “Atualizar notificações existentes em lote”, o **Skyone Studio** realiza uma única chamada à API do sistema externo, permitindo a atualização massiva das configurações de notificação de um cliente em uma única operação. Com essa operação, é possível habilitar ou desabilitar alertas por e‑mail, SMS e voz, escolher quem vai receber cada canal (você ou o cliente) e definir o prazo que a notificação deve ser enviada antes do vencimento. Essa ação facilita a gestão em massa das preferências de comunicação dentro de um fluxo de integração, mantendo as configurações de alerta sempre alinhadas à estratégia de relacionamento com o cliente. **Método:** PUT **Endpoint:** /v3/notifications/batch **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### Parcelamentos A entidade de Parcelamentos permite que os fluxos de integração do Skyone Studio gerenciem de forma programática todas as etapas relacionadas ao parcelamento de pagamentos. Ela engloba a criação de novos pactos de parcelamento, a consulta e a listagem de parcelas já configuradas, a atualização de suas regras de divisão (splits), a obtenção de detalhes completos de cada parcelamento, ou ainda a sua remoção quando não for mais necessária. Além disso, oferece suporte para monitorar as cobranças associadas a cada parcela, gerar carnês de pagamento em formato legível, e processar estornos de parcelas que foram concluídas via cartão de crédito. Ao integrar essa entidade, os sistemas podem automatizar o controle financeiro avançado, garantindo que as condições de pagamento, descontos, juros e multas sejam configurados de forma transparente e conforme as políticas internas, sem intervenção manual. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Criar parcelamento A operação cria um parcelamento no sistema externo. Ela registra uma sequência de parcelas para um cliente, definindo o número de parcelas, valor de cada parcela, data de vencimento da primeira e, opcionalmente, descontos, juros e multas. Também pode configurar a divisão dos valores entre diferentes carteiras. No **Skyone Studio**, esta operação deve ser posicionada após a validação dos dados do cliente para automatizar a criação do parcelamento no Asaas. Essa configuração permite que as cobranças sejam geradas de forma programática, integrando o fluxo de vendas diretamente ao sistema de faturamento do provedor. **Método:** POST **Endpoint:** /v3/installments **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar parcelamentos Esta ação consulta o sistema externo para recuperar uma página de registros de parcelamentos. Ao ser usada em um fluxo de integração no **Skyone Studio**, ela realiza uma chamada GET ao endpoint /v3/installments, enviando os parâmetros offset (posição inicial) e limit (quantidade máxima a retornar, até 100). O retorno contém a lista de parcelamentos e pode ser usado imediatamente dentro do fluxo: por exemplo, para exibir em uma tabela, para validar se há parcelas pendentes ou para alimentar outro serviço que precise desse conjunto de dados. Em cenários típicos de integração, essa etapa é útil quando você precisa sincronizar os parcelamentos de um cliente com outro sistema, gerar relatórios periódicos ou validar condições de pagamento antes de prosseguir com outras ações automatizadas.as e políticas de negócio em cada etapa do processo de faturamento. **Método:** GET **Endpoint:** /v3/installments **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
offsetstringnão0

Define a posição inicial dos registros

retornados.

limitestringnão10

Limita a quantidade máxima de

registros retornados na consulta,

com limite máximo de 100.

Criar parcelamento com cartão de crédito Esse componente cria, no Asaas, um acordo de cobrança parcelado usando cartão de crédito. Quando acionado, o Skyone Studio envia ao Asaas os dados do pagamento, configurando a quantidade de parcelas, valores, descontos, juros, multas, splits e as informações do cartão e do titular. O objetivo é gerar na conta do cliente um registro que permite cobrar automaticamente as parcelas e acompanhar seu status. Em um fluxo de integração típico, ele liga a finalização de uma venda ou pedido ao registro de parcelamento no Asaas, facilitando a cobrança automática e a integração entre o sistema interno e a plataforma de pagamentos **Método:** POST **Endpoint:** /v3/installments/ **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar um único parcelamento Este componente permite buscar as informações completas de um parcelamento específico, identificando‑o pelo seu ID único. Ao ser acionado, o **Skyone Studio** faz uma requisição para a API externa do Asaas e recupera os dados desse parcelamento, permitindo que o fluxo de integração utilize essa informação para exibição, cálculo adicional ou tomada de decisão downstream. Assim, ele complementa etapas de criação ou atualização de pagamentos ao possibilitar a leitura do estado atual de um parcelamento já existente. **Método:** GET **Endpoint:** /v3/installments/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único do parcelamento

que será retornado na requisição.

Remover parcelamento Ao usar esta operação no **Skyone Studio**, você cria uma etapa que solicita ao sistema externo excluir um parcelamento específico. É usado, por exemplo, para cancelar parcelas que ainda não foram quitadas ou que já venceram, mas que não estão sendo antecipadas nem negativadas. O componente envia uma requisição DELETE contendo o ID da parcela, e, uma vez concluído, o registro é permanentemente excluído e não pode ser recuperado. Isso permite que fluxos de cobrança ou de gerenciamento de dívidas façam o ajuste correto do conjunto de parcelas mantidas no sistema. **Método:** DELETE **Endpoint:** /v3/installments/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Especifica o identificador único do

parcelamento que será excluído pela

requisição DELETE.

Listar cobranças de um parcelamento Com essa operação, o **Skyone Studio** acessa a API de cobrança do sistema externo para obter todas as parcelas pendentes de um pagamento já parcelado. Ele consulta a lista de pagamentos vinculados a esse parcelamento, podendo filtrar pelo estado da cobrança, retornando somente os itens que correspondem ao critério escolhido. Essa ação é útil em fluxos de cobrança automatizados, onde se precisa verificar rapidamente quais parcelas ainda não foram liquidadas, acompanhar status da conta, ou gerar relatórios de inadimplência. Esta operação permite definir o ID do parcelamento e, opcionalmente, o status das faturas. A saída de dados pode ser conectada a etapas posteriores do fluxo, como processamento lógico, envio de e-mails ou atualizações em bancos de dados **Método:** GET **Endpoint:** /v3/installments/{id}/payments **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
statusstringnãopending

Filtra os pagamentos retornados

conforme o status especificado,

exibindo apenas aqueles que

correspondem ao valor informado.

idstringsimexample

Parâmetro de URL usado para

identificar o parcelamento. É

obrigatório e permite que a API

retorne as cobranças associadas a

esse parcelamento.

Gerar carnê de parcelamento A operação “Gerar carnê de parcelamento” solicita ao sistema externo a criação de um carnê (lista de pagamentos) a partir de um parcelamento já existente. Quando acionada no **Skyone Studio**, o fluxo de integração normalmente segue: Cadastro do parcelamento → Geração do carnê → Disponibilização do documento para o usuário ou exportação para exportar em relatórios. Essa ação facilita o acompanhamento visual dos pagamentos pendentes, proporcionando um meio consolidado para o cliente ou responsável financeiro acompanhar, ou imprimir as parcelas. **Método:** GET **Endpoint:** /v3/installments/{id}/paymentBook **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
sortstringnãoexample

Indica a coluna pela qual os registros

serão ordenados.

orderstringnãoasc

Define a direção da ordenação dos

resultados, ascendente (asc) ou

descendente (desc).

idstringsimexample

Identifica o parcelamento a partir do

qual será gerado o carnê de

pagamento.

Estornar parcelamento A operação “Estornar parcelamento” inicia no Asaas um estorno para uma parcela paga com cartão de crédito. Quando acionado, o Asaas revoga o valor da cobrança, debitando o saldo correspondente na sua conta e removendo o débito do cartão do cliente. Esse estorno pode ser total, parcial ou dividido entre os splits da parcela, permitindo reaver valores conforme a necessidade. No **Skyone Studio**, essa ação deve ser inserida no fluxo de integração onde a cobrança foi ou deve ser cancelada. Por exemplo, após o término de um serviço, devolução de produto ou mudança de plano, garantindo que o dinheiro seja devolvido ao cliente e o saldo da empresa, seja ajustado automaticamente. **Método:** POST **Endpoint:** /v3/installments/{id}/refund **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único do parcelamento

a ser estornado.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Atualizar splits do parcelamento Esta ação atualiza a distribuição de valores de um parcelamento já existente. Ao clicar no componente no Skyone Studio, ele envia os novos splits, definindo quantos pagamentos cada parte receberá, com valores fixos, percentuais ou totais, e quem deve receber. É usada quando a lógica de pagamento precisa ser alterada sem recriar o parcelamento, ajustando a forma como o valor será repartido entre as carteiras e descrições estipuladas. Isso mantém o fluxo de integração alinhado com mudanças nas regras de negócio ou na estrutura de pagamento. **Método:** PUT **Endpoint:** /v3/installments/{id}/splits **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica o parcelamento ao qual

serão aplicados os novos splits.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### Assinaturas A entidade Assinaturas permite aos processos de integração da **Skyone Studio** gerir todo o ciclo de vida das renovações periódicas de serviços. Ela abrange a criação de planos recorrentes em diversos métodos de pagamento, desde boleto até cartão de crédito, permitindo configurar valores, datas de vencimento, ciclos, descontos, juros e multas. Além disso, a entidade oferece recursos para alterar ou eliminar assinaturas existentes, recuperar detalhes de assinaturas individuais e listar coleções filtráveis por cliente, status ou tipo de faturamento, facilitando análises e sincronizações de dados. No que diz respeito ao fluxo de cobrança, a entidade permite listar pagamentos pendentes ou concluídos por assinatura, gerar carnês de pagamento em períodos específicos, e configurar a emissão de notas fiscais associadas à cada assinatura, assegurando o cumprimento de requisitos contábeis e fiscais. Esta funcionalidade centraliza a automação de faturamento recorrente, a gestão de pagamentos futuros e a produção de documentos fiscais, possibilitando que os workflows de integração mantenham a base de clientes sempre atualizada com informações de pagamento, histórico e compliance. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Criar nova assinatura Quando você adiciona a operação “Criar nova assinatura” no **Skyone Studio**, o sistema envia uma requisição POST para o endpoint de assinaturas do Asaas. O objetivo é registrar um cliente em um plano recorrente, configurando o tipo de cobrança (boleto, cartão, PIX), o valor, a data da primeira parcela, a frequência de cobrança (mensal, semanal, anual) e, opcionalmente, descontos, juros e multas. Você também pode indicar se o pagamento já será cobrado imediatamente ou quando a primeira parcela vencer. O componente pode incluir informações de split para distribuir a receita em múltiplas carteiras e configurar callbacks para redirecionamento automático. Esta ação costuma ser parte de um fluxo de onboarding de cliente, onde, após a captura de dados de pagamento ou criação de um cliente, a assinatura é criada e o cronograma de cobranças é iniciado, permitindo que as parcelas sejam debitadas periodicamente até a data de término ou número máximo especificado. **Método:** POST **Endpoint:** /v3/subscriptions **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar assinaturas Ao usar esta operação no **Skyone Studio**, o sistema envia uma requisição ao endpoint de assinatura do serviço externo. Essa ação solicita ao provedor a lista de assinaturas cadastradas, permitindo que o integrador escolha quais itens receber. A lista pode ser ordenada e filtrada de acordo com critérios como cliente, grupo, status ou método de pagamento, mas os detalhes desse filtro não são expostos ao integrador no momento da configuração. O objetivo principal é disponibilizar o conjunto completo (ou parcial, conforme paginação) de assinaturas para que a cadeia de processos internos possa consultar, filtrar ou atualizar dados relacionados a vendas recorrentes, cobrança ou gestão de clientes. Em um fluxo típico, esse componente serve como ponto de partida para etapas posteriores, como gerar relatórios, sincronizar bancos de dados internos ou disparar alertas de status. Assim, ele facilita a obtenção centralizada das informações de assinatura dentro da automação criada no **Skyone Studio**. **Método:** GET **Endpoint:** /v3/subscriptions **Parâmetros:** | offset | não | string | `0` | Define o ponto inicial a partir do qual a lista de assinaturas é retornada. | | :---------------: | :-: | :----: | :---------: | :-------------------------------------------------------------------------------------------------------------------------: | | limit | não | string | `10` | Define o número máximo de assinaturas a serem retornadas na lista (máximo 100). | | customer | não | string | `example` | Filtra a lista de assinaturas pelo identificador único do cliente. | | customerGroupName | não | string | `example` | Filtra as assinaturas retornadas, exibindo apenas aquelas de clientes que pertencem ao grupo de cliente indicado pelo nome. | | billingType | não | string | `UNDEFINED` | Filtra as assinaturas de acordo com o método de pagamento escolhido, como BOLETO, CARTÃO, etc. | | status | não | string | `ACTIVE` | Filtra as assinaturas pelo seu status (ex.: ACTIVE, INACTIVE, CANCELLED). | | deletedOnly | não | string | `example` | Exibe apenas assinaturas que foram excluídas. | | includeDeleted | não | string | `example` | Recupera também as assinaturas que foram marcadas como excluídas. | | externalReference | não | string | `example` | Filtra as assinaturas pelo identificador externo do seu sistema. | | order | não | string | `example` | Define se a lista deve ser apresentada em ordem crescente ou decrescente. | | sort | não | string | `example` |

Define o campo pelo qual a lista de

assinaturas será ordenada.

|
Criar assinatura com cartão de crédito Esta ação cria uma assinatura recorrente no provedor externo usando dados de cartão de crédito. Ao ser usado no **Skyone Studio**, o sistema monta uma requisição POST contendo informações do cliente, valor, frequência, data de vencimento inicial e, opcionalmente, a tokenização do cartão. O cartão é validado logo na criação; se aprovado, a assinatura é salva e será cobrada automaticamente na data de vencimento de cada parcela. Se a validação falhar, a assinatura não é criada e o fluxo recebe um erro. Este componente costuma ser usado na etapa de “adicionar plano” de um cliente, permitindo que pagamentos futuros sejam gerenciados pelo provedor de forma automática. **Método:** POST **Endpoint:** /v3/subscriptions/ **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar uma única assinatura Ao executar a operação “Atualizar notificação existente”, o **Skyone Studio** dispara uma requisição de atualização diretamente para a API do sistema externo. Com isso, é possível selecionar uma notificação já criada, identificada por seu ID, e altere suas configurações – como habilitar ou desabilitar a notificação, escolher quais canais (e‑mail, SMS, voz ou WhatsApp) serão usados tanto para o provedor quanto para o cliente, e definir quanto tempo antes do vencimento a mensagem deve ser enviada. Essa ação é normalmente empregada em fluxos de integração que exigem ajustes finos nas campanhas de alerta de pagamento, garantindo que as comunicações estejam sempre alinhadas às preferências e políticas de negócio em cada etapa do processo de faturamento. **Método:** GET **Endpoint:** /v3/subscriptions/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Recupera a assinatura específica

identificada pelo ID informado.

Atualizar assinatura existente Ao utilizar a operação “Atualizar assinatura existente” no Skyone Studio, a ferramenta monta um pedido para a API externa, enviando os dados de atualização de uma assinatura já existente. O serviço externo recebe as novas informações de cobrança, como tipo de pagamento, status, data de vencimento, descontos, juros, multa e frequência de cobrança, além de opções de divisão de valores entre carteiras ou referência externa. A operação permite alterar apenas as parcelas futuras, mas quando o parâmetro updatePendingPayments for habilitado, as parcelas pendentes já geradas também recebem as alterações. Se o status for alterado para INACTIVE, a assinatura entra em suspensão e as cobranças deixam de ser geradas; ao mudar de volta para ACTIVE é necessário informar a próxima data de vencimento. Assim, o componente serve para sincronizar mudanças de plano, pagamento ou estado da assinatura no fluxo de integração, garantindo que o sistema externo reflita exatamente o que o usuário definiu no Skyone Studio. **Método:** PUT **Endpoint:** /v3/subscriptions/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único da assinatura a

ser atualizada.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Remover assinatura A operação “Remover assinatura” elimina uma assinatura previamente cadastrada no sistema externo. Ela dispara uma solicitação DELETE apontando para a assinatura indicada pelo seu identificador exclusivo. Essa ação é útil quando o fluxo de integração precisa desativar ou cancelar assinaturas que não são mais necessárias, como ao encerrar o contrato de um cliente ou ao gerenciar recursos de cobrança automaticamente. Assim, ao adicionar essa operação no **Skyone Studio**, você garante que o processo de cancelamento ocorra de forma consistente e integrada com os demais passos do seu workflow. **Método:** DELETE **Endpoint:** /v3/subscriptions/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único da assinatura que

será removida.

Listar cobranças de uma assinatura Esta ação recupera o histórico de pagamentos de uma assinatura específica, permitindo que o usuário visualize todas as cobranças associadas. Ele pode filtrar os resultados por status, como “PENDING”, “RECEIVED” ou “OVERDUE”, para focar em transações em determinadas fases de processamento. Em um fluxo de integração no Skyone Studio, essa operação é utilizada para obter rapidamente o estado atual das cobranças de uma assinatura, facilitando a tomada de decisões sobre cobrança, renegociação ou cobrança de dívidas em processos mais amplos de gestão financeira. **Método:** GET **Endpoint:** /v3/subscriptions/{id}/payments **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
statusstringnãoPENDING

Filtra as cobranças de uma assinatura

por seu status, permitindo, por

exemplo, listar apenas cobranças em

estado “PENDING”.

idstringsimexample

Especifica a notificação que será

atualizada.

Gerar carnê de assinatura Essa operação permite que o usuário peça ao Asaas a criação de um carnê de pagamento para uma assinatura específica. Ao usar essa operação no **Skyone Studio**, ela envia uma solicitação ao endpoint de assinatura, instruindo o sistema a compilar todos os pagamentos que se enquadram no período definido (até determinado mês e ano) e a organizar os registros conforme a coluna e ordem escolhidas, caso o usuário queira. O resultado é uma lista de parcelas já prontas, que pode ser usada em etapas subsequentes do fluxo, como envio de boletos eletrônicos, download de arquivos PDF ou armazenamento para referência interna. Assim, o componente integra o fluxo de faturamento do Asaas de forma transparente e automática dentro da experiência do **Skyone Studio**. **Método:** GET **Endpoint:** /v3/subscriptions/{id}/paymentBook **Parâmetros:** | month | não | string | `example` | Define até qual mês o Carnê de pagamento deve incluir os registros. | | ----- | --- | ------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | year | não | string | `example` | Define o ano final do período para o qual será gerado o carnê, filtrando assim os registros somente até esse ano. | | sort | não | string | `example` | Filtra os registros com base no nome da coluna fornecido. | | order | não | string | `asc` | Define a ordem de classificação do resultado, podendo ser ascendente (asc) ou descendente (desc). | | id | sim | string | `example` |

id: Identificador único da assinatura, usado para localizar a assinatura no sistema.

month: Indica o mês final até o qual os pagamentos serão incluídos no carnê de assinatura.

year: Indica o ano final até o qual os pagamentos serão incluídos no carnê de assinatura.

sort: Nome da coluna que será utilizada para ordenar os registros retornados.

order: Direção da ordenação dos resultados, ascendente (asc) ou descendente (desc). Default: asc.

|
Criar configuração para emissão de Nota Fiscal A operação “Criar configuração para emissão de Notas Fiscais” registra, no sistema externo de faturamento, as regras que devem ser seguida quando a nota fiscal for gerada para uma assinatura específica. Ao usar esta operação no **Skyone Studio** e apontar para uma assinatura, você indica quando o documento deve ser emitido, se será emitido apenas após pagamento, quais impostos serão aplicados, se haverá deduções, e quais observações e períodos fiscais usar. Essa configuração permite que o fluxo de integração automatize a geração das notas fiscais de acordo com as necessidades do cliente, mantendo os valores corretos e a conformidade fiscal, sem a necessidade de intervenções manualmente para cada cobrança. **Método:** POST **Endpoint:** //v3/subscriptions/{id}/invoiceSettings **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica a assinatura específica para

a qual a configuração de emissão de

notas fiscais será criada.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar configuração para emissão de Notas Fiscais Nesta operação, o **Skyone Studio** envia uma solicitação GET para o endpoint do Asaas que retorna as configurações de emissão de notas fiscais de uma assinatura específica. Ao colocar esta ação no fluxo, você pode selecionar o identificador da assinatura e, em seguida, usar as configurações obtidas para decidir como gerar ou enviar faturas nos passos seguintes. Assim, o componente serve como ponto de entrada para sincronizar parâmetros de faturamento entre seu sistema e o Asaas, permitindo que o usuário configure, valide ou aplique essas regras de emissão dentro deste mesmo fluxo de integração. **Método:** GET **Endpoint:** /v3/subscriptions/{id}/invoiceSettings **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Especifica o identificador da

assinatura para a qual se deseja

obter as configurações de emissão

de notas fiscais.

Remover configuração para emissão de Notas Fiscais Esta operação remove a configuração de emissão automática de notas fiscais de uma assinatura específica. Quando acionada no Skyone Studio, ela faz com que todas as notas fiscais que estavam agendadas para cobranças futuras da assinatura sejam canceladas e que o sistema deixe de gerar notas fiscais automaticamente para essa assinatura. Esse passo costuma ser usado em fluxos onde o cliente deseja desativar a geração de notas fiscais, por exemplo, ao mudar o plano de cobrança ou quando a obrigação fiscal muda. Assim, no fluxo, o usuário indica que a emissão de notas fiscais deve ser encerrada e o sistema externo atualiza accordingly. **Método:** DELETE **Endpoint:** /v3/subscriptions/{id}/invoiceSettings **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único da assinatura

cujo ajuste de emissão de notas

fiscais será removido.

Atualizar configuração para emissão de Notas Fiscais Gerencia as regras de emissão de cobranças para uma assinatura específica. Ao enviar um payload JSON com parâmetros como regras de periodicidade, opções tributárias e observações, o serviço aplica essas preferências às faturas futuras ou ainda não geradas. No **Skyone Studio**, ao adicionar o módulo no fluxo, informe o ID da assinatura e as novas configurações para que o sistema execute uma requisição `PUT`, automatizando a conformidade das regras de negócio e cálculos de impostos. **Método:** PUT **Endpoint:** /v3/subscriptions/{id}/invoiceSettings **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Especifica a assinatura cujo conjunto

de configurações de emissão de

notas fiscais será atualizado.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar notas fiscais das cobranças de uma assinatura Essa operação consulta o sistema Asaas para obter a lista paginada de notas fiscais geradas a partir das cobranças de uma assinatura específica. Ao usar esta operação no **Skyone Studio**, o fluxo pode solicitar os documentos fiscais vinculados a uma assinatura, aplicar filtros por data de emissão, status ou identificadores externos, e receber de volta o conjunto de notas em formato JSON. Essa listagem facilita ações subsequentes — como exibir relatórios, validar faturamento ou integrar os dados em outro sistema — no contexto de um processo de integração automatizado. Essa ação é normalmente empregada em fluxos de integração que exigem ajustes finos nas campanhas de alerta de pagamento, garantindo que as comunicações estejam sempre alinhadas às preferências e políticas de negócio em cada etapa do processo de faturamento. **Método:** GET **Endpoint:** /v3/subscriptions/{id}/invoices **Parâmetros:** | offset | não | string | `0` | offset | | ------------------ | --- | ------ | ------------------ | ------------------ | | limit | não | string | `10` | limit | | effectiveDate\[ge] | não | string | `2024-08-20` | effectiveDate\[ge] | | effectiveDate\[le] | não | string | `2024-08-20` | effectiveDate\[le] | | externalReference | não | string | `example` | externalReference | | status | não | string | `SCHEDULED` | status | | customer | não | string | `cus_000000002750` | customer | | id | sim | string | `example` | id |
### PIX A entidade Pix Key e QR Code Estático engloba a criação, consulta, listagem, remoção e gerenciamento de chaves de endereço Pix, bem como a geração e exclusão de QR Codes estáticos para recebimento de pagamentos por meio do sistema Pix. Seu propósito principal é permitir que o fluxo de integração gerencie de forma eficiente a disponibilidade de chaves Pix (EVP) e a emissão de QR Codes permanentes que possibilitam a captura de pagamento automático na sua conta. O gerenciamento completo desta entidade garante que as cobranças, contratos ou transações de recebimento sejam vinculados a uma chave válida, evitando atrasos e mantendo a conformidade com as regras do Banco Central. Assim, facilita a integração de processos de faturamento, cobrança automática e recebimento direto, assegurando que pagamentos via Pix ocorram de forma instantânea e que o fluxo de dados bancários seja mantido de forma segura e automatizada. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Criar uma chave No **Skyone Studio**, a etapa "Criar uma chave" gera uma nova chave de endereço Pix na conta Asaas. Essa ação adiciona ao sistema externo um identificador que permite receber pagamentos via Pix, sendo essencial em fluxos de cobrança onde o cliente precisa pagar com moedas digitais. Ao adicionar no fluxo de integração, basta configurar a mensagem JSON com o tipo de chave desejado e a encadeara depois de outras etapas, como geração de cobranças ou verificação de status. Assim, ao disparar o fluxo, a chave é criada, permitindo que futuros pagamentos sejam direcionados ao endereço configurado. Com isso, cria-se uma nova chave Pix no Asaas, que pode então ser usada para receber valores. **Método:** POST **Endpoint:** /v3/pix/addressKeys **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar chaves A operação "Listar chaves" consulta o serviço externo que devolve a lista de chaves Pix cadastradas na conta, permitindo filtrar por status ou paginar o resultado. Quando adicionado ao fluxo no **Skyone Studio**, ela é normalmente usada antes de processos que precisam conhecer o estado das chaves - por exemplo, gerar relatórios de chaves ativas, validar se uma chave está devidamente ativada antes de iniciar uma transferência ou sincronizar o histórico de chaves com outro sistema. Assim, a operação alimenta etapas posteriores do fluxo com a informação atualizada das chaves Pix. **Método:** GET **Endpoint:** /v3/pix/addressKeys **Parâmetros:** | offset | não | string | 0 |

Define o índice inicial do registro a ser listado.

| | :--------: | :-: | :----: | :-----------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | limit | não | string | 10 |

Número de registros retornados pela consulta, com limite máximo de 100.

| | status | não | string | AWAITING ACTIVATION |

Filtra a lista de chaves por um único status atual.

| | statusList | não | string | example |

Filtra a lista de chaves PIX para incluir apenas aquelas cujos status correspondam a um ou mais valores especificados.

|
Recuperar uma única chave Ao utilizar a operação "Recuperar uma única chave" no Skyone Studio, o sistema faz uma chamada para o serviço de Pix do Asaas usando o identificador que você especificou. O objetivo é buscar todas as informações de uma chave Pix específica como tipo, valor e status - para que seu fluxo possa usar esses dados mais adiante. Isso costuma ser útil quando o seu processo precisa validar ou exibir detalhes de uma chave já cadastrada, por exemplo, antes de gerar uma cobrança ou preencher um formulário de pagamento. O componente obtém apenas a chave pelo id e entrega os dados para os próximos passos do seu workflow. **Método:** GET **Endpoint:** /v3/pix/addressKeys/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Usado para buscar uma chave Pix

específica pelo seu identificador

único.

Remover chave A operação "Remover chave" permite excluir uma chave Pix registrada no sistema externo usando seu identificador único. Ela é acionado quando o fluxo de integração precisa apagar um registro de chave Pix, por exemplo, ao revogar acesso de um cliente, corrigir uma chave inválida ou limpar dados antigos. Ao utilizar essa operação no Skyone Studio, ela envia uma solicitação de exclusão ao serviço, aguardando confirmação de remoção. Isso garante que o estado do sistema externo fique sincronizado com a lógica de negócio definida no **Skyone Studio**. **Método:** DELETE **Endpoint:** /v3/pix/addressKeys/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único da chave Pix que

será excluída.

Criar QR Code estático A operação "Criar QR Code estático" permite que o usuário configure no **Skyone Studio** um passo que, quando acionado, envia uma solicitação ao sistema externo de pagamentos para gerar um QR Code Pix que pode ser exibido em qualquer canal de atendimento. Ao criar o código estático, você define a chave que receberá os pagamentos, uma descrição opcional, o valor a ser cobrado (ou deixar o pagador escolher) e o prazo de validade. Essa ação é tipicamente usada em fluxos onde a empresa precisa disponibilizar um QR Code pronto e pré-configurado para que clientes façam pagamentos de forma rápida e segura em lojas físicas, eventos ou aplicações mobile. **Método:** POST **Endpoint:** /v3/pix/qrCodes/static **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Deletar QR Code estático A ação "Deletar QR Code estático" remove de forma permanente um QR Code previamente criado e armazenado pelo sistema externo. Quando ativada no **Skyone Studio**, esta operação recebe o identificador do QR Code que o negócio já disponibilizou ao cliente e faz com que ele não possa mais ser usado para pagamentos ou acessos. Essa funcionalidade é típica em fluxos de atualização de dados, quando um código antigo fica desatualizado, ou quando o cliente solicita a revogação de um QR Code que não deve mais ser válido. Assim, o usuário pode planejar, em um fluxo visual, a remoção de QR Codes que estiveram em uso temporariamente, mantendo o controle de ativos digitais e evitando fraudes ou erros de cobrança. **Método:** DELETE **Endpoint:** /v3/pix/qrCodes/static/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Remove o QR Code especificado

pelo identificador.

### Transações PIX A entidade de Transações Pix engloba todo o conjunto de funcionalidades que permite ao seu fluxo de integração gerenciar pagamentos diretos via Pix. Ela possibilita capturar valores enviados por QR Code (dinâmico ou estático), decodificar QR Code para extrair informações de pagamento, consultar o status e detalhes de transações já realizadas e controlar o ciclo de vida de transações agendadas, inclusive a possibilidade de cancelá‑las antes do seu processamento final. Essa camada de serviços integra os processos de recebimento, verificação e liquidação de pagamentos instantâneos, garantindo que cada transação seja registrada, monitorada e, quando necessário, revertida ou ajustada. A estrutura oferece um ponto de atuação centralizado, permitindo que os seu fluxo de integração se conecte a um modelo robusto de pagamentos Pix com alto grau de automatização e eficiência, reduzindo latências comuns a transações não previstas. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Pagar um QRCode Esta operação permite efetuar o pagamento de um QRCode diretamente no sistema externo. No fluxo de integração, o usuário escolhe a operação "Pagar um QRCode" no Skyone Studio e preenche apenas a informação mínima necessária como o código, valor, descrição e data de agendamento que a ação usa para criar a transação de pagamento no provedor de serviços. Assim, a aplicação automatiza a cobrança de usuários que escaneiam um QRCode, garantindo que o pagamento seja registrado, confirmado e processado em tempo real dentro do fluxo de negócios. **Método:** POST **Endpoint:** /v3/pix/qrCodes/pay **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Decodificar um QRCode para pagamento Ao usar esta operação no fluxo de integração, o **Skyone Studio** envia a string do QR Code Pix para o provedor de pagamentos. O serviço devolve os dados estruturados contidos no QR - valor, favorecido, identificador de transação e, opcionalmente, o troco solicitado - permitindo que o fluxo continue com validação, registro ou reconciliação automática. Esse passo transforma a informação legível pelo consumidor em campos que os próximos módulos do **Skyone Studio** podem usar diretamente, facilitando a criação de cobranças, pagamentos ou notificações. **Método:** POST **Endpoint:** /v3/pix/qrCodes/decode **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar uma única transação A operação recupera os detalhes de uma transação de pagamento Pix específica da AsaaS usando seu identificador exclusivo. Ela envia uma solicitação GET para a API externa, obtém os dados da transação e os repassa no fluxo de integração. Essa ação é usada quando você precisa confirmar, auditar ou incluir informações da transação em etapas subsequentes, como criação de registro, notificação ou geração de relatórios. O usuário pode usar a operação em um fluxo de integração do **Skyone Studio**, mapear a entrada do ID da transação necessária e consumir os dados retornados nos nós seguintes. **Método:** GET **Endpoint:** /v3/pix/transactions/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Especifica o identificador único da

transação Pix a ser recuperada.

Listar transações A operação "Listar transações" consulta o serviço externo de Pix do Asaas e devolve um conjunto de transações registradas no banco. A operação facilita a navegação pelos registros, permitindo paginar os resultados e aplicar filtros por estado da operação, tipo de movimentação (débito ou crédito) ou pelo identificador oficial do Banco Central. Em um fluxo típico, no **Skyone Studio**, é possível definir as condições desejadas e conecta a sua saída a etapas posteriores, como filtro adicional, análise ou geração de relatórios. O objetivo é integrar, na aplicação, a visualização e o tratamento de transações Pix já processadas, possibilitando reconciliações, auditorias ou atualizações de status em sistemas internos. **Método:** GET **Endpoint:** /v3/pix/transactions **Parâmetros:** | offset | não | string | 0 |

Específica a posição inicial na lista de transações retornadas, facilitando a paginação dos resultados.

| | :----------------: | :-: | :----: | :--------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | limit | não | string | 10 |

Define quantos registros da lista de transações Pix será retornada na resposta, com um limite máximo de 100 por requisição.

| | status | não | string | AWAITING BALANCE\_VALIDATION |

Filtra as transações retornadas pelo endpoint de acordo com o seu status.

| | type | não | string | DEBIT |

Filtra as transações retornadas pelo tipo, como DEBIT (débito) ou CREDIT (crédito).

| | endToEndIdentifier | não | string | example |

Filtra a listagem de transações Pix pelo identificador de transação atribuído pelo Banco Central.

|
Cancelar uma transação agendada Esta ação permite ao usuário cancelar uma transação Pix que já foi agendada no sistema externo. No **Skyone Studio**, a operação é utilizada no fluxo de processamento de pagamentos e configurado com o identificador da transação. Quando acionado, o **Skyone Studio** envia uma requisição POST ao serviço de Pix, solicitando a anulação daquela transação específica. Se o cancelamento for aceito, o serviço responde com sucesso ; caso contrário, retornará erro de requisição, autorização ou recurso não encontrado. Essa funcionalidade é útil em cenários onde o pagamento programado precisa ser revertido por motivos variados, garantindo que o fluxo de integração mantenha a consistência entre os sistemas de origem e de destino, evitando cobranças indevidas ou saldo incorreto. **Método:** POST **Endpoint:** /v3/pix/transactions/{id}/cancel **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único da transação Pix

agendada que será cancelada.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### PIX recorrente A entidade de Recorrência de Pagamento PIX permite que os usuários criem, mantenham e controlem fluxos de pagamento recorrente através do sistema PIX do banco. Na prática, ela possibilita o controle completo da jornada do pagamento, desde a criação de um plano de cobrança recorrente até o encerramento ou cancelamento de parcelas individuais. Através desta entidade, é possível avaliar o status de cada transação, filtrar resultados por valor, nome do recebedor e outras condições de negócio, além de monitorar o consumo e a frequência de pagamentos dentro dos contratos de assinatura ou financiamentos. Os fluxos de integração podem se basear em consultas de histórico, na confirmação de pagamentos, no cancelamento automático de assinaturas ao atingirem limites de tentativa ou nas necessidades de reavaliação de condições de crédito. Em suma, a Recorrência PIX centraliza a lógica de pagamentos recorrentes em um ponto único, garantindo consistência, segurança e rapidez nas operações de cobrança. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Listar recorrências A ação "Listar recorrências" envia uma chamada GET para o endpoint externo que retorna a lista de transações Pix recorrentes. No **Skyone Studio**, ao inserir este módulo em seu fluxo de integração, a operação define, opcionalmente, filtros como página (offset/limit), status da recorrência, valor ou nome do recebedor. O sistema externo responde com os registros que atendem a esses critérios, permitindo ao usuário exibir relatórios, verificar pendências ou iniciar processos automatizados de aprovação ou cancelamento dentro do fluxo de dados. Esta operação facilita o acompanhamento em tempo real e a reconciliação de pagamentos recorrentes. **Método:** GET **Endpoint:** /v3/pix/transactions/recurrings **Parâmetros:** | offset | não | string | e |

Especifica o indice do primeiro item da lista de resultados, facilitando a paginação.

| | :--------: | :-: | :----: | :------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------: | | limit | não | string | 10 |

Define o número máximo de itens retornados na lista, com limite máximo de 100.

| | status | não | string | AWAITING CRITICAL\_ACTIONAUTHORIZATION |

Filtra as recorrências retornadas pelo status especificado.

| | value | não | string | 100 |

Filtra as recorrências pelo valor informado.

| | searchText | não | string | example |

Filtra as recorrências de acordo com o nome do recebedor.

|
Recuperar uma única recorrência A ação recupera os detalhes de uma única transação recorrente do sistema de pagamento AsaaS. Quando adicionada a um fluxo de trabalho, ela busca a recorrência especificada e retorna seu status atual, valor, cronograma e outras informações relacionadas. Essa etapa de busca permite que a integração confirme ou inspecione um determinado pagamento recorrente antes de prosseguir para ações subsequentes, como atualizar registros internos, enviar notificações ou acionar outras lógicas de negócios com base no estado da recorrência. **Método:** GET **Endpoint:** /v3/pix/transactions/recurrings/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único da recorrência a

ser recuperada

Cancelar uma recorrência Ao usar a operação "Cancelar uma recorrência" em um fluxo no **Skyone Studio**, o sistema envia uma solicitação ao Asaas para interromper uma transação PIX automática previamente configurada. A ação efetivamente encerra o ciclo de pagamentos recorrentes associado à transação, garantindo que futuros débitos não sejam executados. Esse passo costuma ser usado em cenários de encerramento de assinaturas, cancelamento de planos ou correção de recorrências indevidas, permitindo ao fluxo de integração gerir o ciclo de vida dos pagamentos de forma automática e consistente. **Método:** POST **Endpoint:** /v3/pix/transactions/recurrings/{id}/cancel **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica de forma única a

recorrência que será cancelada.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar itens de uma recorrência Esta operação permite que o **Skyone Studio** recupere a lista de itens associados a uma transação recorrente identificada por um código único. Ao acionar o componente, o **Skyone Studio** enviará uma requisição que devolve todos os itens relacionados à assinatura ou plano recorrente, possibilitando que o fluxo de integração visualize, processe ou exiba esses dados no destino desejado. No contexto de um fluxo de trabalho, o usuário arrasta o componente "Listar itens de uma recorrência" para a área de design, define o ID da recorrência através de uma variável do fluxo, e o **Skyone Studio** executa a chamada automaticamente quando o evento de gatilho ocorre. Assim, o dado retornado pode ser analisado, filtrado ou encaminhado a outras etapas, como atualizações de registro, geração de relatórios ou notificações. **Método:** GET **Endpoint:** /v3/pix/transactions/recurrings/{id}/items **Parâmetros:** | offset | não | string | e |

Especifica a posição inicial da lista a ser retornada (indice de paginação).

| | :----: | :-: | :----: | :-----: | :-------------------------------------------------------------------------------------------------------------------------------------: | | limit | não | string | 10 |

Define o número máximo de itens que serão retornados na lista, limitado a 100 registros.

| | id | sim | string | example |

Identificador único da recorrência, obrigatória para selecionar os itens correspondentes.

|
Cancelar item de uma recorrência Ao executar a operação “Atualizar notificação existente”, o **Skyone Studio** dispara uma requisição de atualização diretamente para a API do sistema externo. Com isso, é possível selecionar uma notificação já criada, identificada por seu ID, e altere suas configurações – como habilitar ou desabilitar a notificação, escolher quais canais (e‑mail, SMS, voz ou WhatsApp) serão usados tanto para o provedor quanto para o cliente, e definir quanto tempo antes do vencimento a mensagem deve ser enviada. Essa ação é normalmente empregada em fluxos de integração que exigem ajustes finos nas campanhas de alerta de pagamento, garantindo que as comunicações estejam sempre alinhadas às preferências e políticas de negócio em cada etapa do processo de faturamento. **Método:** POST **Endpoint:** /v3/pix/transactions/recurrings/items/{id}/cancel **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Especifica a notificação que será

atualizada.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### Link de pagamentos A entidade Payment Links permite que os usuários criem, gerenciem, atualizem e monitorem links de pagamento de forma ágil e personalizada, integrando-se facilmente aos fluxos de negócio do **Skyone Studio**. Com ela, empresas podem disponibilizar links para produtos ou serviços, definir valores, datas de vencimento, ciclos de assinatura, opções de parcelamento e políticas de cobrança. Além das configurações básicas, é possível configurar URLs de callback, redirecionamento automático, imagens associadas ao link e definições de visualização principal. A entidade oferece controle completo sobre o ciclo de vida do link, permitindo sua liberação, suspensão, restauração e exclusão, bem como a gestão de múltiplas imagens para personalização visual e marketing. Essa funcionalidade facilita a emissão de formas de pagamento online, a automação de processos de cobrança e o acompanhamento de métricas de conversão diretamente dentro de fluxos de integração no **Skyone Studio**. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Criar um link de pagamentos Ao usar a operação "Criar um link de pagamentos" no **Skyone Studio**, você configurará uma etapa que gera um link de pagamento para um produto ou serviço no sistema externo. O bloco envia uma requisição ao provedor de pagamentos, criando um link que os clientes podem acessar para efetuar o pagamento do valor configurado. Esse link pode incluir opções de forma de pagamento, parcelamento, assinatura ou boleto, e pode redirecionar automaticamente o cliente após a confirmação. **Método:** POST **Endpoint:** /v3/paymentLinks **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar links de pagamentos A ação "Listar links de pagamentos" permite ao usuário obter uma lista de links de pagamento criados pelo sistema externo. O usuário pode posicioná-la em um fluxo de trabalho no **Skyone Studio** para buscar rapidamente todos os links disponíveis, filtrando por status (ativo ou inativo), por nome ou por referência externa gerada pelo seu próprio sistema. **Método:** GET **Endpoint:** /v3/paymentLinks **Parâmetros:** \| Parâmetro | Obrigatório | Tipo | Exemplo | Descrição | | :--- | :--- | :--- | :--- | :--- | | offset | X | string | 0 | Define o indice inicial da lista de resultados retornados na consulta. | | limit | X | string | 10 | Determina a quantidade de links de pagamento retornados na resposta, podendo chegar a 100. | | active | X | string | example | Filtra a lista para exibir apenas links de pagamento que estão ativos ou inativos. | | includeDeleted | X | string | example | Define se links de pagamento que foram marcados como excluídos devem ser incluidos na lista retornada. | | name | X | string | example | Filtra os links de pagamento retornados pelo nome informado. | | externalReference | X | string | example | Filtra os links de pagamento pelo identificador próprio do seu sistema. |
Atualizar um link de pagamentos A operação "Atualizar um link de pagamentos" faz uma solicitação para o sistema externo, permitindo que um link de pagamento previamente criado seja modificado. Ao fornecer o identificador único do link e um conjunto de parâmetros de configuração, a operação garante que o link reflita as condições desejadas no momento da atualização. **Método:** PUT **Endpoint:** /v3/paymentLinks/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único do link de

pagamento que será atualizado.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar um único link de pagamentos A operação recupera os detalhes de um link de pagamento único a partir do Asaas, trazendo todas as informações cadastradas naquele link, como valor, status e data de criação. No **Skyone Studio**, ao usar a operação, informando o ID, conecta-o a outros passos da automação. **Método:** GET **Endpoint:** /v3/paymentLinks/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único do link de

pagamentos a ser recuperado.

Remover um link de pagamentos Quando acionado, a operação no **Skyone Studio** envia uma requisição DELETE para a API externa, direcionando ao link de pagamento cujo ID foi informado. O resultado é a exclusão do link existente. **Método:** DELETE **Endpoint:** /v3/paymentLinks/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único do link de

pagamentos a ser excluído.

Restaurar um link de pagamentos A ação "Restaurar um link de pagamentos" reinicia um link de pagamento que havia sido desativado ou excluído no sistema externo. Ao ser acionado, o **Skyone Studio** envia uma requisição POST para a API do Asaas, retornando um status de sucesso quando o link é restaurado. **Método:** POST **Endpoint:** /v3/paymentLinks/{id}/restore **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único do link de

pagamentos a ser restaurado.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Adicionar uma imagem a um link de pagamentos Esta ação permite que o **Skyone Studio** adicione ou altere a imagem principal de um link de pagamento no Asaas. Ao usar esta operação e inserir o identificador do link, o processo envia a imagem selecionada para o sistema externo. Cada link pode conter até cinco imagens. **Método:** POST **Endpoint:** /v3/paymentLinks/{id}/images **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único do seu link de

pagamentos.

Listar imagens de um link de pagamentos A operação, ao ser configurada no **Skyone Studio**, envia uma requisição para o Asaas solicitando as imagens associadas a um link de pagamento específico. No fluxo de integração, ele permite que o sistema externo obtenha rapidamente a lista de imagens vinculadas ao link. **Método:** GET **Endpoint:** /v3/paymentLinks/{id}/images **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único do link de

pagamento do Asaas; indica qual link

tem suas imagens solicitadas.

Recuperar uma única imagem do link de pagamentos Esta operação permite buscar a imagem associada a um link de pagamento no sistema externo. Ao ser acionado, o **Skyone Studio** chama a API da Asaas, entregando o identificador do link e o identificador da imagem. **Método:** GET **Endpoint:** /v3/paymentLinks/{paymentLinkId}/images/{imageId} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
paymentLinkIdstringsimexample

Identifica exclusivamente o link de

pagamento do qual você deseja

recuperar a imagem.

imageIdstringsimexample

Identifica a imagem específica de um

link de pagamento que será

recuperada.

Remover uma imagem do link de pagamentos A operação remove uma imagem vinculada a um link de pagamento na plataforma Asaas. Quando o usuário configura este componente no **Skyone Studio**, a aplicação faz uma requisição DELETE ao endpoint correspondente. **Método:** DELETE **Endpoint:** /v3/paymentLinks/{paymentLinkId}/images/{imageId} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
imageIdstringsimexample

Identificador da imagem que será

excluída do link de pagamentos.

paymentLinkIdstringsimexample

Identifica o link de pagamentos do

qual a imagem deve ser removida.

Definir imagem principal do link de pagamentos Esta operação permite que você atribua uma imagem específica como a principal de um link de pagamentos no Asaas. A ação atualiza o registro no sistema externo, garantindo que, quando o cliente acessar o link, essa imagem seja exibida como referência visual principal. **Método:** PUT **Endpoint:** /v3/paymentLinks/{paymentLinkId}/images/{imageId}/setAsMain **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
paymentLinkIdstringsimexample

Identifica de forma única o link de

pagamentos ao qual será atribuída a

imagem principal.

imageIdstringsimexample

Identificador único da imagem que

será definida como principal no link

de pagamentos.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### Transferências O fluxo de Transferências da Asaas permite que você mova valores entre contas internas do Asaas, bancos externos ou chaves Pix, facilitando a liquidação de recursos dentro dos seus processos de integração. Com ele, é possível enviar dinheiro para wallets de sub- ou conta raiz, para contas bancárias de qualquer instituição ou para chaves Pix de tipos diversos (CPF, CNPJ, e-mail, telefone ou EVP). Além da transferência única, o processo suporta envios recorrentes por Pix, permitindo configurar frequência, quantidade e data de agendamento. O módulo também oferece a capacidade de consultar o histórico de transferências, filtrando por datas de criação ou de efetivação e por tipo, além de recuperar detalhes de uma transação específica. Por fim, pode-se cancelar transferências pendentes antes que sejam efetivadas, garantindo controle total sobre os fluxos de caixa gerenciados pelo Skyone Studio. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Transferir para conta de outra Instituição ou chave Pix Esta ação envia um valor a ser debitado da conta do Asaas e creditado em outra instituição bancária ou em uma chave Pix. Ela permite transferências instantâneas ou agendadas e, quando usada com Pix, pode configurar-se para recorrência mensal ou trimestral. No fluxo de integração, ao usar a operação "Transferir para conta de outra Instituição ou chave Pix", o usuário preenche os dados do destinatário e define se a transferência será imediata ou programada. **Método:** POST **Endpoint:** /v3/transfers **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar transferências Ao usar a operação ""Listar transferências no **Skyone Studio**, o fluxo faz uma solicitação ao sistema externo para buscar uma lista paginada de transferências. O objetivo é obter os registros de transferências que atendem aos critérios desejados, como data de criação, data de efetivação e tipo, permitindo que o processo de integração continue com esses dados para geração de relatórios, atualizações de status ou integração com outros sistemas. **Método:** GET **Endpoint:** /v3/transfers **Parâmetros:** | dateCreated\[ge] | não | string | example |

Filtra as transferências listadas para incluir apenas aquelas cuja data de criação seja maior ou igual à data informada.

| | :---------------: | :-: | :----: | :-----------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | dateCreated\[le] | não | string | example |

Filtra as transferências criadas até a data especificada.

| | transferDate\[ge] | não | string | example |

Filtra as transferências para que a data de efetivação seja igual ou posterior à data informada.

| | transferDate\[le] | não | string | example |

Filtra registros por data final de efetivação da transferência.

| | type | não | string | ASAAS ACCOUNT |

Filtra transferências pelo tipo especificado.

|
Transferir para conta Asaas A operação "Transferir para conta Asaas" envia um valor do seu sistema para outra conta dentro da plataforma Asaas. No fluxo de integração, normalmente depois de registrar ou atualizar uma cobrança, você pode usar este passo para mover o saldo de uma carteira ou subconta para outra, garantindo que os valores estejam disponíveis na conta destino. Isso facilita o gerenciamento de recursos entre contas vinculadas (raiz-subconta ou sub-subconta) e mantém o fluxo de financiamento interno alinhado com os processos de pagamento. **Método:** POST **Endpoint:** /v3/transfers/ **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar uma única transferência Essa ação faz uma requisição para buscar os dados de uma transferência única, identificada pelo seu ID, no sistema externo. Utiliza-se quando é preciso exibir detalhes da transferência, validar seu status, ou continuar um fluxo de processamento que depende dessas informações. No **Skyone Studio**, basta usar esta operação, configurar o campo "ID" com o identificador da transferência e conectá-lo ao fluxo que deve usar os dados recuperados. **Método:** GET **Endpoint:** /v3/transfers/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Especifica a identificação única da

transferência que será recuperada.

Cancelar uma transferência Quando esta operação é ativada, o **Skyone Studio** envia uma solicitação ao sistema externo para encerrar uma transferência previamente criada. Ao fornecer o identificador único da transferência, o sistema tenta cancelar a movimentação de fundos agendada. Essa ação é normalmente utilizada em um fluxo de trabalho que envolve a criação de uma transferência, o monitoramento de seu status e, se necessário, a sua interrupção antes de ser processada. **Método:** DELETE **Endpoint:** /v3/transfers/{id}/cancel **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica de forma única a

recorrência que será cancelada.

### Antecipações A entidade de Antecipações integra o fluxo de financiamento de recebíveis, possibilitando que as integrações do Skyone Studio gerenciem todo o ciclo de antecipação de pagamentos. Por meio deste recurso, é possível solicitar a antecipação de uma ou múltiplas faturas, simular cenários de liquidação e avaliar as condições de crédito antes da confirmação. A plataforma oferece controle granulado sobre o status das antecipações, permitindo monitorar situações pendentes, autorizadas ou concluídas, e adaptar estratégias de fluxo de caixa conforme a necessidade de cada negócio. Além disso, a entidade contempla a configuração de antecipação automática para cartões de crédito e a consulta do limite disponível para antecipação tanto via cartão quanto boleto bancário. Em síntese, a entidade de Anticipações oferece integração completa para otimizar o capital de giro, reduzir riscos financeiros e automatizar processos de recebíveis, alinhando as políticas de crédito do cliente com a lógica de negócio interna. Para facilitar o planejamento financeiro, os fluxos de negócios podem incorporar validações de limite, histórico de pagamentos e condições de cobrança específicas de cada contrato, tudo sem a necessidade de manipulação direta de dados de API complexos, mantendo a simplicidade na construção de automações. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Recuperar uma única antecipação Ao usar esta operação no **Skyone Studio**, o fluxo de integração solicita ao Asaas o registro completo de uma antecipação específica, identificada pelo seu ID. A operação retorna todos os dados associados a essa antecipação, como valores, status, data prevista de liquidação e demais informações relevantes. Essas informações podem ser usadas para alimentar dashboards, atualizar bancos de dados internos, disparar notificações ou permitir que o usuário visualize ou faça alterações no processo de antecipação. Em um fluxo típico, o componente seria conectado após a criação da antecipação ou quando houver necessidade de verificar seu progresso, garantindo que o sistema interno esteja sempre sincronizado com os dados reais do Asaas. **Método:** GET **Endpoint:** /v3/anticipations/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica a antecipação que será

recuperada.

Solicitar antecipação A operação "Solicitar antecipação" envia uma requisição ao sistema externo para solicitar que um pagamento já registrado seja antecipado. A operação pode ser usada tanto para cobranças únicas quanto para parcelamentos; no caso de pagamento por cartão, pode antecipar o fluxo inteiro ou cada parcela separadamente, enquanto por boleto apenas cada parcela pode ser antecipada. A ação gera no fluxo de integração um pedido de liquidação mais cedo, permitindo que o dinheiro seja disponibilizado antes da data original de recebimento. O usuário posiciona este componente no **Skyone Studio** para integrar o processo de recebimento ao fluxo de fluxo de caixa, garantindo que o valor antecipado seja processado automaticamente pelo provedor de pagamento. **Método:** POST **Endpoint:** /v3/anticipations
Listar antecipações A ação "Listar antecipações" consulta o sistema externo para obter uma lista de antecipações de pagamento. Ela permite filtrar o resultado por status (ex.: PENDING), identificação de pagamento, parcela e também controlar a paginação, definindo a posição inicial e o número máximo de registros retornados. O objetivo principal é disponibilizar os registros que atendem a esses critérios, facilitando a recuperação de informações relevantes no fluxo de integração, por exemplo, para gerar relatórios, avaliar pendências ou integrar com processos de reconciliação. No **Skyone Studio**, o usuário ajusta apenas os campos de filtro desejados. Ao disparar a integração, o sistema fará a chamada GET em /v3/anticipations e retornará os dados filtrados. **Método:** GET **Endpoint:** /v3/anticipations **Parâmetros:** | offset | não | string | 0 | Define a posição inicial da lista paginada, determinando de qual registro a consulta deve começar. | | :---------: | :-: | :----: | :-----: | :------------------------------------------------------------------------------------------------: | | limit | não | string | 10 | Define o número máximo de registros retornados na resposta, com limite máximo de 100 itens. | | payment | não | string | example | Filtra antecipações associadas à cobrança especificada. | | installment | não | string | example | Filtra as antecipações por um determinado parcela. | | status | não | string | PENDING | Filtra as antecipações retornadas de acordo com o status especificado (ex.: PENDING). |
Simular antecipação Ao adicionar e configurar a operação Simular antecipação no **Skyone Studio**, o sistema faz uma chamada POST para a API "/v3/anticipations/simulate" do Asaas. Ele envia os identificadores do parcelamento e da cobrança que poderiam ser antecipados e recebe de volta as informações que estimam o valor líquido, taxas e datas previstas. **Método:** POST **Endpoint:** /v3/anticipations/simulate **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Atualizar status da antecipação automática A operação "Atualizar status da antecipação automática" permite que o usuário habilite ou desabilite a antecipação automática de pagamentos de cartão de crédito no sistema externo. Ele envia uma atualização de configuração que altera a regra de fluxo de caixa, definindo se os valores serão liberados automaticamente assim que o pagamento for processado. Em um fluxo de integração típico, a operação é adicionada no **Skyone Studio**, conectada ao evento que determina quando a política de antecipação deve ser ajustada (por exemplo, após aprovação de uma transação) e definido o valor desejado no corpo da requisição. Quando acionado, o **Skyone Studio** publica essa configuração para o endpoint, garantindo que o comportamento de antecipação fique alinhado com a lógica de negócio desejada. **Método:** PUT **Endpoint:** /v3/anticipations/configurations **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar status da antecipação automática Esta ação permite que o **Skyone Studio** acesse o serviço de antecipação de cartão do Asaas e retire o estado atual da configuração de antecipação automática. Quando configurado no fluxo, o componente faz uma requisição GET para "/v3/anticipations/configurations" e recebe um indicativo de se a antecipação automática está ativada ou desativada. Esse status pode ser usado em decisões de fluxo, como habilitar ou desabilitar etapas posteriores de cobrança automatizada. **Método:** GET **Endpoint:** /v3/anticipations/configurations
Recuperar limites de antecipações Essa operação envia uma solicitação ao serviço de antecipação para obter os limites atuais disponíveis para cartões de crédito e boletos bancários. É usada quando o fluxo precisa saber quanto valor pode ser antecipado antes de efetuar uma cobrança, permitindo que o processo de antecipação seja aprovado ou rejeitado com base nesses limites. Assim, o usuário configura essa ação no **Skyone Studio** como uma consulta que retorna os valores máximos que podem ser antecipados, facilitando a tomada de decisão no fluxo de pagamentos. **Método:** GET **Endpoint:** /v3/anticipations/limits
Cancelar antecipação Ao operação "Cancelar antecipação" é usado quando o processo precisa desfazer uma antecipação de recebível já criada no sistema externo. Ao usar este elemento no fluxo do **Skyone Studio**, ele executa um POST para o endpoint de cancelamento, enviando apenas o identificador da antecipação. O serviço externo então invalida o registro, revertendo qualquer liquidação ou bloqueio financeiro associado. Esta ação costuma ser inserida após a criação ou aprovação de uma antecipação, permitindo que o fluxo corrija ou cancele ocorrências inesperadas antes que os valores sejam efetivamente transferidos. **Método:** POST **Endpoint:** /v3/anticipations/{id}/cancel **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Especifica o identificador único da

antecipação que será cancelada pelo

endpoint.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### Negativações A entidade de Negativação de Pagamento (Dunning) no **Skyone Studio** permite que empresas integrem de forma automatizada todo o ciclo de cobrança de inadimplentes via API do Asaas. Com ela, é possível solicitar a aplicação de procedimentos de cobrança — como comunicação ao cliente, envio de documentação e notificação à instituição de crédito de maneira programática. As operações fornecem gestão completa: desde o disparo inicial, simulação de impactos, até a administração de pagamentos recebidos na renegociação e a possibilidade de alterar ou cancelar o procedimento quando permitido. Essa funcionalidade centraliza e acelera o tratamento de dívidas, reduz custos operacionais e melhora a experiência do cliente, proporcionando visibilidade em tempo real sobre o estado de cada cobrança. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Criar uma negativação A operação "Criar uma negativação" envia uma solicitação ao Asaas para iniciar o processo de dunning a cobrança de um pagamento atrasado ou em débito. Quando você usar essa operação no **Skyone Studio** e a conecta ao fluxo de negócios, ela registra no Asaas que o pagamento deve ser tratado como negativo. Esse passo costuma ser usado após um cliente não pagar dentro do prazo, permitindo que o sistema externo envie notificações de cobrança ou aplique juros automaticamente. **Método:** POST **Endpoint:** /v3/paymentDunnings
Listar negativação A operação "Listar negativações" faz uma consulta ao sistema externo para obter a lista de negativações de pagamentos. Ele permite filtrar os registros por status, tipo, cobrança específica e intervalo de data, e suporta paginação com offset e limite. Essa etapa é usada normalmente no início de um fluxo de integração que precisa examinar quais pagamentos foram negados ou estão pendentes, permitindo que as etapas seguintes processem, exibam ou tomem ações sobre esses dados. O usuário adiciona esta operação em um fluxo de integração e ajusta os filtros, e o **Skyone Studio** cuida de enviar a requisição e receber a lista de negativações. **Método:** GET **Endpoint:** /v3/paymentDunnings **Parâmetros:** | offset | não | string | 0 |

Controla a posição inicial da página de resultados; indica a partir de qual registro a lista deve começar.

| | :--------------: | :-: | :----: | :-----------: | :------------------------------------------------------------------------------------------------------------------------------------------------------: | | limit | não | string | 10 |

Define o número máximo de negativas retornadas na consulta, com limite superior de 100.

| | status | não | string | PENDING |

Filtra as negativas de pagamento exibidas na listagem de acordo com o status.

| | type | não | string | CREDIT BUREAU |

Filtra a listagem de negativas de cobrança pelo tipo especificado, como CREDIT\_BUREAU.

| | payment | não | string | example |

Filtra negativações associadas a uma cobrança específica.

| | requestStartDate | não | string | example |

Filtra os resultados a partir da data de solicitação inicial.

| | requestEndDate | não | string | example |

Filtra negativizações cujo dia de solicitação não ultrapasse a data de término especificada.

|
Simular uma negativação Ao usar em um fluxo, a operação “Simular uma negativação” instruirá o Asaas a executar uma simulação da ação de negativar um pagamento. Ela solicita apenas os dados de cobrança e retorna se a negativação seria aceita ou rejeitada, permitindo ao integrador verificar o comportamento do sistema externo antes de disparar um evento real. No processo típico de cobrança, essa etapa vem antes de enviar a negativação definitiva. Assim você pode validar regras de negócio, confirmar que o cliente e o pagamento existem e que o resultado esperado corresponde ao que sua aplicação espera. Em caso de sucesso, o retorno indica que a operação de negativação pode ser realizada com segurança, enquanto falhas no teste alertam para ajustes nos dados ou na configuração da conta. Dessa forma, o componente oferece um ponto de teste no pipeline, garantindo que a lógica de cobrança real ocorra somente quando tudo esteja correto. **Método:** POST **Endpoint:** /v3/paymentDunnings/simulate **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
paymentstringnãopay_080225913252

Identificador único da cobrança que

será usada para simular uma

negativação.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar uma única negativação A ação “Recuperar uma única negativação” permite que o **Skyone Studio** busque no Asaas o registro de um pagamento que já foi negativado. Ao colocar esse bloco em um fluxo, você solicita ao sistema externo a informação completa da negativação (data, motivo, valores, etc.). O objetivo é ter acesso a esses dados de forma simples dentro da integração, possibilitando decisões baseadas na situação do pagamento, como gerar relatórios, disparar notificações ou atualizar bancos de dados internos. Essa etapa costuma ser usada em pipelines de reconciliação financeira ou automação de processos de cobrança, onde o status da negativação precisa ser confirmado antes de prosseguir com outros serviços. **Método:** GET **Endpoint:** /v3/paymentDunnings/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Especifica o identificador único da

negativação de pagamento que será

recuperada.

Listar histórico de eventos Ação que traz o histórico de eventos associados a uma cobrança negativa, permitindo ver, em ordem cronológica, todas as ocorrências desde o início da negativação. Essa consulta integra o seu fluxo ao sistema externo, possibilitando monitorar o progresso ou status das etapas de cobrança, como aprovações, reprovações ou pagamentos. No **Skyone Studio**, o usuário adiciona a operação no fluxo, conecta o campo de identificação da negativação e define opcionalmente controle de paginação, alimentando os dados de eventos para decisões posteriores, relatórios ou notificações. **Método:** GET **Endpoint:** /v3/paymentDunnings/{id}/history **Parâmetros:** | offset | não | string | 0 |

Define o índice do primeiro item a ser retornado na lista paginada.

| | ------ | --- | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------- | | limit | não | string | 10 |

Define o número máximo de eventos que será retornado na lista paginada.

| | id | sim | string | example |

Identificador único que aponta a negativação de pagamento a ser consultada.

|
Listar pagamentos recebidos A operação “Listar pagamentos recebidos” busca no sistema externo a coleção de pagamentos que já foram devidamente recebidos dentro de uma renegociação de dívida. Quando usada no **Skyone Studio**, ela permite que o fluxo extraia esses registros para alimentar processos internos, como atualização de saldos, geração de relatórios de pagamento ou ativação de etapas de fechamento de crédito. Esse passo costuma ocorrer logo após a criação ou identificação de uma renegociação, servindo como base para análises, validações e decisões que dependem dos valores já creditados ao cliente. **Método:** GET **Endpoint:** /v3/paymentDunnings/{id}/partialPayments **Parâmetros:** | offset | não | string | 0 |

Define o índice inicial da lista de resultados paginada.

| | :----: | :-: | :----: | ------- | :-----------------------------------------------------------------------------------------------------------------------------: | | limit | não | string | 10 |

Define o número máximo de pagamentos a serem retornados na página atual da lista.

| | id | sim | string | example |

Identifica a renegociação da dívida cujo pagamentos serão listados.

|
Listar cobranças disponíveis para negativação Este componente solicita da API externa a lista de cobranças que estão prontas para serem enviadas à negativação, incluindo uma simulação de valores. A operação retorna os registros que atendem aos critérios de elegibilidade para dunning, permitindo ao fluxo saber quais parcelas podem ser encaminhadas ao processo de cobrança automática. Dentro do **Skyone Studio**, o usuário adiciona a operação “Listar cobranças disponíveis para negativação” no fluxo, e ela atua como ponto de partida para etapas seguintes, como filtrar os resultados, selecionar pagamentos e disparar a ação de negativação ou enviar dados a outro sistema. Assim, a ação ajuda a integrar a verificação de status de cobrança ao processo automatizado de cobrança e gestão de inadimplência. **Método:** GET **Endpoint:** /v3/paymentDunnings/paymentsAvailableForDunning **Parâmetros:** | offset | não | string | 0 |

Define o ponto inicial da lista de resultados, especificando a partir de qual registro a paginação deve começar.

| | :----: | :-: | :----: | :-: | :------------------------------------------------------------------------------------------------------------------------------------------------------------: | | limit | não | string | 10 |

Define quantos registros são retornados na lista de cobranças disponíveis para negativação na chamada.

|
Reenviar documentos O **Skyone Studio** permite reintegrar a documentação de uma negativação. Quando acionado, o componente faz o envio de arquivos de apoio – nota fiscal, contrato firmado – para o registro de negativação indicado. Se a documentação for aceita, o status da negativação volta a “Awaiting Approval”, permitindo que a cobrança continue no pipeline de cobrança ou de cobrança de dívida. Esse passo costuma ser inserido depois de verificar se o campo “isNecessaryResendDocumentation” indica que o reenvio é necessário, e antes de avançar para a próxima etapa de aprovação ou cobrança. **Método:** POST **Endpoint:** /v3/paymentDunnings/{id}/documents **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Especifica a negativa cujo reenvio de

documentos será efetuado.

Cancelar negativação Ao usar a operação “Cancelar negativação” no **Skyone Studio**, a aplicação enviará uma solicitação ao sistema externo para reverter uma cobrança marcada como negativação. Isso é útil quando após a geração de uma negativação ainda se tem a possibilidade de cancelá‑la (verificada pela propriedade canBeCancelled). O processo deixa a negativação em estado de “Awaiting Cancellation” e, quando concluído, passa a “Cancelled”. A ação serve como etapa de reversão dentro de um fluxo de pagamento, permitindo que as integrações de cobrança se ajustem a mudanças de política ou erros antes que a negativação seja finalizada. **Método:** POST **Endpoint:** /v3/paymentDunnings/{id}/cancel **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único da negativação a

ser cancelada.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### Pagamentos de contas A entidade de Pagamento de Contas permite que os fluxos de integração do **Skyone Studio** gerenciem completamente os pagamentos de faturas e boletos dentro do sistema externo. Com ela, seus processos de negócio podem criar novos pagamentos a partir da linha digitável do boleto, agendar datas de pagamento de acordo com datas úteis ou de vencimento, e monitorar o status do pagamento (pendente, pago, cancelado, reembolsado, em processamento bancário ou falho). A entidade oferece também a capacidade de simular a execução de um pagamento antes de efetuar o lançamento real, permitindo validar regras de negócio e descontos. Além disso, os fluxos podem recuperar detalhes de um pagamento específico, listar históricos pagáveis e cancelar transações que ainda não foram concluídas, respeitando as restrições de cancelamento definidas pelo provedor. Em resumo, a entidade de Pagamento de Contas centraliza todas as operações de cobrança e controle financeiro de faturas, simplificando a automação e o monitoramento de cada etapa do ciclo de pagamento dentro dos seus sistemas de integração. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Criar um pagamento de conta Ao usar a operação “Cancelar negativação” no **Skyone Studio**, a aplicação enviará uma solicitação ao sistema externo para reverter uma cobrança marcada como negativação. Isso é útil quando após a geração de uma negativação ainda se tem a possibilidade de cancelá‑la (verificada pela propriedade canBeCancelled). O processo deixa a negativação em estado de “Awaiting Cancellation” e, quando concluído, passa a “Cancelled”. A ação serve como etapa de reversão dentro de um fluxo de pagamento, permitindo que as integrações de cobrança se ajustem a mudanças de política ou erros antes que a negativação seja finalizada. **Método:** POST **Endpoint:** /v3/bill **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar pagamento de contas Esta operação permite que o **Skyone Studio** recupere uma lista de pagamentos de contas cadastrados no sistema externo. Quando acionada, o componente envia uma consulta ao endpoint do provedor para obter todos os registros de pagamento, possibilitando ao usuário integrar esses dados em processos de sincronização, relatórios de fluxo de caixa ou comparações de status com outras plataformas. No fluxo típico, o usuário utiliza entradas como offset e limite para controlar a página de resultados, e utiliza a saída para alimentar rotinas internas de análise, exportação ou trigger de eventuais ações de cobrança.. **Método:** GET **Endpoint:** /v3/bill **Parâmetros:** | offset | ❌ | string | 0 |

Define o índice inicial da lista de registros retornados pela consulta.

| | :----: | :-: | :----: | :-: | :-------------------------------------------------------------------------------------------------------------------: | | limit | ❌ | string | 10 |

Define quantos registros da lista devem ser retornados na chamada.

|
Simular um pagamento de conta Ao utilizar a operação “Simular um pagamento de conta” no seu fluxo de integração no **Skyone Studio**, o sistema envia uma requisição ao endpoint de simulação da API do Asaas. A ação permite que você verifique se os dados de uma conta (por exemplo, o boleto) são válidos e se o pagamento poderia ser processado sem realmente efetivar a transação. Essa verificação costuma ser usada em etapas de validação antes de emitir um pagamento real. **Método:** POST **Endpoint:** v3/bill/simulate **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar um único pagamento de conta Essa operação permite que o **Skyone Studio** busque no sistema externo o detalhe de um pagamento de conta específico. Quando o usuário adiciona essa ação ao seu fluxo, ele informa apenas que o pagamento desejado será recuperado pelo seu identificador único. O resultado traz todas as informações associadas ao pagamento, permitindo que o fluxo continue com validações ou disparo de novas ações baseando‑se nesses dados. Assim, a ação é usada principalmente para obter o status e os dados de um pagamento que já foi criado em outra etapa, integrando o sistema externo ao resto do processo de negócio. **Método:** GET **Endpoint:** /v3/bill/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Usado para indicar qual pagamento

de conta será recuperado na

requisição.

Cancelar pagamento de contas A operação “Cancelar pagamento de contas” permite ao sistema externo interromper o processamento de um pagamento de conta, caso o status do pagamento seja anulável. Ela é empregada em fluxos de negócio quando, após uma verificação de condições ou políticas internas, é necessário impedir que o valor seja debitado. No **Skyone Studio,** após a adição, o componente deve ser configurado com os dados necessários para identificar a transação a ser cancelada. Após a execução, a conta permanece sem pagamento, garantindo que recursos não sejam cobrados indevidamente. **Método:** POST **Endpoint:** /v3/bill/{id}/cancel **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica o pagamento de conta que

será cancelado.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### Recargas de celular A entidade Recarga de Telefone Móvel do Asaas integra‑se ao **Skyone Studio** permitindo que os fluxos de negócio façam a ativação de créditos pré‑pagos, verifiquem saldos restantes, controlem o histórico de recargas e revertam transações quando necessário. No contexto de marketing e fidelização de clientes, a entidade possibilita o gerenciamento completo da compra de créditos para números de celular, incluindo variação na operadora e nos valores disponíveis. Para atender a demandas de suporte ao cliente e auditoria, é possível recuperar detalhes de uma recarga específica, observar a lista de transações realizadas ou cancelar uma operação que ainda não foi liquidada. Ao consolidar esses recursos, os processos de cobrança, promoções e emissão de vouchers tornam‑se automatizados. O objetivo central é disponibilizar uma plataforma confiável para que equipes de vendas, atendimento e TI possam gerenciar e controlar recargas de telefonia móvel de forma integrada e eficaz. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Solicitar recarga O componente Solicitar recarga envia ao sistema externo uma solicitação de recarga de celular. Ao ser usado no **Skyone Studio**, ele dispara um POST para a API de recargas, enviando a quantidade desejada e o número de telefone. Em um fluxo de integração típico, essa ação é usada após o usuário indicar a necessidade de adicionar créditos ao celular, permitindo que a plataforma conecte o pedido de recarga à fatura ou ao processo de pagamento já existente. Assim, o **Skyone Studio** gerencia a autorização e a confirmação automática junto ao provedor. **Método:** POST **Endpoint:** /v3/mobilePhoneRecharges **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar recargas de celular No **Skyone Studio**, basta usar a operação “Listar recargas de celular” no fluxo. Quando executado, ele faz uma chamada ao Asaas para buscar todas as recargas de celular que já foram registradas. O serviço devolve a lista, normalmente paginada, contendo cada transação de carga. Essa ação é usada como etapa de extração de dados para exibir o histórico em dashboards ou atualizar registros internos. **Método:** GET **Endpoint:** /v3/mobilePhoneRecharges **Parâmetros:** | offset | não | string | 0 |

Especifica o índice do primeiro item a ser retornado na lista paginada de recargas.

| | :----: | :-: | :----: | :-: | :------------------------------------------------------------------------------------------------------------------------------------------------: | | limit | não | string | 10 |

Define o número máximo de recargas que serão retornadas na resposta, podendo chegar a até 100 itens.

|
Recuperar uma única recarga de celular A operação “Recuperar uma única recarga de celular” faz uma consulta ao sistema externo Asaas para obter os detalhes de uma recarga específica de telefone celular. Ele envia uma requisição GET com o identificador da recarga e devolve informações como número, valor, status e data. Essa chamada é tipicamente usada em fluxos de integração nos quais, após registrar ou aprovar uma recarga, o sistema precisa verificar o resultado real, atualizar registros internos ou exibir o status ao usuário. Assim, **Skyone Studio** fornece uma forma prática de buscar o histórico de uma recarga já iniciada, garantindo que os dados estejam sincronizados entre os sistemas envolvidos. **Método:** GET **Endpoint:** /v3/mobilePhoneRecharges/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Usado para identificar a recarga

específica de celular que será

recuperada.

Cancelar uma recarga de celular O componente dispara uma chamada ao Asaas para cancelar uma recarga de celular que já foi registrada. Ao acioná‑lo, a operação envia apenas o identificador da recarga, e o serviço impede que o valor seja debitado, desativando a transação. Esse passo é habitualmente usado quando o cliente muda de número ou decide revogar a operação antes do seu processamento, integrando‑se de forma eficiente ao fluxo de controle de pagamentos e recargas. **Método:** POST **Endpoint:** /v3/mobilePhoneRecharges/{id}/cancel **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identificador único da recarga de

celular que será cancelada.

bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Buscar qual provedor o número pertence e os valores disponíveis para recarga O componente consulta ao sistema externo qual provedor de telefonia móvel pertence a um número informado e quais valores de recarga estão disponíveis para ele. Esta ação permite ao usuário saber, antes de executar uma recarga, quais são as opções de valor e de operadora. No **Skyone Studio**, basta adicionar esta operação e configurar o número de celular. **Método:** GET **Endpoint:** /v3/mobilePhoneRecharges/{phoneNumber}/provider **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
phoneNumberstringsimexample

Número do celular que será

pesquisado para identificar o

provedor e os valores disponíveis

para recarga.

### Consulta Serasa A entidade Relatório de Crédito (Credit Bureau Report) representa o conjunto de informações consolidadas sobre o histórico de solvência e comportamento financeiro de clientes, disponibilizadas pelo sistema externo via consultas de bureau. Utilizando a API do Skyone Studio, os fluxos de integração podem solicitar a geração de um relatório completo a partir de CPF/CNPJ, consultar um histórico filtrado por data e paginação e recuperar um relatório já gerado mediante seu identificador único. Essas funcionalidades permitem que as empresas verifiquem, em tempo real, a credibilidade de potenciais clientes, reduzindo riscos de inadimplência e otimizando decisões de crédito, cobranças e relacionamento comercial. O processo de consulta gera um registro que persiste na base de dados externa; as listagens paginadas facilitam a auditoria e o acompanhamento das atividades realizadas, enquanto a recuperação específica garante acesso detalhado a qualquer relatório já obtido. Ao integrar essas operações no **Skyone Studio**, você pode criar workflows que, por exemplo, bloqueiam ou aprovam um pedido de serviço automaticamente com base no score de risco retornado, ou atualizar o cadastro do cliente com o relatório mais recente, tudo de forma automatizada e segura. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Realizar consulta A operação “Realizar consulta” faz uma chamada ao sistema externo Asaas para buscar o relatório de crédito de bureau de um cliente, fornecendo apenas o identificador do cliente no Asaas ou o CPF/CNPJ quando o cliente não estiver registrado. Essa ação permite que, dentro do fluxo no **Skyone Studio**, o usuário integre o fluxo de verificação de crédito direto no processo, trazendo dados atualizados à aplicação. Ao ser acionada, a ferramenta envia a requisição, recebe o relatório e disponibiliza‑o para validações, decisões de crédito ou outras etapas de processamento em cascata. **Método:** POST **Endpoint:** /v3/creditBureauReport **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Listar consulta O componente “Listar consultas” solicita ao sistema externo uma lista de relatórios de crédito, permitindo filtrar os resultados por intervalo de datas e dividir a resposta em páginas. Isso devolve os registros de crédito relevantes, organizados conforme o pedido de deslocamento e limite indicados. No Skyone Studio, um usuário pode arrastar essa ação para um fluxo de integração como parte de um processo de auditoria ou validação de crédito. **Método:** GET **Endpoint:** /v3/creditBureauReport **Parâmetros:** | offset | não | string | 0 | Serve para especificar o índice inicial dos registros retornados na consulta paginada. | | :-------: | :-: | :----: | :-----: | :--------------------------------------------------------------------------------------: | | limit | não | string | 10 | Define quantos registros a resposta deve conter, limitando até 100 itens por requisição. | | startDate | não | string | example | Filtra as consultas a partir da data especificada. | | endDate | não | string | example | Filtra os registros até a data de criação especificada. |
Recuperar uma consulta Esta ação recupera o relatório de crédito de um cliente utilizando o identificador da consulta. No **Skyone Studio**, basta arrastar esse componente para onde precisar obter o documento definitivo depois de ter criado a solicitação anterior. Ao acioná‑la, o **Skyone Studio** faz a chamada GET ao serviço externo e recebe o relatório completo, que pode ser usado em etapas posteriores do fluxo de integração, como exportação, armazenamento ou exibição para o usuário. **Método:** GET **Endpoint:** /v3/creditBureauReport/{id} **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
idstringsimexample

Identifica a consulta de relatório de

crédito a ser recuperada.

### Extrato A entidade Financeiro permite que os fluxos de integração do **Skyone Studio** tenham acesso completo à movimentação financeira da conta Asaas. Por meio dos recursos expostos, é possível consultar o extrato de transações dentro de periodos cronológicos selecionados, filtrando e ordenando os registros conforme a necessidade. O mesmo conjunto de serviços oferece a verificação do saldo disponível, permitindo que processos de automação tomem decisões baseadas no estado financeiro da conta. Os tipos de transações abrangem desde pagamentos, recargas de cartão, transferências bancárias e Pix, até taxas, estornos, bloqueios e créditos. Assim, os usuários podem integrar ações que envolvem pagamentos, cobrança, anticipo de recebíveis, transferências para contas externas e muito mais, mantendo a conformidade e a transparência de todas as movimentações dentro do ecossistema Asaas. A entidade funciona como ponto único para gerenciar e rastrear toda a atividade financeiramente relevante em um fluxo de integração coeso e seguro. A seguir, conheça a operasção disponível. Para mais detalhes, clique na seta:
Recuperar extrato A operação “Recuperar extrato” faz uma consulta no sistema externo para trazer a lista de movimentações financeiras que ocorreram dentro de um período definido. Ela permite paginar os resultados e ordenar a lista, tornando possível adquirir grandes volumes de dados financeiros de forma controlada. No **Skyone Studio,** o usuário pode usar esta operação, configurando as datas e, opcionalmente, limite e ordenação, e conectá‑lo a próximos passos como transformações, filtros ou carregamento em um data warehouse. Assim, a ação serve como fonte inicial no fluxo de integração, trazendo o histórico de transações que será processado ou analisado em etapas subsequentes. **Método:** GET **Endpoint:** /v3/financialTransactions **Parâmetros:** | offset | não | string | 0 | Define a posição inicial (em índice zero‑base) da lista de resultados, permitindo a paginação das entradas retornadas. | | :--------: | :-: | :----: | :--------: | :--------------------------------------------------------------------------------------------------------------------: | | limit | não | string | 10 | Controla o número máximo de itens retornados na consulta, com limite superior de 100 por página. | | startDate | não | string | 2023-03-01 | Filtra as transações financeiras a partir da data especificada. | | finishDate | não | string | 2023-03-31 | Filtra os registros de transações financeiras até a data de término especificada. | | order | não | string | asc | Define a direção (asc ou desc) da ordenação dos resultados da consulta. |
### Informações financeiras A entidade Financeiro permite que os fluxos de integração do **Skyone Studio** tenham acesso abrangente às informações financeiras da sua conta Asaas. Ela oferece funcionalidades cruciais para monitoramento e análise de caixa: * **Saldo da conta:** obtenção rápida do valor disponível no momento. * **Estatísticas de cobranças:** visualização agregada de recebíveis por cliente, forma de pagamento, status (CONFIRMED, PENDING, RECEIVED, OVERDUE), data de criação, vencimento e crédito estimado, além de identificação externa. * **Valores de split:** consulta dos montantes distribuídos entre responsáveis ou estruturas internas. Com essas capacidades, é possível integrar dados de fluxo de caixa a relatórios, dashboards ou processos que precisam avaliar o desempenho financeiro, identificar recebíveis pendentes ou antecipados, comparar diferentes meios de pagamento e garantir maior visibilidade sobre a liquidez da empresa. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Recuperar saldo da conta Essa ação permite que o **Skyone Studio** consulte o saldo atual da conta autenticada no sistema externo. Quando acionada, ela faz uma requisição de busca (GET) ao endpoint de saldo do API, obtendo o valor disponível na conta. Essa consulta pode ser usada como parte de um fluxo de verificação de recursos, permitindo que o usuário tome decisões automatizadas—por exemplo, disparar alertas, iniciar transferências ou atualizar relatórios—com base no saldo disponível. A operação é arrastada do painel de integração e configurada como uma etapa de leitura, sem necessidade de dados de entrada, retornando apenas o saldo no formato JSON. **Método:** GET **Endpoint:** /v3/finance/balance
Estatísticas de cobranças A operação “Estatísticas de cobranças” obtém do Asaas valores agregados sobre as cobranças do seu negócio. Ao configurá-la no **Skyone Studio**, basta selecionar os filtros desejados (cliente, tipo de pagamento, status, datas, etc.) e o componente faz uma requisição ao API do Asaas para retornar totais como: valor a receber, valor recebido, total por método de pagamento, entre outros. Essa ação é usada tipicamente em fluxos de integração que geram relatórios financeiros, atualizam dashboards ou desencadeiam procedimentos baseados no status e no montante das cobranças em sua conta. **Método:** GET **Endpoint:** /v3/finance/payment/statistics **Parâmetros:** | customer | não | string | cus\_3EZfkUThUMAt | Filtra registros do cliente com identificador único. | | :----------------------: | :-: | :----: | :---------------: | :-----------------------------------------------------------------------------------------: | | billingType | não | string | BOLETO | Defina o método de pagamento a ser considerado (BOLETO, CREDIT\_CARD, etc.). | | status | não | string | CONFIRMED | Filtra as cobranças por status atual (CONFIRMED, PENDING ou RECEIVED). | | anticipated | não | string | false | Define se a consulta retornará cobranças que foram antecipadas ou não. | | dateCreated\[ge] | não | string | 2023-01-01 | Filtra os registros cuja data de criação é igual ou posterior à data informada. | | dateCreated\[le] | não | string | 2023-01-01 | Limita os resultados aos registros criados até a data indicada. | | dueDate\[ge] | não | string | 2023-01-01 | Filtra os registros cujo vencimento seja igual ou posterior à data informada. | | dueDate\[le] | não | string | 2023-01-01 | Filtra registros com data de vencimento menor ou igual ao valor informado. | | estimatedCreditDate\[ge] | não | string | 2023-01-01 | Filtra as cobranças cuja data estimada de crédito seja igual ou posterior à data informada. | | estimatedCreditDate\[le] | não | string | 2023-01-01 | Filtra registros cuja data estimada de crédito seja menor ou igual à data indicada. | | externalReference | não | string | 056984 | Filtra os registros de estatísticas pelo identificador único gerado pelo seu sistema. |
Recuperar valores de split Esta ação consulta a API do Asaas para obter os indicadores financeiros de splits de pagamento. Ao ser acionada no **Skyone Studio**, o componente faz uma chamada GET ao endpoint “/v3/finance/split/statistics” e recebe um conjunto de estatísticas em JSON, como valores totais, percentuais ou número de transações que passaram por splits. O objetivo é coletar esses dados para serem exibidos em relatórios, usados em cálculos adicionais ou alimentados em outros passos da integração, permitindo ao usuário acompanhar de maneira transparente o desempenho e a distribuição de valores pagos em suas operações. **Método:** GET **Endpoint:** /v3/finance/split/statistics
### Informações e personalização da conta A entidade Conta permite que os usuários de **Skyone Studio** gerenciem integralmente as informações e configurações associadas à sua conta no sistema externo. Através deste conjunto de funcionalidades, é possível consultar e atualizar os dados comerciais que definem a identidade jurídica, fiscal e de contato da empresa, além de controlar parâmetros de personalização de checkout, como cores, logotipos e layout. A Conta também oferece acesso a dados de identificação, como número de conta e ID de carteira (Wallet), possibilitando integrações de pagamento e relatórios financeiros. Por fim, a entidade oferece recursos de administração da própria conta, como a exclusão de subcontas White‑Label, permitindo a manutenção de um controle refinado dos ambientes de cliente. A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Recuperar dados comerciais Ao usar a operação “Recuperar dados comerciais” no seu fluxo do Skyone Studio, a ferramenta enviará uma requisição GET ao endpoint / v3 / myAccount / commercialInfo/ do provedor externo, incluindo o cabeçalho Accept: application/json. O serviço retira do provedor todas as informações comerciais relacionadas à conta autenticada, como nome da empresa, endereço fiscal, número de identificação e dados de contato. Esses dados costumam ser usados mais adiante no fluxo para preencher relatórios, validar registros de clientes ou configurar integrações de vendas. Assim, o componente funciona como uma etapa de leitura inicial que entrega o contexto comercial da conta para os processos seguintes do seu cenário de integração. **Método:** GET **Endpoint:** /v3/myAccount/commercialInfo/
Atualizar dados comerciais O **Skyone Studio** envia informações atualizadas sobre a pessoa ou empresa associada à conta, como tipo de pessoa, dados fiscais, endereço e faturamento mensal. Esses dados mantêm o registro da conta alinhado com as exigências regulatórias e podem disparar revisões de conformidade, garantindo que a conta permaneça validada e com acesso pleno às funcionalidades do sistema. Salvar personalização da fatura Um componente no Studio permite configurar a aparência da fatura exibida ao cliente, definindo cores e logo. Ao acionar a ação, o Skyone Studio envia a configuração ao gateway, que posteriormente aprova a personalização, permitindo que as próximas transações exibam a marca visível e alinhada com a identidade da empresa. Recuperar configurações de personalização Esta ação busca as configurações de exibição de fatura atualmente definidas na conta. O **Skyone Studio** utiliza o resultado para identificar se a personalização está ativada, quais cores e logo estão em uso, facilitando a lógica de exibição condicional em fluxos de checkout ou relatórios. **Método:** POST **Endpoint:** /v3/myAccount/commercialInfo/ **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Salvar personalização da fatura A operação “Realizar consulta” faz uma chamada ao sistema externo Asaas para buscar o relatório de crédito de bureau de um cliente, fornecendo apenas o identificador do cliente no Asaas ou o CPF/CNPJ quando o cliente não estiver registrado. Essa ação permite que, dentro do fluxo no **Skyone Studio**, o usuário integre o fluxo de verificação de crédito direto no processo, trazendo dados atualizados à aplicação. Ao ser acionada, a ferramenta envia a requisição, recebe o relatório e disponibiliza‑o para validações, decisões de crédito ou outras etapas de processamento em cascata. **Método:** POST **Endpoint:** /v3/creditBureauReport **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
Recuperar configurações de personalização A operação “Realizar consulta” faz uma chamada ao sistema externo Asaas para buscar o relatório de crédito de bureau de um cliente, fornecendo apenas o identificador do cliente no Asaas ou o CPF/CNPJ quando o cliente não estiver registrado. Essa ação permite que, dentro do fluxo no **Skyone Studio**, o usuário integre o fluxo de verificação de crédito direto no processo, trazendo dados atualizados à aplicação. Ao ser acionada, a ferramenta envia a requisição, recebe o relatório e disponibiliza‑o para validações, decisões de crédito ou outras etapas de processamento em cascata. **Método:** POST **Endpoint:** /v3/creditBureauReport **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
### Notas fiscais A entidade Financeiro permite que os fluxos de integração do **Skyone Studio** tenham Informações financeiras A seguir, conheça as operações disponíveis. Para mais detalhes de cada item, clique na seta:
Realizar consulta A operação “Realizar consulta” faz uma chamada ao sistema externo Asaas para buscar o relatório de crédito de bureau de um cliente, fornecendo apenas o identificador do cliente no Asaas ou o CPF/CNPJ quando o cliente não estiver registrado. Essa ação permite que, dentro do fluxo no **Skyone Studio**, o usuário integre o fluxo de verificação de crédito direto no processo, trazendo dados atualizados à aplicação. Ao ser acionada, a ferramenta envia a requisição, recebe o relatório e disponibiliza‑o para validações, decisões de crédito ou outras etapas de processamento em cascata. **Método:** POST **Endpoint:** /v3/creditBureauReport **Parâmetros:**
ParâmetroTipoObrigatórioExemploDescrição
bodyobjectsimPara parâmetros de configuração do corpo (JSON), acesse a documentação técnica.
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.skyone.cloud/skyone-studio/how-to/como-criar-modulo-conector-do-asaas.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.