Asaas

Integração com a API do Asaas para gerenciar clientes, cobranças, assinaturas, Pix, transferências, notas fiscais e subcontas.

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions

This connector provides 214 actions:

Action	Purpose	Parameters
post_v3_customers	Criar novo cliente	data: { . name (string) . cpfCnpj (string) . email (string) . phone (string) . mobilePhone (string) . address (string) . addressNumber (string) . complement (string) . province (string) . postalCode (string) . externalReference (string) . notificationDisabled (boolean) . additionalEmails (string) . municipalInscription (string) . stateInscription (string) . observations (string) . groupName (string) . company (string) . foreignCustomer (boolean) } (object) required
get_v3_customers	Listar clientes	offset (integer) limit (integer) name (string) email (string) cpfCnpj (string) groupName (string) externalReference (string)
get_v3_customers_by_id	Recuperar um único cliente	id (string)
put_v3_customers_by_id	Atualizar cliente existente	id (string) data: { . name (string) . cpfCnpj (string) . email (string) . phone (string) . mobilePhone (string) . address (string) . addressNumber (string) . complement (string) . province (string) . postalCode (string) . externalReference (string) . notificationDisabled (boolean) . additionalEmails (string) . municipalInscription (string) . stateInscription (string) . observations (string) . groupName (string) . company (string) . foreignCustomer (boolean) } (object) required
delete_v3_customers_by_id	Remover cliente	id (string)
post_v3_customers_by_id_restore	Restaurar cliente removido	id (string) data: { } (object) required
get_v3_customers_by_id_notifications	Recuperar notificações de um cliente	id (string)
post_v3_payments	Criar nova cobrança	data: { . customer (string) . billingType (string) . value (number) . dueDate (string) . description (string) . daysAfterDueDateToRegistrationCancellation (integer) . externalReference (string) . installmentCount (integer) . totalValue (number) . installmentValue (number) . discount (object) . interest (object) . fine (object) . postalService (boolean) . split (array) . callback (object) . pixAutomaticAuthorizationId (string) } (object) required
get_v3_payments	Listar cobranças	offset (integer) limit (integer) customer (string) customerGroupName (string) billingType (string) status (string) subscription (string) installment (string) externalReference (string) paymentDate (string) invoiceStatus (string) estimatedCreditDate (string) pixQrCodeId (string) anticipated (boolean) anticipable (boolean) dateCreatedge (string) dateCreatedle (string) paymentDatege (string) paymentDatele (string) estimatedCreditDatege (string) estimatedCreditDatele (string) dueDatege (string) dueDatele (string) user (string) checkoutSession (string)
post_v3_payments	Criar cobrança com cartão de crédito	data: { . customer (string) . billingType (string) . value (number) . dueDate (string) . description (string) . daysAfterDueDateToRegistrationCancellation (integer) . externalReference (string) . installmentCount (integer) . totalValue (number) . installmentValue (number) . discount (object) . interest (object) . fine (object) . postalService (boolean) . split (array) . callback (object) . pixAutomaticAuthorizationId (string) . creditCard (object) . creditCardHolderInfo (object) . creditCardToken (string) . authorizeOnly (boolean) . remoteIp (string) } (object) required
post_v3_payments_by_id_capture_authorized_payment	Capturar cobrança com Pré-Autorização	id (string) data: { } (object) required
post_v3_payments_by_id_pay_with_card	Pagar uma cobrança com cartão	id (string) data: { . cardType (string) . card (object) . cardToken (string) } (object) required
post_v3_payments_by_id_pay_with_credit_card	Pagar uma cobrança com cartão de crédito	id (string) data: { . creditCard (object) . creditCardHolderInfo (object) . creditCardToken (string) } (object) required
get_v3_payments_by_id_billing_info	Recuperar informações de pagamento de uma cobrança	id (string)
get_v3_payments_by_id_viewing_info	Informações sobre visualização da cobrança	id (string)
get_v3_payments_by_id	Recuperar uma única cobrança	id (string)
put_v3_payments_by_id	Atualizar cobrança existente	id (string) data: { . billingType (string) . value (number) . dueDate (string) . description (string) . daysAfterDueDateToRegistrationCancellation (integer) . externalReference (string) . discount (object) . interest (object) . fine (object) . postalService (boolean) . split (array) . callback (object) } (object) required
delete_v3_payments_by_id	Excluir cobrança	id (string)
post_v3_payments_by_id_restore	Restaurar cobrança removida	id (string) data: { } (object) required
get_v3_payments_by_id_status	Recuperar status de uma cobrança	id (string)
post_v3_payments_by_id_refund	Estornar cobrança	id (string) data: { . value (number) . description (string) . splitRefunds (array) } (object) required
get_v3_payments_by_id_identification_field	Obter linha digitável do boleto	id (string)
get_v3_payments_by_id_pix_qr_code	Obter QR Code para pagamentos via Pix	id (string)
post_v3_payments_by_id_receive_in_cash	Confirmar recebimento em dinheiro	id (string) data: { . paymentDate (string) . value (number) . notifyCustomer (boolean) } (object) required
post_v3_payments_by_id_undo_received_in_cash	Desfazer confirmação de recebimento em dinheiro	id (string) data: { } (object) required
post_v3_payments_simulate	Simulador de vendas	data: { . value (number) . installmentCount (integer) . billingTypes (array) } (object) required
get_v3_payments_limits	Recuperando limites de cobranças	No parameters
post_v3_lean_payments	Criar nova cobrança com dados resumidos na resposta	data: { . customer (string) . billingType (string) . value (number) . dueDate (string) . description (string) . daysAfterDueDateToRegistrationCancellation (integer) . externalReference (string) . installmentCount (integer) . totalValue (number) . installmentValue (number) . discount (object) . interest (object) . fine (object) . postalService (boolean) . split (array) . callback (object) . pixAutomaticAuthorizationId (string) } (object) required
get_v3_lean_payments	Listar cobranças com dados resumidos	offset (integer) limit (integer) customer (string) customerGroupName (string) billingType (string) status (string) subscription (string) installment (string) externalReference (string) paymentDate (string) invoiceStatus (string) estimatedCreditDate (string) pixQrCodeId (string) anticipated (boolean) anticipable (boolean) dateCreatedge (string) dateCreatedle (string) paymentDatege (string) paymentDatele (string) estimatedCreditDatege (string) estimatedCreditDatele (string) dueDatege (string) dueDatele (string) user (string) checkoutSession (string)
post_v3_lean_payments	Criar cobrança com cartão de crédito com dados resumidos na resposta	data: { . customer (string) . billingType (string) . value (number) . dueDate (string) . description (string) . daysAfterDueDateToRegistrationCancellation (integer) . externalReference (string) . installmentCount (integer) . totalValue (number) . installmentValue (number) . discount (object) . interest (object) . fine (object) . postalService (boolean) . split (array) . callback (object) . pixAutomaticAuthorizationId (string) . creditCard (object) . creditCardHolderInfo (object) . creditCardToken (string) . authorizeOnly (boolean) . remoteIp (string) } (object) required
post_v3_lean_payments_by_id_capture_authorized_payment	Capturar cobrança com Pré-Autorização com dados resumidos na resposta	id (string) data: { } (object) required
get_v3_lean_payments_by_id	Recuperar uma única cobrança com dados resumidos	id (string)
put_v3_lean_payments_by_id	Atualizar cobrança existente com dados resumidos na resposta	id (string) data: { } (object) required
delete_v3_lean_payments_by_id	Excluir cobrança com dados resumidos	id (string)
post_v3_lean_payments_by_id_restore	Restaurar cobrança removida com dados resumidos na resposta	id (string) data: { } (object) required
post_v3_lean_payments_by_id_refund	Estornar cobrança com dados resumidos na resposta	id (string) data: { . value (number) . description (string) . splitRefunds (array) } (object) required
post_v3_lean_payments_by_id_receive_in_cash	Confirmar recebimento em dinheiro com dados resumidos na resposta	id (string) data: { . paymentDate (string) . value (number) . notifyCustomer (boolean) } (object) required
post_v3_lean_payments_by_id_undo_received_in_cash	Desfazer confirmação de recebimento em dinheiro com dados resumidos na resposta	id (string) data: { } (object) required
post_v3_payments_by_id_documents	Fazer upload de documentos da cobrança	id (string) data: { . availableAfterPayment (boolean) . type (string) . file (object) } (object) required
get_v3_payments_by_id_documents	Listar documentos de uma cobrança	id (string)
put_v3_payments_by_id_documents_by_document_id	Atualizar definições de um documento da cobrança	id (string) documentId (string) data: { . availableAfterPayment (boolean) . type (string) } (object) required
get_v3_payments_by_id_documents_by_document_id	Recuperar um único documento da cobrança	id (string) documentId (string)
delete_v3_payments_by_id_documents_by_document_id	Excluir documento de uma cobrança	id (string) documentId (string)
post_v3_installments	Criar parcelamento	data: { . installmentCount (integer) . customer (string) . value (number) . totalValue (number) . billingType (string) . dueDate (string) . description (string) . postalService (boolean) . daysAfterDueDateToRegistrationCancellation (integer) . paymentExternalReference (string) . discount (object) . interest (object) . fine (object) . splits (array) } (object) required
get_v3_installments	Listar parcelamentos	offset (integer) limit (integer)
post_v3_installments	Criar parcelamento com cartão de crédito	data: { . installmentCount (integer) . customer (string) . value (number) . totalValue (number) . billingType (string) . dueDate (string) . description (string) . postalService (boolean) . daysAfterDueDateToRegistrationCancellation (integer) . paymentExternalReference (string) . discount (object) . interest (object) . fine (object) . splits (array) . creditCard (object) . creditCardHolderInfo (object) . creditCardToken (string) . authorizeOnly (boolean) . remoteIp (string) } (object) required
get_v3_installments_by_id	Recuperar um único parcelamento	id (string)
delete_v3_installments_by_id	Remover parcelamento	id (string)
delete_v3_installments_by_id_payments	Cancelar cobranças de um parcelamento pendentes e vencidas	id (string)
get_v3_installments_by_id_payments	Listar cobranças de um parcelamento	id (string) status (string)
get_v3_installments_by_id_payment_book	Gerar carnê de parcelamento	id (string) sort (string) order (string)
post_v3_installments_by_id_refund	É possível estornar um parcelamento via cartão de crédito recebido ou confirmado. Como já ocorre no processo de estorno de uma cobrança avulsa por cartão de crédito, o saldo correspondente do parcelamento é debitado de sua conta no Asaas e a cobrança é cancelada no cartão do seu cliente. O cancelamento pode levar até 10 dias úteis para aparecer na fatura de seu cliente.	id (string) data: { . value (number) } (object) required
put_v3_installments_by_id_splits	Atualizar splits do parcelamento	id (string) data: { . splits (array) } (object) required
post_v3_subscriptions	Criar nova assinatura	data: { . customer (string) . billingType (string) . value (number) . nextDueDate (string) . discount (object) . interest (object) . fine (object) . cycle (string) . description (string) . endDate (string) . maxPayments (integer) . externalReference (string) . split (array) . callback (object) } (object) required
get_v3_subscriptions	Listar assinaturas	offset (integer) limit (integer) customer (string) customerGroupName (string) billingType (string) status (string) deletedOnly (string) includeDeleted (string) externalReference (string) order (string) sort (string)
post_v3_subscriptions	Criar assinatura com cartão de crédito	data: { . customer (string) . billingType (string) . value (number) . nextDueDate (string) . discount (object) . interest (object) . fine (object) . cycle (string) . description (string) . endDate (string) . maxPayments (integer) . externalReference (string) . split (array) . callback (object) . creditCard (object) . creditCardHolderInfo (object) . creditCardToken (string) . remoteIp (string) } (object) required
get_v3_subscriptions_by_id	Recuperar uma única assinatura	id (string)
put_v3_subscriptions_by_id	Atualizar assinatura existente	id (string) data: { . billingType (string) . status (string) . nextDueDate (string) . discount (object) . interest (object) . fine (object) . cycle (string) . description (string) . endDate (string) . updatePendingPayments (boolean) . externalReference (string) . split (array) . callback (object) } (object) required
delete_v3_subscriptions_by_id	Remover assinatura	id (string)
put_v3_subscriptions_by_id_credit_card	Este endpoint atualiza o cartão de crédito da assinatura sem realizar a cobrança imediata. Além disso, todas as cobranças pendentes vinculadas a assinatura também são atualizadas.	id (string) data: { . creditCard (object) . creditCardHolderInfo (object) . creditCardToken (string) . remoteIp (string) } (object) required
get_v3_subscriptions_by_id_payments	Listar cobranças de uma assinatura	id (string) status (string)
get_v3_subscriptions_by_id_payment_book	Gerar carnê de assinatura	id (string) month (integer) year (integer) sort (string) order (string)
post_v3_subscriptions_by_id_invoice_settings	Criar configuração para emissão de Notas Fiscais	id (string) data: { . municipalServiceId (string) . municipalServiceCode (string) . municipalServiceName (string) . updatePayment (boolean) . deductions (number) . effectiveDatePeriod (string) . receivedOnly (boolean) . daysBeforeDueDate (integer) . observations (string) . taxes (object) } (object) required
get_v3_subscriptions_by_id_invoice_settings	Recuperar configuração para emissão de notas fiscais	id (string)
delete_v3_subscriptions_by_id_invoice_settings	Remover configuração para emissão de Notas Fiscais	id (string)
put_v3_subscriptions_by_id_invoice_settings	Atualizar configuração para emissão de Notas Fiscais	id (string) data: { . deductions (number) . effectiveDatePeriod (string) . receivedOnly (boolean) . daysBeforeDueDate (integer) . observations (string) . taxes (object) } (object) required
get_v3_subscriptions_by_id_invoices	Listar notas fiscais das cobranças de uma assinatura	id (string) offset (integer) limit (integer) effectiveDatege (string) effectiveDatele (string) externalReference (string) status (string) customer (string)
post_v3_payment_links	Criar um link de pagamentos	data: { . name (string) . description (string) . endDate (string) . value (number) . billingType (string) . chargeType (string) . dueDateLimitDays (integer) . subscriptionCycle (string) . maxInstallmentCount (integer) . externalReference (string) . notificationEnabled (boolean) . callback (object) . isAddressRequired (boolean) } (object) required
get_v3_payment_links	Listar links de pagamentos	offset (integer) limit (integer) active (boolean) includeDeleted (boolean) name (string) externalReference (string)
put_v3_payment_links_by_id	Atualizar um link de pagamentos	id (string) data: { . name (string) . description (string) . endDate (string) . value (number) . active (boolean) . billingType (string) . chargeType (string) . dueDateLimitDays (integer) . subscriptionCycle (string) . maxInstallmentCount (integer) . externalReference (string) . notificationEnabled (boolean) . callback (object) } (object) required
get_v3_payment_links_by_id	Recuperar um único link de pagamentos	id (string)
delete_v3_payment_links_by_id	Remover um link de pagamentos	id (string)
post_v3_payment_links_by_id_restore	Restaurar um link de pagamentos	id (string) data: { } (object) required
post_v3_payment_links_by_id_images	Adicionar uma imagem a um link de pagamentos	id (string) data: { . main (boolean) . image (object) } (object) required
get_v3_payment_links_by_id_images	Listar imagens de um link de pagamentos	id (string)
get_v3_payment_links_by_payment_link_id_images_by_image_id	Recuperar uma única imagem do link de pagamentos	paymentLinkId (string) imageId (string)
delete_v3_payment_links_by_payment_link_id_images_by_image_id	Remover uma imagem do link de pagamentos	paymentLinkId (string) imageId (string)
put_v3_payment_links_by_payment_link_id_images_by_image_id_set_as_main	Definir imagem principal do link de pagamentos	paymentLinkId (string) imageId (string) data: { } (object) required
post_v3_checkouts	Criar novo checkout	data: { . billingTypes (array) . chargeTypes (array) . minutesToExpire (integer) . externalReference (string) . callback (object) . items (array) . customerData (object) . subscription (object) . installment (object) . splits (array) } (object) required
post_v3_checkouts_by_id_cancel	Cancelar um checkout	id (string) data: { } (object) required
post_v3_credit_card_tokenize_credit_card	Tokenização de cartão de crédito	data: { . customer (string) . creditCard (object) . creditCardHolderInfo (object) . remoteIp (string) } (object) required
post_v3_credit_card_pre_authorization_config	Salvar ou atualizar configuração da pré-autorização	data: { . daysToExpire (integer) } (object) required
get_v3_credit_card_pre_authorization_config	Recuperar configuração da pré-autorização	No parameters
post_v3_anticipations	Solicitar antecipação	data: { . installment (string) . payment (string) . documents (object) } (object) required
get_v3_anticipations	Listar antecipações	offset (integer) limit (integer) payment (string) installment (string) status (string)
post_v3_anticipations_simulate	Simular antecipação	data: { . installment (string) . payment (string) } (object) required
get_v3_anticipations_by_id	Recuperar uma única antecipação	id (string)
put_v3_anticipations_configurations	Atualizar status da antecipação automática	data: { . creditCardAutomaticEnabled (boolean) } (object) required
get_v3_anticipations_configurations	Recuperar status da antecipação automática	No parameters
get_v3_anticipations_limits	Recuperar limites de antecipações	No parameters
post_v3_anticipations_by_id_cancel	Cancelar antecipação	id (string) data: { } (object) required
get_v3_payments_by_id_refunds	Listar estornos de uma cobrança	id (string)
post_v3_payments_by_id_bank_slip_refund	Estornar boleto	id (string) data: { } (object) required
post_v3_chargebacks_by_id_dispute	Criar disputa de chargeback	id (string) data: { . files (object) } (object) required
get_v3_chargebacks	Este método retorna uma lista paginada com todos os chargebacks para os filtros informados.	offset (integer) limit (integer) creditCardBrand (string) originDisputeDatele (string) originDisputeDatege (string) originTransactionDatele (string) originTransactionDatege (string) status (string)
get_v3_payments_by_id_chargeback	Este endpoint recupera um chargeback específico a partir do ID de uma cobrança ou parcelamento.	id (string)
get_v3_payments_splits_paid_by_id	Recuperar um único split pago	id (string)
get_v3_payments_splits_paid	Listar splits pagos	offset (integer) limit (integer) paymentId (string) status (string) paymentConfirmedDatege (string) paymentConfirmedDatele (string) creditDatege (string) creditDatele (string)
get_v3_payments_splits_received_by_id	Recuperar um único split recebido	id (string)
get_v3_payments_splits_received	Listar splits recebidos	offset (integer) limit (integer) paymentId (string) status (string) paymentConfirmedDatege (string) paymentConfirmedDatele (string) creditDatege (string) creditDatele (string)
post_v3_accounts_by_id_escrow	Salvar ou atualizar configuração da Conta Escrow para a subconta	id (string) data: { . daysToExpire (integer) . enabled (boolean) . isFeePayer (boolean) } (object) required
get_v3_accounts_by_id_escrow	Recuperar configuração da Conta Escrow para a subconta	id (string)
post_v3_accounts_escrow	Criar configuração padrão da Conta Escrow para todas as subcontas	data: { . daysToExpire (integer) . enabled (boolean) . isFeePayer (boolean) } (object) required
get_v3_accounts_escrow	Recuperar configuração padrão da Conta Escrow	No parameters
post_v3_escrow_by_id_finish	Encerrar garantia da cobrança na Conta Escrow	id (string) data: { } (object) required
get_v3_payments_by_id_escrow	Recuperar garantia da cobrança na Conta Escrow	id (string)
put_v3_notifications_by_id	Atualizar notificação existente	id (string) data: { . enabled (boolean) . emailEnabledForProvider (boolean) . smsEnabledForProvider (boolean) . emailEnabledForCustomer (boolean) . smsEnabledForCustomer (boolean) . phoneCallEnabledForCustomer (boolean) . whatsappEnabledForCustomer (boolean) . scheduleOffset (integer) } (object) required
put_v3_notifications_batch	É possível personalizar várias notificações, independente do canal de comunicação que utilizar email, SMS e voz e quem deve receber a notificaçãovocê e/ou seu cliente enviando qual o id do cliente e as notificações a serem atualizadas.	data: { . customer (string) . notifications (array) } (object) required
post_v3_credit_bureau_report	Realizar consulta	data: { . customer (string) . cpfCnpj (string) } (object) required
get_v3_credit_bureau_report	Listar consultas	offset (integer) limit (integer) startDate (string) endDate (string)
get_v3_credit_bureau_report_by_id	Recuperar uma consulta	id (string)
post_v3_payment_dunnings	Criar uma negativação	data: { . payment (string) . type (string) . description (string) . customerName (string) . customerCpfCnpj (string) . customerPrimaryPhone (string) . customerSecondaryPhone (string) . customerPostalCode (string) . customerAddress (string) . customerAddressNumber (string) . customerComplement (string) . customerProvince (string) . documents (object) } (object) required
get_v3_payment_dunnings	Listar negativações	offset (integer) limit (integer) status (string) type (string) payment (string) requestStartDate (string) requestEndDate (string)
post_v3_payment_dunnings_simulate	Simular uma negativação	payment (string) data: { } (object) required
get_v3_payment_dunnings_by_id	Recuperar uma única negativação	id (string)
get_v3_payment_dunnings_by_id_history	Retorna uma lista paginada com os eventos que ocorreram desde do início da negativação da cobrança.	id (string) offset (integer) limit (integer)
get_v3_payment_dunnings_by_id_partial_payments	Retorna uma lista paginada com os pagamentos recebidos por meio da renegociação da dívida.	id (string) offset (integer) limit (integer)
get_v3_payment_dunnings_payments_available_for_dunning	Retorna uma lista paginada de cobranças possíveis de negativação em conjunto com uma simulação de valores para cada tipo de negativação.	offset (integer) limit (integer)
post_v3_payment_dunnings_by_id_documents	Permite o reenvio dos documentos de uma negativação em caso de negação. Utilize a propriedade isNecessaryResendDocumentation retornado no objeto de negativação para verificar se é preciso o reenvio da documentação. Após o reenvio sua negativação retornará para o status de AWAITING_APPROVAL.	id (string) data: { . documents (object) } (object) required
post_v3_payment_dunnings_by_id_cancel	Permite o cancelamento de uma negativação. Utilize a propriedade canBeCancelled retornado no objeto de negativação para verificar se a negativação pode ser cancelada. Caso a negativação já tenha sido iniciada, ao solicitar o cancelamento a negativação ficará com o status de AWAITING_CANCELLATION até que seja efetivamente cancelada CANCELLED.	id (string) data: { } (object) required
post_v3_invoices	Agendar nota fiscal	data: { . payment (string) . installment (string) . customer (string) . serviceDescription (string) . observations (string) . externalReference (string) . value (number) . deductions (number) . effectiveDate (string) . municipalServiceId (string) . municipalServiceCode (string) . municipalServiceName (string) . updatePayment (boolean) . taxes (object) } (object) required
get_v3_invoices	Listar notas fiscais	offset (integer) limit (integer) effectiveDateGe (string) effectiveDateLe (string) payment (string) installment (string) externalReference (string) status (string) customer (string)
put_v3_invoices_by_id	Atualizar nota fiscal	id (string) data: { . serviceDescription (string) . observations (string) . externalReference (string) . value (number) . deductions (number) . effectiveDate (string) . updatePayment (boolean) . taxes (object) } (object) required
get_v3_invoices_by_id	Recuperar uma única nota fiscal	id (string)
post_v3_invoices_by_id_authorize	Emitir uma nota fiscal	id (string) data: { } (object) required
post_v3_invoices_by_id_cancel	Cancelar uma nota fiscal	id (string) data: { . cancelOnlyOnAsaas (boolean) } (object) required
get_v3_fiscal_info_municipal_options	Listar configurações municipais	No parameters
post_v3_fiscal_info	Criar e atualizar informações fiscais	data: { . email (string) . municipalInscription (string) . simplesNacional (boolean) . culturalProjectsPromoter (boolean) . cnae (string) . specialTaxRegime (string) . serviceListItem (string) . nbsCode (string) . rpsSerie (string) . rpsNumber (integer) . loteNumber (integer) . username (string) . password (string) . accessToken (string) . certificateFile (object) . certificatePassword (string) . nationalPortalTaxCalculationRegime (string) } (object) required
get_v3_fiscal_info	Recuperar informações fiscais	No parameters
get_v3_fiscal_info_federal_service_codes	Listar códigos de serviços federais	offset (integer) limit (integer) code (string) description (string)
get_v3_fiscal_info_services	Listar serviços municipais	offset (integer) limit (integer) description (string)
get_v3_fiscal_info_nbs_codes	Listagem dos possíveis códigos NBS Nomenclatura Brasileira de Serviços	offset (integer) limit (integer) codeDescription (string)
get_v3_fiscal_info_operation_indicator_codes	Listar códigos de indicadores de operações	offset (integer) limit (integer) code (string) description (string)
get_v3_fiscal_info_tax_classification_codes	Listar códigos de classificações tributárias	offset (integer) limit (integer) code (string) description (string) taxSituationCode (string)
get_v3_fiscal_info_tax_situation_codes	Listar códigos de situações tributárias	offset (integer) limit (integer) code (string) description (string)
post_v3_fiscal_info_national_portal	Aqui é possível habilitar ou desabilitar o uso do portal nacional como emissor de notas fiscais.	data: { . enabled (boolean) } (object) required
post_v3_pix_address_keys	Criar uma chave	data: { . type (string) } (object) required
get_v3_pix_address_keys	Listar chaves	offset (integer) limit (integer) status (string) statusList (string)
get_v3_pix_address_keys_by_id	Recuperar uma única chave	id (string)
delete_v3_pix_address_keys_by_id	Remover chave	id (string)
post_v3_pix_qr_codes_static	Criar QR Code estático	data: { . addressKey (string) . description (string) . value (number) . format (string) . expirationDate (string) . expirationSeconds (integer) . allowsMultiplePayments (boolean) . externalReference (string) } (object) required
delete_v3_pix_qr_codes_static_by_id	Deletar QR Code estático	id (string)
get_v3_pix_token_bucket_address_key	Consulta de fichas disponíveis no balde	No parameters
get_v3_pix_address_keys_external	Consultar Chave Pix	type (string) key (string)
post_v3_pix_qr_codes_pay	Pagar um QRCode	data: { . qrCode (object) . value (number) . description (string) . scheduleDate (string) } (object) required
post_v3_pix_qr_codes_decode	Decodificar um QRCode para pagamento	data: { . payload (string) . changeValue (number) . expectedPaymentDate (string) } (object) required
get_v3_pix_transactions_by_id	Recuperar uma única transação	id (string)
get_v3_pix_transactions	Listar transações	offset (integer) limit (integer) status (string) type (string) endToEndIdentifier (string)
post_v3_pix_transactions_by_id_cancel	Cancelar uma transação agendada	id (string) data: { } (object) required
post_v3_pix_automatic_authorizations	Criar uma autorização	data: { . frequency (string) . contractId (string) . startDate (string) . finishDate (string) . value (number) . description (string) . customerId (string) . immediateQrCode (object) . minLimitValue (number) . paymentCreationMode (string) . retryPolicy (string) } (object) required
get_v3_pix_automatic_authorizations	Listar autorizações	offset (integer) limit (integer) status (string) customerId (string)
get_v3_pix_automatic_authorizations_by_id	Recuperar uma única autorização	id (string)
delete_v3_pix_automatic_authorizations_by_id	Cancelar uma autorização	id (string)
get_v3_pix_automatic_payment_instructions_by_id	Recuperar uma única instrução de pagamento	id (string)
get_v3_pix_automatic_payment_instructions	Listar instruções de pagamento	authorizationId (string) customerId (string) paymentId (string) status (string)
post_v3_pix_automatic_payment_instructions_by_id_retries	Criar retentativa de instrução de pagamento	id (string) data: { . dueDate (string) } (object) required
get_v3_pix_transactions_recurrings	Listar recorrências	offset (integer) limit (integer) status (string) value (number) searchText (string)
get_v3_pix_transactions_recurrings_by_id	Recuperar uma única recorrência	id (string)
post_v3_pix_transactions_recurrings_by_id_cancel	Cancelar uma recorrência	id (string) data: { } (object) required
get_v3_pix_transactions_recurrings_by_id_items	Listar itens de uma recorrência	id (string) offset (integer) limit (integer)
post_v3_pix_transactions_recurrings_items_by_id_cancel	Cancelar item de uma recorrência	id (string) data: { } (object) required
post_v3_transfers	Transferir para conta de outra Instituição ou chave Pix	data: { . value (number) . bankAccount (object) . operationType (string) . pixAddressKey (string) . pixAddressKeyType (string) . description (string) . scheduleDate (string) . externalReference (string) . recurring (object) } (object) required
get_v3_transfers	Este método retorna uma lista paginada com todas as transferências para o filtro informado.	dateCreatedge (string) dateCreatedle (string) transferDatege (string) transferDatele (string) type (string)
post_v3_transfers	Transferir para conta Asaas	data: { . value (number) . walletId (string) . externalReference (string) } (object) required
get_v3_transfers_by_id	Recuperar uma única transferência	id (string)
delete_v3_transfers_by_id_cancel	Cancelar uma transferência	id (string)
post_v3_bill	Criar um pagamento de conta	data: { . identificationField (string) . scheduleDate (string) . description (string) . discount (number) . interest (number) . fine (number) . dueDate (string) . value (number) . externalReference (string) } (object) required
get_v3_bill	Listar pagamento de contas	offset (integer) limit (integer) status (string)
post_v3_bill_simulate	Simular um pagamento de conta	data: { . identificationField (string) . barCode (string) } (object) required
get_v3_bill_by_id	Recuperar um único pagamento de conta	id (string)
post_v3_bill_by_id_cancel	Permite o cancelamento do pagamento de conta. Utilize a propriedade canBeCancelled do objeto bill para verificar se o pagamento de conta pode ser cancelado. Ao ser cancelado o pagamento da conta não será realizado.	id (string) data: { } (object) required
post_v3_mobile_phone_recharges	Solicitar recarga	data: { . value (number) . phoneNumber (string) } (object) required
get_v3_mobile_phone_recharges	Listar recargas de celular	offset (integer) limit (integer)
get_v3_mobile_phone_recharges_by_id	Recuperar uma única recarga de celular	id (string)
post_v3_mobile_phone_recharges_by_id_cancel	Permite o cancelamento da recarga de celular. Utilize a propriedade canBeCancelled para verificar se a recarga pode ser cancelada. Ao ser cancelado a recarga não será realizada.	id (string) data: { } (object) required
get_v3_mobile_phone_recharges_by_phone_number_provider	Buscar qual provedor o número pertence e os valores disponíveis para recarga	phoneNumber (string)
get_v3_financial_transactions	Recuperar extrato	offset (integer) limit (integer) startDate (string) finishDate (string) order (string)
get_v3_finance_balance	Recuperar saldo da conta	No parameters
get_v3_finance_payment_statistics	Retorna valores totais das cobranças da sua conta Asaas de acordo com os filtros informados. Exemplos de filtros: Valor total a receber: GET https://api.asaas.com/v3/finance/payment/statistics?status=PENDING Valor total a receber com cobranças por boleto bancário: GET https://api.asaas.com/v3/finance/payment/statistics?billingType=BOLETO and status=PENDING Valor total recebido por cobranças por cartão de crédito: GET https://api.asaas.com/v3/finance/payment/statistics?billingType=CRE	customer (string) billingType (string) status (string) anticipated (boolean) dateCreatedge (string) dateCreatedle (string) dueDatege (string) dueDatele (string) estimatedCreditDatege (string) estimatedCreditDatele (string) externalReference (string)
get_v3_finance_split_statistics	Recuperar valores de split	No parameters
get_v3_my_account_commercial_info	Recuperar dados comerciais	No parameters
post_v3_my_account_commercial_info	Atualizar dados comerciais	data: { . personType (string) . cpfCnpj (string) . birthDate (string) . companyType (string) . companyName (string) . incomeValue (number) . email (string) . phone (string) . mobilePhone (string) . site (string) . postalCode (string) . address (string) . addressNumber (string) . complement (string) . province (string) } (object) required
post_v3_my_account_payment_checkout_config	Salvar personalização da fatura	data: { . logoBackgroundColor (string) . infoBackgroundColor (string) . fontColor (string) . enabled (boolean) . logoFile (object) } (object) required
get_v3_my_account_payment_checkout_config	Recuperar configurações de personalização	No parameters
get_v3_my_account_account_number	Recuperar número de conta no Asaas	No parameters
get_v3_my_account_fees	Recuperar taxas da conta	No parameters
get_v3_my_account_status	Consultar situação cadastral da conta	No parameters
get_v3_wallets	Recuperar WalletId	No parameters
delete_v3_my_account	Excluir subconta White Label	removeReason (string)
post_v3_webhooks	Criar novo webhook	data: { . name (string) . url (string) . email (string) . enabled (boolean) . interrupted (boolean) . apiVersion (integer) . authToken (string) . sendType (string) . events (array) } (object) required
get_v3_webhooks	Endpoint para listar todos os Webhooks cadastrados na sua conta.	offset (integer) limit (integer)
get_v3_webhooks_by_id	Este endpoint recupera um único webhook de acordo com o ID informado.	id (string)
put_v3_webhooks_by_id	Utilize este endpoint para atualizar informações de um webhook já cadastrado.	id (string) data: { . name (string) . url (string) . sendType (string) . enabled (boolean) . interrupted (boolean) . authToken (string) . events (array) } (object) required
delete_v3_webhooks_by_id	Este endpoint remove um webhook.	id (string)
post_v3_webhooks_by_id_remove_backoff	Utilize este endpoint para remover a penalização de todos os webhooks penalizados de uma configuração.	id (string) data: { } (object) required
post_v3_accounts	Criar subconta	data: { . name (string) . email (string) . loginEmail (string) . cpfCnpj (string) . birthDate (string) . companyType (string) . phone (string) . mobilePhone (string) . site (string) . incomeValue (number) . address (string) . addressNumber (string) . complement (string) . province (string) . postalCode (string) . webhooks (array) } (object) required
get_v3_accounts	Listar subcontas	offset (integer) limit (integer) cpfCnpj (string) email (string) name (string) walletId (string)
get_v3_accounts_by_id	Recuperar uma única subconta	id (string)
delete_v3_accounts_by_id	Encerra uma subconta não-BaaS. Esta ação é irreversível e não é permitida para subcontas já encerradas.	id (string)
post_v3_accounts_by_id_resend_activation_link	Reenvia o link de redefinição de senha da subconta não-BaaS. Este reenvio pode ser feito apenas uma vez e tem o intuito de recuperar o acesso pelo e-mail cadastrado no login da subconta.	id (string) data: { } (object) required
post_v3_accounts_by_id_access_tokens	Criar chave de API para uma subconta	id (string) data: { . name (string) . expirationDate (string) } (object) required
get_v3_accounts_by_id_access_tokens	Listar chaves de API de uma subconta	id (string)
put_v3_accounts_by_id_access_tokens_by_access_token_id	Atualizar chave de API de uma subconta	id (string) accessTokenId (string) data: { . name (string) . enabled (boolean) . expirationDate (string) } (object) required
delete_v3_accounts_by_id_access_tokens_by_access_token_id	Excluir chave de API de uma subconta	id (string) accessTokenId (string)
get_v3_my_account_documents	Verificar documentos pendentes	No parameters
post_v3_my_account_documents_by_id	Enviar documentos	id (string) data: { . documentFile (object) . type (string) } (object) required
get_v3_my_account_documents_files_by_id	Visualizar documento enviado	id (string)
post_v3_my_account_documents_files_by_id	Atualizar documento enviado	id (string) data: { . documentFile (object) } (object) required
delete_v3_my_account_documents_files_by_id	Remover documento enviado	id (string)
post_v3_sandbox_my_account_approve	Este endpoint aprova a sua conta no ambiente sandbox.	data: { } (object) required
post_v3_sandbox_payment_by_id_confirm	Esse endpoint confirma o pagamento de uma cobrança no ambiente sandbox.	id (string) data: { } (object) required
post_v3_sandbox_payment_by_id_overdue	Esse endpoint força o vencimento de uma cobrança no ambiente sandbox.	id (string) data: { } (object) required
get_v3_payments_by_id_contractual_effect_restrictions	Recuperar efeitos de contrato que estão bloqueando a antecipação de uma cobrança	id (string) offset (integer) limit (integer)
custom	Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body.	_url (string) required _method (string) _query (object) _body _headers (object)

