Asaas

ACTIVEVersão 1.1.0Asaas

Gateway de pagamento brasileiro: cobranças (boleto, Pix, cartão), clientes, assinaturas e webhooks de pagamento. A chave de API é da própria conta do tenant.

Ver como JSON

Pré-requisitos

• uma conta ativa no Asaas;
• permissão no iBPMS para criar ou selecionar conexões;
• a chave de API da própria conta, copiada do painel.

asaas.json

{
  "schemaVersion": 1,
  "key": "asaas",
  "name": "Asaas",
  "description": "Gateway de pagamento brasileiro: cobranças (boleto, Pix, cartão), clientes, assinaturas e webhooks de pagamento. A chave de API é da própria conta do tenant.",
  "category": "brazil",
  "vendor": "Asaas",
  "version": "1.1.0",
  "status": "ACTIVE",
  "credentials": [
    {
      "type": "API_KEY",
      "secretLabel": "Chave de API",
      "secretPlaceholder": "Cole a chave de API da sua conta Asaas",
      "helpText": "No painel do Asaas, abra o menu do usuário > Integrações > Chave de API e copie a chave. Ela é enviada no header access_token de cada chamada.",
      "helpUrl": "https://www.asaas.com/customerApiAccessToken/index"
    }
  ],
  "actions": [
    {
      "key": "subscription.delete",
      "name": "Cancelar assinatura",
      "description": "Encerra a recorrência e remove as cobranças pendentes/vencidas ligadas a ela.",
      "inputs": [
        {
          "key": "id",
          "label": "Assinatura (id)",
          "type": "TEXT",
          "required": true
        }
      ],
      "outputs": [
        {
          "key": "deleted",
          "label": "Deleted",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "id",
          "label": "Id",
          "type": "OUTPUT",
          "required": false
        }
      ]
    },
    {
      "key": "payment.delete",
      "name": "Cancelar cobrança",
      "description": "Remove uma cobrança ainda não paga. Resposta: { deleted: true, id }.",
      "inputs": [
        {
          "key": "id",
          "label": "Cobrança (id)",
          "type": "TEXT",
          "required": true,
          "description": "Id da cobrança a remover."
        }
      ],
      "outputs": [
        {
          "key": "deleted",
          "label": "Deleted",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "id",
          "label": "Id",
          "type": "OUTPUT",
          "required": false
        }
      ]
    },
    {
      "key": "payment.get",
      "name": "Consultar cobrança",
      "description": "Recupera uma cobrança pelo id, com status atual e valores.",
      "inputs": [
        {
          "key": "id",
          "label": "Cobrança (id)",
          "type": "TEXT",
          "required": true,
          "description": "Id da cobrança Asaas, ex.: {{ cobranca.id }}"
        }
      ],
      "outputs": [
        {
          "key": "id",
          "label": "Id",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "status",
          "label": "Status",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "billingType",
          "label": "Billing Type",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "value",
          "label": "Value",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "netValue",
          "label": "Net Value",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "dueDate",
          "label": "Due Date",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "paymentDate",
          "label": "Payment Date",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "invoiceUrl",
          "label": "Invoice Url",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "bankSlipUrl",
          "label": "Bank Slip Url",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "customer",
          "label": "Customer",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "externalReference",
          "label": "External Reference",
          "type": "OUTPUT",
          "required": false
        }
      ]
    },
    {
      "key": "subscription.create",
      "name": "Criar assinatura",
      "description": "Cria uma cobrança recorrente. Obrigatórios: cliente, forma, valor, primeiro vencimento e ciclo.",
      "inputs": [
        {
          "key": "customer",
          "label": "Cliente (id)",
          "type": "TEXT",
          "required": true
        },
        {
          "key": "billingType",
          "label": "Forma de pagamento",
          "type": "SELECT",
          "required": true
        },
        {
          "key": "value",
          "label": "Valor por ciclo",
          "type": "NUMBER",
          "required": true
        },
        {
          "key": "nextDueDate",
          "label": "Primeiro vencimento",
          "type": "DATE",
          "required": true,
          "description": "Formato AAAA-MM-DD."
        },
        {
          "key": "cycle",
          "label": "Ciclo",
          "type": "SELECT",
          "required": true
        },
        {
          "key": "description",
          "label": "Descrição",
          "type": "TEXT",
          "required": false
        },
        {
          "key": "externalReference",
          "label": "Referência externa",
          "type": "TEXT",
          "required": false
        }
      ],
      "outputs": [
        {
          "key": "id",
          "label": "Id",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "status",
          "label": "Status",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "value",
          "label": "Value",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "cycle",
          "label": "Cycle",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "nextDueDate",
          "label": "Next Due Date",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "customer",
          "label": "Customer",
          "type": "OUTPUT",
          "required": false
        }
      ]
    },
    {
      "key": "customer.create",
      "name": "Criar cliente",
      "description": "Cadastra um cliente na conta Asaas. Obrigatórios: nome e CPF/CNPJ.",
      "inputs": [
        {
          "key": "name",
          "label": "Nome",
          "type": "TEXT",
          "required": true,
          "description": "Aceita expressões do processo, ex.: {{ solicitante.nome }}"
        },
        {
          "key": "cpfCnpj",
          "label": "CPF ou CNPJ",
          "type": "TEXT",
          "required": true,
          "description": "Com ou sem máscara."
        },
        {
          "key": "email",
          "label": "E-mail",
          "type": "TEXT",
          "required": false
        },
        {
          "key": "phone",
          "label": "Telefone fixo",
          "type": "TEXT",
          "required": false,
          "description": "Campo 'phone' da API — telefone fixo."
        },
        {
          "key": "mobilePhone",
          "label": "Celular",
          "type": "TEXT",
          "required": false,
          "description": "Campo 'mobilePhone' da API — celular."
        },
        {
          "key": "externalReference",
          "label": "Referência externa",
          "type": "TEXT",
          "required": false,
          "description": "Id do seu processo, para correlacionar depois."
        }
      ],
      "outputs": [
        {
          "key": "id",
          "label": "Id",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "name",
          "label": "Name",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "cpfCnpj",
          "label": "Cpf Cnpj",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "email",
          "label": "Email",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "dateCreated",
          "label": "Date Created",
          "type": "OUTPUT",
          "required": false
        }
      ]
    },
    {
      "key": "payment.create",
      "name": "Criar cobrança",
      "description": "Cria uma cobrança única (boleto, Pix, cartão ou aberta). Obrigatórios: cliente, forma, valor e vencimento.",
      "inputs": [
        {
          "key": "customer",
          "label": "Cliente (id)",
          "type": "TEXT",
          "required": true,
          "description": "Id do cliente Asaas, ex.: {{ cobranca.customerId }}"
        },
        {
          "key": "billingType",
          "label": "Forma de pagamento",
          "type": "SELECT",
          "required": true
        },
        {
          "key": "value",
          "label": "Valor",
          "type": "NUMBER",
          "required": true,
          "description": "Valor total da cobrança, ex.: 149.90"
        },
        {
          "key": "dueDate",
          "label": "Vencimento",
          "type": "DATE",
          "required": true,
          "description": "Formato AAAA-MM-DD."
        },
        {
          "key": "description",
          "label": "Descrição",
          "type": "TEXT",
          "required": false
        },
        {
          "key": "externalReference",
          "label": "Referência externa",
          "type": "TEXT",
          "required": false,
          "description": "Id do seu processo, para correlacionar no webhook."
        }
      ],
      "outputs": [
        {
          "key": "id",
          "label": "Id",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "status",
          "label": "Status",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "billingType",
          "label": "Billing Type",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "value",
          "label": "Value",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "netValue",
          "label": "Net Value",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "dueDate",
          "label": "Due Date",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "invoiceUrl",
          "label": "Invoice Url",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "bankSlipUrl",
          "label": "Bank Slip Url",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "customer",
          "label": "Customer",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "externalReference",
          "label": "External Reference",
          "type": "OUTPUT",
          "required": false
        }
      ]
    },
    {
      "key": "payment.refund",
      "name": "Estornar cobrança (Pix/cartão)",
      "description": "Estorna uma cobrança já paga por Pix ou cartão. Sem 'value', o Asaas tenta estornar o total.",
      "inputs": [
        {
          "key": "id",
          "label": "Cobrança (id)",
          "type": "TEXT",
          "required": true,
          "description": "Id da cobrança paga a estornar."
        },
        {
          "key": "value",
          "label": "Valor a estornar",
          "type": "NUMBER",
          "required": false,
          "description": "Opcional. Vazio = estorno total."
        },
        {
          "key": "description",
          "label": "Motivo",
          "type": "TEXT",
          "required": false
        }
      ],
      "outputs": [
        {
          "key": "id",
          "label": "Id",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "status",
          "label": "Status",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "value",
          "label": "Value",
          "type": "OUTPUT",
          "required": false
        }
      ]
    },
    {
      "key": "payment.identificationField",
      "name": "Linha digitável do boleto",
      "description": "Retorna a linha digitável (identificationField) do boleto de uma cobrança. A URL do boleto em si vem em 'bankSlipUrl' na consulta da cobrança.",
      "inputs": [
        {
          "key": "id",
          "label": "Cobrança (id)",
          "type": "TEXT",
          "required": true,
          "description": "Id da cobrança Asaas (boleto)."
        }
      ],
      "outputs": [
        {
          "key": "identificationField",
          "label": "Identification Field",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "nossoNumero",
          "label": "Nosso Numero",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "barCode",
          "label": "Bar Code",
          "type": "OUTPUT",
          "required": false
        }
      ]
    },
    {
      "key": "payment.pixQrCode",
      "name": "QR Code Pix da cobrança",
      "description": "Retorna a imagem (base64) e o payload copia-e-cola do Pix de uma cobrança.",
      "inputs": [
        {
          "key": "id",
          "label": "Cobrança (id)",
          "type": "TEXT",
          "required": true,
          "description": "Id da cobrança Asaas."
        }
      ],
      "outputs": [
        {
          "key": "success",
          "label": "Success",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "encodedImage",
          "label": "Encoded Image",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "payload",
          "label": "Payload",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "expirationDate",
          "label": "Expiration Date",
          "type": "OUTPUT",
          "required": false
        }
      ]
    },
    {
      "key": "payment.bankSlipRefund",
      "name": "Solicitar estorno de boleto",
      "description": "Inicia o fluxo de estorno de um boleto pago. A resposta traz 'requestUrl' — o pagador ainda precisa informar conta e documentos para concluir.",
      "inputs": [
        {
          "key": "id",
          "label": "Cobrança (id)",
          "type": "TEXT",
          "required": true,
          "description": "Id da cobrança (boleto pago) a estornar."
        }
      ],
      "outputs": [
        {
          "key": "id",
          "label": "Id",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "status",
          "label": "Status",
          "type": "OUTPUT",
          "required": false
        },
        {
          "key": "requestUrl",
          "label": "Request Url",
          "type": "OUTPUT",
          "required": false
        }
      ]
    }
  ],
  "triggers": [
    {
      "key": "payment.received",
      "name": "Pagamento recebido",
      "description": "Dispara quando uma cobrança é recebida e o saldo fica disponível (PAYMENT_RECEIVED). A inscrição registra um webhook dedicado no Asaas.",
      "mode": "PUSH",
      "exclusiveByConnection": false,
      "inputs": [
        {
          "key": "notificationEmail",
          "label": "E-mail para alertas de falha do webhook",
          "type": "TEXT",
          "required": true,
          "description": "O Asaas exige um e-mail para avisar se o webhook parar de responder."
        }
      ],
      "events": [
        {
          "type": "GENERIC"
        }
      ]
    },
    {
      "key": "payment.overdue",
      "name": "Cobrança vencida",
      "description": "Dispara quando uma cobrança vence sem pagamento (PAYMENT_OVERDUE). A inscrição registra um webhook dedicado no Asaas.",
      "mode": "PUSH",
      "exclusiveByConnection": false,
      "inputs": [
        {
          "key": "notificationEmail",
          "label": "E-mail para alertas de falha do webhook",
          "type": "TEXT",
          "required": true,
          "description": "O Asaas exige um e-mail para avisar se o webhook parar de responder."
        }
      ],
      "events": [
        {
          "type": "GENERIC"
        }
      ]
    }
  ]
}