Webhook Events

This connector emits 111 events back to your workflow. To receive one, create a hook whose path is <connection-name>/<event> — the connection name you configured plus the event from the table below.

Event	Description
payment-authorized	Ocorre quando uma cobrança é autorizada cartão pré-autorizado.
payment-awaiting-risk-analysis	Ocorre quando uma cobrança fica aguardando análise de risco manual.
payment-approved-by-risk-analysis	Ocorre quando uma cobrança é aprovada na análise de risco manual.
payment-reproved-by-risk-analysis	Ocorre quando uma cobrança é reprovada na análise de risco manual.
payment-created	Ocorre quando uma cobrança é criada.
payment-updated	Ocorre quando uma cobrança é atualizada.
payment-confirmed	Ocorre quando o pagamento é confirmado crédito ainda não disponível.
payment-received	Ocorre quando o pagamento é recebido e o crédito está disponível.
payment-anticipated	Ocorre quando uma cobrança é antecipada.
payment-overdue	Ocorre quando uma cobrança vence sem pagamento.
payment-deleted	Ocorre quando uma cobrança é removida.
payment-restored	Ocorre quando uma cobrança removida é restaurada.
payment-refunded	Ocorre quando uma cobrança é estornada.
payment-refund-in-progress	Ocorre quando um estorno de cobrança está em andamento.
payment-refund-denied	Ocorre quando um estorno de cobrança é negado.
payment-received-in-cash-undone	Ocorre quando o recebimento em dinheiro é desfeito.
payment-chargeback-requested	Ocorre quando um chargeback é solicitado.
payment-chargeback-dispute	Ocorre quando um chargeback entra em disputa.
payment-awaiting-chargeback-reversal	Ocorre quando um chargeback aguarda reversão.
payment-dunning-received	Ocorre quando um processo de negativação recebe pagamento.
payment-dunning-requested	Ocorre quando uma negativação é solicitada.
payment-bank-slip-cancelled	Ocorre quando um boleto é cancelado.
payment-bank-slip-viewed	Ocorre quando um boleto é visualizado.
payment-checkout-viewed	Ocorre quando a página de pagamento checkout é visualizada.
payment-credit-card-capture-refused	Ocorre quando a captura no cartão de crédito é recusada.
payment-partially-refunded	Ocorre quando uma cobrança é estornada parcialmente.
payment-split-cancelled	Ocorre quando um split de cobrança é cancelado.
payment-split-divergence-block	Ocorre quando um split é bloqueado por divergência.
payment-split-divergence-block-finished	Ocorre quando o bloqueio de split por divergência é encerrado.
invoice-created	Ocorre quando uma nota fiscal é criada.
invoice-updated	Ocorre quando uma nota fiscal é atualizada.
invoice-synchronized	Ocorre quando uma nota fiscal é sincronizada com a prefeitura.
invoice-authorized	Ocorre quando uma nota fiscal é autorizada.
invoice-processing-cancellation	Ocorre quando o cancelamento da nota fiscal está em processo.
invoice-canceled	Ocorre quando uma nota fiscal é cancelada.
invoice-cancellation-denied	Ocorre quando o cancelamento da nota fiscal é negado.
invoice-error	Ocorre quando a nota fiscal apresenta erro.
transfer-created	Ocorre quando uma transferência é criada.
transfer-pending	Ocorre quando uma transferência fica pendente.
transfer-in-bank-processing	Ocorre quando a transferência está em processamento bancário.
transfer-blocked	Ocorre quando uma transferência é bloqueada.
transfer-done	Ocorre quando uma transferência é concluída.
transfer-failed	Ocorre quando uma transferência falha.
transfer-cancelled	Ocorre quando uma transferência é cancelada.
bill-created	Ocorre quando um pagamento de conta é criado.
bill-pending	Ocorre quando um pagamento de conta fica pendente.
bill-bank-processing	Ocorre quando o pagamento de conta está em processamento pelo banco.
bill-paid	Ocorre quando o pagamento de conta é confirmado.
bill-cancelled	Ocorre quando o pagamento de conta é cancelado.
bill-failed	Ocorre quando o pagamento de conta falha.
bill-refunded	Ocorre quando o pagamento de conta é estornado.
receivable-anticipation-cancelled	Ocorre quando uma antecipação de recebível é cancelada.
receivable-anticipation-scheduled	Ocorre quando uma antecipação de recebível é agendada.
receivable-anticipation-pending	Ocorre quando uma antecipação de recebível fica pendente.
receivable-anticipation-credited	Ocorre quando uma antecipação de recebível é creditada.
receivable-anticipation-debited	Ocorre quando uma antecipação de recebível é debitada.
receivable-anticipation-denied	Ocorre quando uma antecipação de recebível é negada.
receivable-anticipation-overdue	Ocorre quando uma antecipação de recebível fica em atraso.
mobile-phone-recharge-pending	Ocorre quando uma recarga de celular fica pendente.
mobile-phone-recharge-cancelled	Ocorre quando uma recarga de celular é cancelada.
mobile-phone-recharge-confirmed	Ocorre quando uma recarga de celular é confirmada.
mobile-phone-recharge-refunded	Ocorre quando uma recarga de celular é estornada.
account-status-bank-account-info-approved	Ocorre quando os dados bancários da conta são aprovados.
account-status-bank-account-info-awaiting-approval	Ocorre quando os dados bancários da conta aguardam aprovação.
account-status-bank-account-info-pending	Ocorre quando os dados bancários da conta ficam pendentes.
account-status-bank-account-info-rejected	Ocorre quando os dados bancários da conta são rejeitados.
account-status-commercial-info-approved	Ocorre quando as informações comerciais da conta são aprovadas.
account-status-commercial-info-awaiting-approval	Ocorre quando as informações comerciais da conta aguardam aprovação.
account-status-commercial-info-expired	Ocorre quando as informações comerciais da conta expiram.
account-status-commercial-info-expiring-soon	Ocorre quando as informações comerciais da conta estão próximas de expirar.
account-status-commercial-info-pending	Ocorre quando as informações comerciais da conta ficam pendentes.
account-status-commercial-info-rejected	Ocorre quando as informações comerciais da conta são rejeitadas.
account-status-document-approved	Ocorre quando os documentos da conta são aprovados.
account-status-document-awaiting-approval	Ocorre quando os documentos da conta aguardam aprovação.
account-status-document-pending	Ocorre quando os documentos da conta ficam pendentes.
account-status-document-rejected	Ocorre quando os documentos da conta são rejeitados.
account-status-general-approval-approved	Ocorre quando a aprovação geral da conta é concedida.
account-status-general-approval-awaiting-approval	Ocorre quando a aprovação geral da conta aguarda revisão.
account-status-general-approval-pending	Ocorre quando a aprovação geral da conta fica pendente.
account-status-general-approval-rejected	Ocorre quando a aprovação geral da conta é rejeitada.
subscription-created	Ocorre quando uma assinatura é criada.
subscription-updated	Ocorre quando uma assinatura é atualizada.
subscription-inactivated	Ocorre quando uma assinatura é inativada.
subscription-deleted	Ocorre quando uma assinatura é removida.
subscription-split-disabled	Ocorre quando o split de uma assinatura é desabilitado.
subscription-split-divergence-block	Ocorre quando o split de uma assinatura é bloqueado por divergência.
subscription-split-divergence-block-finished	Ocorre quando o bloqueio por divergência do split de uma assinatura é encerrado.
checkout-created	Ocorre quando um checkout é criado.
checkout-canceled	Ocorre quando um checkout é cancelado.
checkout-expired	Ocorre quando um checkout expira.
checkout-paid	Ocorre quando um checkout é pago.
balance-value-blocked	Ocorre quando parte do saldo é bloqueada.
balance-value-unblocked	Ocorre quando parte do saldo é desbloqueada.
internal-transfer-credit	Ocorre quando uma transferência interna gera um crédito.
internal-transfer-debit	Ocorre quando uma transferência interna gera um débito.
access-token-created	Ocorre quando uma chave de API é criada.
access-token-deleted	Ocorre quando uma chave de API é removida.
access-token-disabled	Ocorre quando uma chave de API é desabilitada.
access-token-enabled	Ocorre quando uma chave de API é habilitada.
access-token-expired	Ocorre quando uma chave de API expira.
access-token-expiring-soon	Ocorre quando uma chave de API está próxima de expirar.
pix-automatic-recurring-authorization-created	Ocorre quando uma autorização de Pix Automático é criada.
pix-automatic-recurring-authorization-activated	Ocorre quando uma autorização de Pix Automático é ativada.
pix-automatic-recurring-authorization-cancelled	Ocorre quando uma autorização de Pix Automático é cancelada.
pix-automatic-recurring-authorization-expired	Ocorre quando uma autorização de Pix Automático expira.
pix-automatic-recurring-authorization-refused	Ocorre quando uma autorização de Pix Automático é recusada.
pix-automatic-recurring-payment-instruction-created	Ocorre quando uma instrução de pagamento de Pix Automático é criada.
pix-automatic-recurring-payment-instruction-scheduled	Ocorre quando uma instrução de pagamento de Pix Automático é agendada.
pix-automatic-recurring-payment-instruction-refused	Ocorre quando uma instrução de pagamento de Pix Automático é recusada.
pix-automatic-recurring-payment-instruction-cancelled	Ocorre quando uma instrução de pagamento de Pix Automático é cancelada.
pix-automatic-recurring-eligibility-updated	Ocorre quando a elegibilidade para Pix Automático é atualizada.

Authentication​

How to use​

Using the Smart Chat​

Using the Web Editor​

Available Actions​

Webhook Events​