Obtendo a chave de API

1. No painel do Asaas, abra o menu do usuário e vá em Integrações.
2. Acesse Chave de API e copie a chave exibida.
3. Cole a chave no campo de credencial do iBPMS.

A chave é da sua conta

A chave de API do Asaas dá acesso às cobranças e aos clientes da conta inteira. Trate-a como senha e revogue-a no painel do Asaas caso suspeite de vazamento.

Credenciais

Credencial

Chave de API

API_KEY

No painel do Asaas, abra o menu do usuário > Integrações > Chave de API e copie a chave. Ela é enviada no header access_token de cada chamada.

Campo	Formato esperado
Chave de API	Cole a chave de API da sua conta Asaas

Abrir guia do provedor

Ações disponíveis

Ação

Cancelar assinatura

subscription.delete

Encerra a recorrência e remove as cobranças pendentes/vencidas ligadas a ela.

Entradas

Campo	Tipo	Obrigatório	Descrição
idAssinatura (id)	TEXT	Sim	—

Saídas

Campo	Tipo	Obrigatório	Descrição
deletedDeleted	OUTPUT	Não	—
idId	OUTPUT	Não	—

Chamada

{
  "connection": "asaas-producao",
  "operation": "subscription.delete",
  "inputs": {
    "id": "{{ context.id }}"
  }
}

Resposta

{
  "deleted": "…",
  "id": 123
}

Ação

Cancelar cobrança

payment.delete

Remove uma cobrança ainda não paga. Resposta: { deleted: true, id }.

Entradas

Campo	Tipo	Obrigatório	Descrição
idCobrança (id)	TEXT	Sim	Id da cobrança a remover.

Saídas

Campo	Tipo	Obrigatório	Descrição
deletedDeleted	OUTPUT	Não	—
idId	OUTPUT	Não	—

Chamada

{
  "connection": "asaas-producao",
  "operation": "payment.delete",
  "inputs": {
    "id": "{{ context.id }}"
  }
}

Resposta

{
  "deleted": "…",
  "id": 123
}

Ação

Consultar cobrança

payment.get

Recupera uma cobrança pelo id, com status atual e valores.

Entradas

Campo	Tipo	Obrigatório	Descrição
idCobrança (id)	TEXT	Sim	Id da cobrança Asaas, ex.: {{ cobranca.id }}

Saídas

Campo	Tipo	Obrigatório	Descrição
idId	OUTPUT	Não	—
statusStatus	OUTPUT	Não	—
billingTypeBilling Type	OUTPUT	Não	—
valueValue	OUTPUT	Não	—
netValueNet Value	OUTPUT	Não	—
dueDateDue Date	OUTPUT	Não	—
paymentDatePayment Date	OUTPUT	Não	—
invoiceUrlInvoice Url	OUTPUT	Não	—
bankSlipUrlBank Slip Url	OUTPUT	Não	—
customerCustomer	OUTPUT	Não	—
externalReferenceExternal Reference	OUTPUT	Não	—

Chamada

{
  "connection": "asaas-producao",
  "operation": "payment.get",
  "inputs": {
    "id": "{{ context.id }}"
  }
}

Resposta

{
  "id": 123,
  "status": "…",
  "billingType": "…",
  "value": "…",
  "netValue": "…",
  "dueDate": "…",
  "paymentDate": "…",
  "invoiceUrl": "…",
  "bankSlipUrl": "…",
  "customer": "…",
  "externalReference": "…"
}

Ação

Criar assinatura

subscription.create

Cria uma cobrança recorrente. Obrigatórios: cliente, forma, valor, primeiro vencimento e ciclo.

Entradas

Campo	Tipo	Obrigatório	Descrição
customerCliente (id)	TEXT	Sim	—
billingTypeForma de pagamento	SELECT	Sim	—
valueValor por ciclo	NUMBER	Sim	—
nextDueDatePrimeiro vencimento	DATE	Sim	Formato AAAA-MM-DD.
cycleCiclo	SELECT	Sim	—
descriptionDescrição	TEXT	Não	—
externalReferenceReferência externa	TEXT	Não	—

Saídas

Campo	Tipo	Obrigatório	Descrição
idId	OUTPUT	Não	—
statusStatus	OUTPUT	Não	—
valueValue	OUTPUT	Não	—
cycleCycle	OUTPUT	Não	—
nextDueDateNext Due Date	OUTPUT	Não	—
customerCustomer	OUTPUT	Não	—

Chamada

{
  "connection": "asaas-producao",
  "operation": "subscription.create",
  "inputs": {
    "customer": "{{ context.customer }}",
    "billingType": "{{ context.billingType }}",
    "value": 10,
    "nextDueDate": "2026-08-13T09:00:00Z",
    "cycle": "{{ context.cycle }}",
    "description": "{{ context.description }}",
    "externalReference": "{{ context.externalReference }}"
  }
}

Resposta

{
  "id": 123,
  "status": "…",
  "value": "…",
  "cycle": "…",
  "nextDueDate": "…",
  "customer": "…"
}

Ação

Criar cliente

customer.create

Cadastra um cliente na conta Asaas. Obrigatórios: nome e CPF/CNPJ.

Entradas

Campo	Tipo	Obrigatório	Descrição
nameNome	TEXT	Sim	Aceita expressões do processo, ex.: {{ solicitante.nome }}
cpfCnpjCPF ou CNPJ	TEXT	Sim	Com ou sem máscara.
emailE-mail	TEXT	Não	—
phoneTelefone fixo	TEXT	Não	Campo 'phone' da API — telefone fixo.
mobilePhoneCelular	TEXT	Não	Campo 'mobilePhone' da API — celular.
externalReferenceReferência externa	TEXT	Não	Id do seu processo, para correlacionar depois.

Saídas

Campo	Tipo	Obrigatório	Descrição
idId	OUTPUT	Não	—
nameName	OUTPUT	Não	—
cpfCnpjCpf Cnpj	OUTPUT	Não	—
emailEmail	OUTPUT	Não	—
dateCreatedDate Created	OUTPUT	Não	—

Chamada

{
  "connection": "asaas-producao",
  "operation": "customer.create",
  "inputs": {
    "name": "{{ context.name }}",
    "cpfCnpj": "{{ context.cpfCnpj }}",
    "email": "pessoa@empresa.com",
    "phone": "+5511999999999",
    "mobilePhone": "+5511999999999",
    "externalReference": "{{ context.externalReference }}"
  }
}

Resposta

{
  "id": 123,
  "name": "…",
  "cpfCnpj": "…",
  "email": "…",
  "dateCreated": "…"
}

Ação

Criar cobrança

payment.create

Cria uma cobrança única (boleto, Pix, cartão ou aberta). Obrigatórios: cliente, forma, valor e vencimento.

Entradas

Campo	Tipo	Obrigatório	Descrição
customerCliente (id)	TEXT	Sim	Id do cliente Asaas, ex.: {{ cobranca.customerId }}
billingTypeForma de pagamento	SELECT	Sim	—
valueValor	NUMBER	Sim	Valor total da cobrança, ex.: 149.90
dueDateVencimento	DATE	Sim	Formato AAAA-MM-DD.
descriptionDescrição	TEXT	Não	—
externalReferenceReferência externa	TEXT	Não	Id do seu processo, para correlacionar no webhook.

Saídas

Campo	Tipo	Obrigatório	Descrição
idId	OUTPUT	Não	—
statusStatus	OUTPUT	Não	—
billingTypeBilling Type	OUTPUT	Não	—
valueValue	OUTPUT	Não	—
netValueNet Value	OUTPUT	Não	—
dueDateDue Date	OUTPUT	Não	—
invoiceUrlInvoice Url	OUTPUT	Não	—
bankSlipUrlBank Slip Url	OUTPUT	Não	—
customerCustomer	OUTPUT	Não	—
externalReferenceExternal Reference	OUTPUT	Não	—

Chamada

{
  "connection": "asaas-producao",
  "operation": "payment.create",
  "inputs": {
    "customer": "{{ context.customer }}",
    "billingType": "{{ context.billingType }}",
    "value": 10,
    "dueDate": "2026-08-13T09:00:00Z",
    "description": "{{ context.description }}",
    "externalReference": "{{ context.externalReference }}"
  }
}

Resposta

{
  "id": 123,
  "status": "…",
  "billingType": "…",
  "value": "…",
  "netValue": "…",
  "dueDate": "…",
  "invoiceUrl": "…",
  "bankSlipUrl": "…",
  "customer": "…",
  "externalReference": "…"
}

Ação

Estornar cobrança (Pix/cartão)

payment.refund

Estorna uma cobrança já paga por Pix ou cartão. Sem 'value', o Asaas tenta estornar o total.

Entradas

Campo	Tipo	Obrigatório	Descrição
idCobrança (id)	TEXT	Sim	Id da cobrança paga a estornar.
valueValor a estornar	NUMBER	Não	Opcional. Vazio = estorno total.
descriptionMotivo	TEXT	Não	—

Saídas

Campo	Tipo	Obrigatório	Descrição
idId	OUTPUT	Não	—
statusStatus	OUTPUT	Não	—
valueValue	OUTPUT	Não	—

Chamada

{
  "connection": "asaas-producao",
  "operation": "payment.refund",
  "inputs": {
    "id": "{{ context.id }}",
    "value": 10,
    "description": "{{ context.description }}"
  }
}

Resposta

{
  "id": 123,
  "status": "…",
  "value": "…"
}

Ação

Linha digitável do boleto

payment.identificationField

Retorna a linha digitável (identificationField) do boleto de uma cobrança. A URL do boleto em si vem em 'bankSlipUrl' na consulta da cobrança.

Entradas

Campo	Tipo	Obrigatório	Descrição
idCobrança (id)	TEXT	Sim	Id da cobrança Asaas (boleto).

Saídas

Campo	Tipo	Obrigatório	Descrição
identificationFieldIdentification Field	OUTPUT	Não	—
nossoNumeroNosso Numero	OUTPUT	Não	—
barCodeBar Code	OUTPUT	Não	—

Chamada

{
  "connection": "asaas-producao",
  "operation": "payment.identificationField",
  "inputs": {
    "id": "{{ context.id }}"
  }
}

Resposta

{
  "identificationField": 123,
  "nossoNumero": "…",
  "barCode": "…"
}

Ação

QR Code Pix da cobrança

payment.pixQrCode

Retorna a imagem (base64) e o payload copia-e-cola do Pix de uma cobrança.

Entradas

Campo	Tipo	Obrigatório	Descrição
idCobrança (id)	TEXT	Sim	Id da cobrança Asaas.

Saídas

Campo	Tipo	Obrigatório	Descrição
successSuccess	OUTPUT	Não	—
encodedImageEncoded Image	OUTPUT	Não	—
payloadPayload	OUTPUT	Não	—
expirationDateExpiration Date	OUTPUT	Não	—

Chamada

{
  "connection": "asaas-producao",
  "operation": "payment.pixQrCode",
  "inputs": {
    "id": "{{ context.id }}"
  }
}

Resposta

{
  "success": "…",
  "encodedImage": "…",
  "payload": "…",
  "expirationDate": "…"
}

Ação

Solicitar estorno de boleto

payment.bankSlipRefund

Inicia o fluxo de estorno de um boleto pago. A resposta traz 'requestUrl' — o pagador ainda precisa informar conta e documentos para concluir.

Entradas

Campo	Tipo	Obrigatório	Descrição
idCobrança (id)	TEXT	Sim	Id da cobrança (boleto pago) a estornar.

Saídas

Campo	Tipo	Obrigatório	Descrição
idId	OUTPUT	Não	—
statusStatus	OUTPUT	Não	—
requestUrlRequest Url	OUTPUT	Não	—

Chamada

{
  "connection": "asaas-producao",
  "operation": "payment.bankSlipRefund",
  "inputs": {
    "id": "{{ context.id }}"
  }
}

Resposta

{
  "id": 123,
  "status": "…",
  "requestUrl": "…"
}

Triggers disponíveis

Trigger

Pagamento recebido

PUSH

Dispara quando uma cobrança é recebida e o saldo fica disponível (PAYMENT_RECEIVED). A inscrição registra um webhook dedicado no Asaas.

Configuração

Campo	Tipo	Obrigatório	Descrição
notificationEmailE-mail para alertas de falha do webhook	TEXT	Sim	O Asaas exige um e-mail para avisar se o webhook parar de responder.

Eventos normalizados

• GENERIC

Evento recebido

{
  "event": "GENERIC",
  "data": {
    "notificationEmail": "pessoa@empresa.com"
  }
}

Trigger

Cobrança vencida

PUSH

Dispara quando uma cobrança vence sem pagamento (PAYMENT_OVERDUE). A inscrição registra um webhook dedicado no Asaas.

Configuração

Campo	Tipo	Obrigatório	Descrição
notificationEmailE-mail para alertas de falha do webhook	TEXT	Sim	O Asaas exige um e-mail para avisar se o webhook parar de responder.

Eventos normalizados

• GENERIC

Evento recebido

{
  "event": "GENERIC",
  "data": {
    "notificationEmail": "pessoa@empresa.com"
  }
}

Limitações

• a chave é enviada no header `access_token` de cada chamada, então precisa continuar válida no painel do Asaas;
• os triggers dependem de o webhook do Asaas estar apontado para o iBPMS;
• cobranças, assinaturas e clientes seguem as regras e os limites da própria conta Asaas.

Erros comuns

Sintoma	Possível causa	Correção
401 nas chamadas	Chave revogada ou copiada com espaços	Gere a chave novamente no painel e cole sem espaços em volta.
Pagamento não dispara a regra	Webhook do Asaas não configurado	Aponte o webhook do Asaas para a URL de callback do trigger.
Cobrança recusada	Dados do cliente incompletos	Confirme CPF/CNPJ e os campos obrigatórios antes de criar a cobrança.

Veja também

• Todos os conectores
• Integrações
• Solução de problemas