BTG Pactual Empresas (Custom App)

Connect your BTG Pactual Empresas account using your own OAuth application: payroll, collections, Pix, payments, credit and more.

Authentication

This connector uses OAuth 2.0 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 224 actions:

Action	Purpose	Parameters
apis_developers_recebiveis_de_cartao_de_credito/get_credit_card_receivables	Obtém lista de recebíveis ainda disponíveis para antecipar hoje	pageSize (number) pageNumber (number)
apis_developers_recebiveis_de_cartao_de_credito/post_credit_card_receivables	Obtém os recebíveis disponíveis para antecipação de acordo com os parâmetros informados e visualiza informações de taxa média e prazo médio.	data: { . valorDesejado (string) . bandeiras (array) . sacados (array) . tipoConsulta (string) . tipoAproximacaoValorDesejado (string) } (object) required
apis_developers_recebiveis_de_cartao_de_credito/get_credit_card_receivables_balance_summary	Obtém um resumo dos valores não quitados ou ainda não recebidos pelas credenciadoras dos recebíveis antecipados	No parameters
apis_developers_recebiveis_de_cartao_de_credito/post_credit_card_receivables_operation	Antecipa os recebíveis escolhidos	data: { . disbursementBankAccount . receivables (array) } (object) required
apis_developers_recebiveis_de_cartao_de_credito/get_credit_card_receivables_operation_pool	Obtém os valores máximo, disponível e mínimo para antecipar recebíveis de cartão de crédito	pageSize (number) pageNumber (number)
apis_developers_recebiveis_de_cartao_de_credito/get_credit_card_receivables_operation_by_id	Obtém os recebíveis antecipados e a conta de desembolso da operação	id (number)
apis_developers_recebiveis_de_cartao_de_credito/get_credit_card_receivables_disbursement_accounts	Obtém as contas de desembolso do cliente	No parameters
badcredit/post_batch	API responsável por enviar cobranças para negativação em lote	data: { . collectionIds (array) } (object) required
badcredit/delete_batch	API responsável por enviar cancelamento de negativação em lote	data: { . collectionIds (array) } (object) required
banking_cards_doc/get_by_company_id_banking_cards	Listar cartões	companyId (string) itemsPerPage (integer) cursor (string) page (integer) ownerDocument (string) status (string) last4Digits (string) isContactlessEnabled (boolean) isTravelNoticeEnabled (boolean) isOnlineShoppingEnabled (boolean) isWithdrawalEnabled (boolean) printedName (string) order (string) sortBy (string) limitOperator (string) limitAmount (string)
banking_cards_doc/get_by_company_id_banking_cards_invoices	Listar faturas de cartão de crédito	companyId (string)
banking_cards_doc/get_by_company_id_banking_cards_invoices_by_invoice_id	Visualizar detalhes da fatura do cartão de crédito	companyId (string) invoiceId (string)
banking_cards_doc/get_by_company_id_banking_cards_invoices_by_invoice_id_transactions	Visualizar transações da fatura do cartão de crédito	companyId (string) invoiceId (string) cursor (string) itemsPerPage (integer) page (integer)
banking_payment_recurrences/post_payments_recurrences	Criar recorrência de pagamento	data: { . type (string) . periodicity . basePayment . recurringPaymentDates (array) } (object) required
banking_payment_recurrences/get_payments_recurrences	Listar recorrências	No parameters
banking_payment_recurrences/get_payments_recurrences_by_recurrence_id	Consultar recorrência de pagamento	recurrenceId (string)
banking_payment_recurrences/delete_payments_recurrences_by_recurrence_id	Cancelar recorrência de pagamento	recurrenceId (string)
banking_payment_recurrences/patch_payments_recurrences_by_recurrence_id	Alterar recorrência de pagamento	recurrenceId (string) data: { . type (string) . detail (object) } (object) required
banking_payment_recurrences/get_payments_recurrences_by_recurrence_id_payments	Listar pagamentos de recorrência	recurrenceId (string)
banking_payment_recurrences/get_payments_recurrences_summary	Resumo de recorrências de pagamento	No parameters
banking_payment_recurrences/post_payments_recurrences_periodicities	No description available	data: { . paymentType (string) . periodicity } (object) required
banking_pix_automatico_cash_in/post_automatic_pix_authorization_flow	Criar Autorização de Pix Automático	data: { . initialDate . finalDate . link . account . amount . totalInstallments . minimumAmountPayee . retryPolicy . period . request . immediatePix } (object) required
banking_pix_automatico_cash_in/delete_automatic_pix_authorization_by_authorization_id	API responsável por cancelar uma autorização de Pix Automático	authorizationId (undefined)
banking_pix_automatico_cash_in/patch_automatic_pix_authorization_by_authorization_id	API responsável por editar uma autorização de Pix Automático	authorizationId (undefined) data: { . initialDate . debtorName . locationId . activationTxId } (object) required
banking_pix_automatico_cash_in/get_automatic_pix_authorization	API responsável por listar as autorização de Pix Automático	pageSize (undefined) required pageNumber (undefined) required contract (undefined)
banking_pix_automatico_cash_in/post_automatic_pix_authorization_by_authorization_id_scheduling_instruction	API responsável por criar agendamento de uma cobrança de Pix Automático	authorizationId (undefined) data: { . scheduledDate . amount . additionalInformation . txId } (object) required
banking_pix_automatico_cash_in/get_automatic_pix_authorization_by_authorization_id_scheduling_instruction	API responsável por listar as cobranças agendadas de uma autorização de Pix Automático	authorizationId (undefined) pageSize (undefined) required pageNumber (undefined) required
banking_pix_automatico_cash_in/delete_automatic_pix_scheduling_instruction_by_scheduling_instruction_id	API responsável por cancelar agendamento de uma cobrança de Pix Automático	schedulingInstructionId (undefined)
banking_pix_automatico_cash_in/post_events_authorization	Este evento é publicado quando uma autorização é criada ou ocorre alguma mudança de status.	data: { . authorizationId . createdAt . link . status . period . retryPolicy . updatedAt . initialDate . finalDate . requests (array) . origin . payer . payee . location . amount . minimumAmountPayee . approvedAt . canceledAt . cancellationCode . cancellationDescription . rejectedAt . rejectionCode . rejectionDescription . activation . qrCodeInfo . totalInstallments } (object) required
banking_pix_automatico_cash_in/post_events_scheduling_instruction	Este evento é publicado quando um agendamento é criado ou ocorre alguma mudança de status.	data: { . schedulingId . authorizationId . createdAt . updatedAt . installmentNumber . scheduledDate . status . amount . periodInitialDate . periodFinalDate . additionalInformation . cancellationCode . settledAt . confirmedAt . rejectedAt . rejectionDescription . rejectionCode . attempt . firstTxId . paymentEndToEndId . paymentTxId . origin . payer } (object) required
batch_payments/post_by_company_id_banking_batch_payments	Abrir Lote	companyId (string) data: { . taxId (string) } (object) required
batch_payments/patch_by_company_id_banking_batch_payments_by_batch_id	Processar Lote	companyId (string) batchId (string) data: { . isFinished (boolean) } (object) required
batch_payments/delete_by_company_id_banking_batch_payments_by_batch_id	Abandonar Lote	companyId (string) batchId (string)
cambio/get_hubfx_currency	Consulta das moedas disponíveis.	No parameters
cambio/post_hubfx_quote_indicative	Consulta da cotação indicativa da moeda e do tipo de fluxo.	data: { . code (string) . flowType (string) } (object) required
cedente_simples/post_simple_party_natural_person	Criação de um processo de registro, validação, fraudes e compliance de entidade nos sistemas internos do BTG.	data: { . workflowConfigurationId (string) . name (string) . identification (string) . birthDate (string) . phoneNumber (string) . phoneNumberType (string) . emailAddress (string) . emailAddressType (string) . addresses (array) . documents (array) . spouse (object) . maritalStatus (string) . propertyRegime (string) . integrationType (string) . legalPersonality (string) } (object) required
cedente_simples/post_simple_party_company	Criação de um processo de registro, validação, fraudes e compliance de entidade nos sistemas internos do BTG.	data: { . workflowConfigurationId (string) . name (string) . identification (string) . birthDate (string) . phoneNumber (string) . phoneNumberType (string) . emailAddress (string) . emailAddressType (string) . addresses (array) . documents (array) . spouse (object) . maritalStatus (string) . propertyRegime (string) . integrationType (string) . legalPersonality (string) } (object) required
collections/post_collections	API responsável por criar uma cobrança. O contrato da API pode mudar dependendo do tipo da cobrança emitida. Verifique os campos de acordo com o tipo da cobrança	data (undefined) required
collections/get_collections	API responsável por listar cobranças	pageSize (undefined) required pageNumber (undefined) required types (undefined) id (undefined) barcode (undefined) digitableLine (undefined) documentNumber (undefined) ourNumber (undefined) startCreatedAt (undefined) endCreatedAt (undefined) status (undefined) payer.name (undefined) payer.taxId (undefined) batchId (undefined) correlationId (undefined) updatedAt (undefined) startDueDate (undefined) endDueDate (undefined) startSettledAt (undefined) endSettledAt (undefined) badCredit.status (undefined) isAnticipated (undefined) cursor (undefined)
collections/post_collections_batch	API responsável por criar cobranças em lote. O contrato da API pode mudar dependendo do tipo da cobrança emitida. Verifique os campos de acordo com o tipo da cobrança	data: { . batchId . number . branchCode . agreement . collections (array) } (object) required
collections/put_collections_by_collection_id	API responsável por atualizar uma cobrança. O contrato da API pode mudar dependendo do tipo da cobrança atualizada. Verifique os campos de acordo com o tipo da cobrança	collectionId (undefined) data (undefined) required
collections/delete_collections_by_collection_id	API responsável por cancelar uma cobrança	collectionId (undefined)
collections/get_collections_by_collection_id	API responsável por buscar uma cobrança. Pode retornar os dados em json ou PDF.	collectionId (undefined) Accept (undefined) required
collections/post_collections_bad_credit_batch	API responsável por enviar cobranças para negativação em lote	data: { . collectionIds (array) } (object) required
collections/delete_collections_bad_credit_batch	API responsável por enviar cancelamento de negativação em lote	data: { . collectionIds (array) } (object) required
creditasservice/post_v1_credit_conciliation_by_agreement_id	O objetivo dessa rota é a criação de um novo pedido de repasse de pagamentos em lote.	agreementId (string) data: { . s3Url (string) } (object) required
creditasservice/get_v1_credit_conciliation_by_agreement_id_by_credit_conciliation_order_id	O objetivo dessa rota é a consulta do status de pedido de repasse de pagamentos em lote.	agreementId (string) creditConciliationOrderId (string)
dda/post_direct_debit	Ativar DDA para o usuário	data: { . tags (array) } (object) required
dda/get_direct_debit	Consultar DDA por ID	No parameters
dda/delete_direct_debit	Desativar DDA para o usuário	No parameters
dda/get_direct_debit_debits	Consultar DDAs de um emissor específico	pageNumber (integer) pageSize (integer) payeeDocument (string) payeeBankCode (string) status (string) minAmount (number) maxAmount (number) minDueDate (string) maxDueDate (string) hidden (boolean)
dda/patch_direct_debit_debits	Modificar DDA	data: { . items (array) } (object) required
dda/get_direct_debit_debits_by_id	Consultar dados de um débito específico	id (string)
dda/get_direct_debit_debits_summary	Consultar resumo de débitos	No parameters
dda/post_direct_debit_configs	Criar nova configuração	data: { . items (array) } (object) required
dda/delete_direct_debit_configs	Apagar configuração	payeeDocuments (string) required configType (string) required
fidc/post_simulation	Criação de uma simulação usando o simulador com configurações pré estabelecidas via identificador do convênio	data: { . agreementId (string) . amount (number) . interestRate (number) . startDate (string) . minimumInstallmentAmount (number) . maximumInstallmentAmount (number) . minimumInstallments (number) . maximumInstallments (number) . firstPaymentDate (string) . paymentDay (number) . fees (array) } (object) required
fidc/post_document	Envio de documentos auxiliares da operação de crédito.	data: { . fund (string) . files (array) } (object) required
fidc/post_eligibility	Esta rota serve para realizar a pré elegibilidade de um credito.	data: { . externalAssetId (string) . buyerTaxId . value (number) . settlementDate (string) . contractNumber (string) . fund (string) . rate (number) . maturityValue (number) . contractDate (string) } (object) required
fidc/post_operation	Essa rota serve para realizar a cessão de crédito ou emprestimo.	data: { . AgreementId (string) . ExternalId (string) . TaxIdCounterparty (string) . Term (number) . TotalAmount (number) . Interest (object) . LatePaymentCharges (object) . PurchaseInformation (object) . Amount (number) . Rate (number) . AssignmentRate (number) . Tax (number) . Arrears (number) . Penalty (number) . LatePaymentRate (number) . Charges (number) . Cet (number) . BaseDayCount (number) . AcquisitionAmount (number) . ClientNetAmount (number) . BaseDate (string) . SettlementDate (string) . FundingDate (string) . FirtsInstallmentDate (string) . OperationType (string) . Settlement (object) . Disbursement (object) . Contract (object) . Installments (array) . OtherFees (array) . Fees (array) . GenericIdentifiers (array) . RelatedOperations (array) . WarrantyIdentification (string) } (object) required
fidc/get_wallet	O objetivo dessa rota é pesquisar uma carteira de operações por fundo especifico.	pag (integer) fundName (undefined)
fidc/get_contract_wallet	O objetivo dessa rota é pesquisar a carteira de algum contrato ou contraparte especifica.	taxId (undefined) identification (undefined)
fidc/post_warranty	O objetivo dessa rota é criar uma garantia	data: { . files (array) . warranties (array) } (object) required
fidc/post_settlement	O objetivo desta rota é cadastrar um pedido de pagamento de crédito.	agreementId (string) required data: { . payerTaxId (string) . payment (object) . contracts (array) } (object) required
fidc/get_settlement_by_settlement_id	O objetivo dessa rota é pesquisar um pedido de pagamento previamente cadastrado.	settlementId (string) agreementId (string) required
fidc_credit_actions/post_portabilities	Criação de um pedido de portabilidade out	data: { . contract_number (string) . registration_identification (string) . proposer_ispb (string) . proposer_tax_id (string) . portability_date (string) } (object) required
fidc_credit_actions/post_portabilities_by_portability_id_confirm	Confirmação de uma portabilidade out a partir de um pedido existente	portabilityId (string) data: { . settlement_method (string) . datetime (string) } (object) required
fidc_credit_actions/post_portabilities_by_portability_id_cancel	Cancelamento de uma portabilidade out a partir de um pedido existente	portabilityId (string) data: { . datetime (string) } (object) required
fidc_fifi/get_agreement	No description available	Limit (integer) Offset (integer) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/get_agreement_by_agreement_id	No description available	agreementId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/post_averbation_by_fund_tax_id	Envio do Arquivo de Averbação	FundTaxId (string) Authorization (string) required data: { . s3Url (string) } (object) required
fidc_fifi/post_bookkeeping_by_fund_tax_id	Envio do Arquivo de Escrituração	FundTaxId (string) Authorization (string) required data: { . s3Url (string) } (object) required
fidc_fifi/get_creditengine_by_fund_tax_id_customers_evaluation_by_correlation_id	Obtenção do retorno da análise de pré-aprovação da base de clientes	FundTaxId (string) CorrelationId (string) Authorization (string) required
fidc_fifi/post_creditengine_by_fund_tax_id_customers_evaluation	Envio da base de clientes para análise de pré-aprovação no Motor de Crédito	FundTaxId (string) Authorization (string) required data: { . s3Url (string) } (object) required
fidc_fifi/post_creditengine_by_fund_tax_id_customer_evaluation	Consulta Online no Motor de Crédito	FundTaxId (string) Authorization (string) required data: { . proposalId (string) . inlet . requestedAmount (number) . requestedInstallments (integer) . client . employer } (object) required
fidc_fifi/get_creditengine_proposal_by_proposal_id	Verifica se o ProposalId é valido e não expirado	ProposalId (string) Authorization (string) required
fidc_fifi/post_documents	No description available	Authorization (string) required data: { . documents (array) } (object) required
fidc_fifi/get_entity	No description available	Filter (string) Limit (integer) Offset (integer) FundTaxId (string) required RequestorId (string) required Authorization (string) required
fidc_fifi/get_entity_by_entity_id	No description available	EntityId (string) RequestorId (string) required Authorization (string) required
fidc_fifi/patch_entity_by_entity_guid	No description available	EntityGuid (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required data: { . name (string) . type . email (string) . phoneNumber (string) . cge (string) . stateIdentification (string) . onboardingStatus } (object) required
fidc_fifi/post_entity_by_entity_guid_entityaddress	No description available	EntityGuid (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required data: { . postalCode (string) . address (string) . city (string) . neighborhood (string) . state (string) . country (string) } (object) required
fidc_fifi/put_entity_by_entity_guid_entityaddress_by_entity_address_guid	No description available	EntityAddressGuid (string) EntityGuid (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required data: { . postalCode (string) . address (string) . city (string) . neighborhood (string) . state (string) . country (string) } (object) required
fidc_fifi/delete_entity_by_entity_guid_entityaddress_by_entity_address_guid	No description available	EntityAddressGuid (string) EntityGuid (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/post_entity_by_entity_guid_bankaccount	No description available	EntityGuid (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required data: { . bankCode (integer) . agency (string) . agencyDigit (string) . accountNumber (string) . accountDigit (string) . holderTaxId (string) . bankAccountType } (object) required
fidc_fifi/put_entity_by_entity_guid_bankaccount_by_bank_account_guid	No description available	BankAccountGuid (string) EntityGuid (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required data: { . bankCode (integer) . agency (string) . agencyDigit (string) . accountNumber (string) . accountDigit (string) . holderTaxId (string) . bankAccountType } (object) required
fidc_fifi/delete_entity_by_entity_guid_bankaccount_by_bank_account_guid	/entity/EntityGuid/bankaccount/BankAccountGuid	BankAccountGuid (string) EntityGuid (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/get_entity_by_entity_guid_loans	No description available	EntityGuid (string) FundTaxId (string) required Limit (integer) Offset (integer) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/get_entityagreement	No description available	Limit (integer) Offset (integer) FundTaxId (string) required EntityId (string) required RequestorId (string) required Authorization (string) required
fidc_fifi/get_entityagreement_by_entity_agreement_id	No description available	EntityAgreementId (string) RequestorId (string) required Authorization (string) required
fidc_fifi/get_entityagreement_by_entity_agreement_id_avalists	No description available	EntityAgreementId (string) Filter (string) Limit (integer) Offset (integer) RequestorId (string) required Authorization (string) required
fidc_fifi/get_entityagreement_by_entity_agreement_id_signers	No description available	EntityAgreementId (string) Amount (number) required SignatoryType (string) required AvalistEntityId (string) RequestorId (string) required Authorization (string) required
fidc_fifi/get_loan	No description available	FromDate (string) ToDate (string) Status (array) Identification (array) Limit (integer) Offset (integer) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/post_loan	No description available	RequestorId (string) required EntityAgreementId (string) required Authorization (string) required data: { . preLoanId (string) . documentsIds (array) } (object) required
fidc_fifi/get_loan_by_loan_id	No description available	LoanId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/post_offboarding_by_fund_tax_id	Envio do arquivo de Desligamento dos Funcionários	FundTaxId (string) Authorization (string) required data: { . s3Url (string) } (object) required
fidc_fifi/post_participantsfile	No description available	Authorization (string) required data: { . fundTaxId (string) } (object) required
fidc_fifi/get_preloan	No description available	FromDate (string) ToDate (string) Status (array) Identification (array) Limit (integer) Offset (integer) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/post_preloan	No description available	RequestorId (string) required EntityAgreementId (string) required Authorization (string) required data: { . principal (number) . installments (integer) . monthlyRate (number) . firstInstallmentDate (string) . paymentDate (integer) . simulationExecutionId (string) . simulationOperationId (string) } (object) required
fidc_fifi/get_preloan_by_pre_loan_id	No description available	PreLoanId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/delete_preloan_by_pre_loan_id	No description available	PreLoanId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/post_preloan_by_pre_loan_id_signers	No description available	PreLoanId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required data: { . signersId (array) } (object) required
fidc_fifi/delete_preloan_by_pre_loan_id_signers	No description available	PreLoanId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/post_preloan_by_pre_loan_id_account	No description available	PreLoanId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required data: { . requestorId (string) . entityAgreementId (string) . bankAccountId (string) } (object) required
fidc_fifi/post_preloan_by_pre_loan_id_avalist	No description available	PreLoanId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required data: { . avalistEntityId (string) . signersId (array) } (object) required
fidc_fifi/delete_preloan_by_pre_loan_id_avalist_by_avalist_id	No description available	PreLoanId (string) AvalistId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/post_preloan_by_pre_loan_id_warranty_vehicle_by_chassi	No description available	Chassi (string) PreLoanId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required data: { . identification (string) } (object) required
fidc_fifi/post_preloan_by_pre_loan_id_warranty_vehicle_by_warranty_id_revalidate	No description available	WarrantyId (string) PreLoanId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/put_preloan_by_pre_loan_id_warranty_vehicle_by_warranty_id	No description available	PreLoanId (string) WarrantyId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required data: { . warrantyInfo (object) } (object) required
fidc_fifi/get_preloan_by_pre_loan_id_warranty	No description available	PreLoanId (string) Limit (integer) Offset (integer) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/get_preloan_by_pre_loan_id_warranty_by_warranty_id	No description available	WarrantyId (string) PreLoanId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/delete_preloan_by_pre_loan_id_warranty_by_warranty_id	No description available	WarrantyId (string) PreLoanId (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_fifi/get_requestor	No description available	RequestorTaxId (string) required RequestorType (string) required Authorization (string) required
fidc_fifi/get_warranty_template_by_warranty_type	No description available	warrantyType (string) RequestorId (string) required EntityAgreementId (string) required Authorization (string) required
fidc_renegotiation/get_renegotiation_by_customer_tax_id_contracts	O objetivo dessa rota é consultar os contratos passivéis de renegociação agrupados por elegibilidade.	customer_tax_id (undefined) fund_tax_id (undefined) required
fidc_renegotiation/get_renegotiation_by_customer_tax_id_campaigns	O objetivo dessa rota é consultar as campanhas ativas dos contratos.	customer_tax_id (undefined) fund_tax_id (undefined) required contract (undefined) required
fidc_renegotiation/post_renegotiation_by_customer_tax_id_simulate	O objetivo dessa rota é simular uma renegociação para os contratos	customer_tax_id (undefined) data: { . contracts (array) . first_payment_date (string) . campaign_code (string) . installments_count (number) } (object) required
fidc_renegotiation/post_renegotiation_by_customer_tax_id	O objetivo dessa rota é confirmar uma renegociação para uma simulação criada	customer_tax_id (undefined) data: { . first_payment_method_id (number) . installments_count (number) . installments_payment_method_id (number) . simulation_id (string) } (object) required
fidc_renegotiation/delete_renegotiation_by_customer_tax_id_agreement_by_agreement_id	O objetivo dessa rota é cancelar um acordo de renegociação antes do pagamento da parcela de boa fé	customer_tax_id (undefined) agreement_id (undefined)
fidc_renegotiation/get_renegotiation_by_customer_tax_id_agreement_by_agreement_id_installment_by_installment_number_bankslip	O objetivo dessa rota é consultar um boleto por parcela de um acordo de renegociação	customer_tax_id (undefined) agreement_id (undefined) installment_number (undefined)
fidc_vr/post_creditengine_by_fund_tax_id_customers_evaluation	Envio da base de clientes para análise de pré-aprovação	fundTaxId (string) data: { . s3Url (string) } (object) required
fidc_vr/get_creditengine_by_fund_tax_id_customers_evaluation_by_correlation_id	Obtenção do retorno da análise de pré-aprovação da base de clientes	fundTaxId (string) correlationId (undefined)
fidc_vr/post_creditengine_by_fund_tax_id_customer_evaluation	Análise detalhada por cliente específico.	fundTaxId (string) data: { . proposalId (string) . inlet (string) . requestedAmount (number) . requestedInstallments (number) . client (object) . employer (object) } (object) required
fidc_vr/post_bookkeeping_by_fund_tax_id	Envio do Arquivo de Escrituração	fundTaxId (string) data: { . s3Url (string) } (object) required
fidc_vr/post_offboarding_by_fund_tax_id	Envio do arquivo de Desligamento dos funcionários	fundTaxId (string) data: { . s3Url (string) } (object) required
kgiro_hub_credit_manager/post_form_kgiro_start	No description available	data: { . workflowLeadCanonical } (object) required
old_banking/get_companies_by_company_id_pix_cash_in_locations	Obtém a lista de locations	companyId (string)
old_banking/post_companies_by_company_id_pix_cash_in_locations	Criar QR Code	companyId (string) data: { . type (string) . description (string) } (object) required
old_banking/delete_companies_by_company_id_pix_cash_in_locations_by_location_id	Desvincular QR Code da cobrança.	companyId (string) locationId (string)
old_banking/get_companies_by_company_id_pix_cash_in_instant_collections	Obter lista de cobraças	companyId (string) locationId (string) initialDate (string) finalDate (string) onlyActive (string)
old_banking/post_companies_by_company_id_pix_cash_in_instant_collections	Criar cobrança	companyId (string) data: { . pixKey (string) . locationId . expiresIn (number) . amount (object) . displayText (string) . payer . tags (object) } (object) required
old_banking/get_bank_slips	Listar boletos	Accept (undefined) required accountId (string) required offset (integer) limit (integer) bankSlipId (string) barcode (string) digitableline (string) referenceNumber (string) startDate (string) endDate (string) startDueDate (string) endDueDate (string) status (string) startPaymentDate (string) endPaymentDate (string) payer.name (string) payer.taxId (string) batchId (string) correlationId (string)
old_banking/post_bank_slips	Criar Boleto	accountId (string) required data: { . amount (number) . dueDate (string) . overDueDate (string) . referenceNumber (string) . description (string) . payer . installments (integer) . interests (object) . discounts (array) . deliveryMediums (array) . ourNumber (string) . pixInfo (object) } (object) required
old_banking/post_bank_slips_batches	Criar boletos em lote	accountId (string) required data (array) required
old_banking/put_bank_slips_by_bank_slip_id	Atualizar um boleto	bankSlipId (string) accountId (string) required data: { . amount (number) . dueDate (string) . interests (object) . discounts (array) } (object) required
old_banking/delete_bank_slips_by_bank_slip_id	Cancelar boleto	bankSlipId (string) accountId (string) required
old_banking/get_accounts	Consultar contas que concederam acesso	No parameters
old_banking/get_accounts_by_account_id	Consultar conta por AccountId	accountId (string)
old_banking/get_accounts_balances	Consultar saldo das contas que concederam acesso	No parameters
old_banking/get_accounts_by_account_id_balances	Consultar saldo de uma conta	accountId (string)
old_banking/get_accounts_statements	Consultar extrato das contas que concederam acesso	No parameters
old_banking/get_accounts_by_account_id_statements	Consultar extrato de uma conta específica	accountId (string) startDate (string) endDate (string)
old_banking/get_companies_by_company_id_authorized_direct_debits	Obtém a lista de DDA.	companyId (string) status (string)
old_banking/get_companies_by_company_id_authorized_direct_debits_by_authorized_direct_debit_id_debits	Obtém a lista débitos de um DDA.	companyId (string) authorizedDirectDebitId (string)
onboarding/get_apps_by_client_id_well_known_customers_by_tax_id	Obter informações básicas da empresa cliente no parceiro	clientId (undefined) taxId (undefined) x-correlation-id (string)
onboarding/get_apps_by_client_id_well_known_customers_by_tax_id_addresses	Obter o endereço informações da empresa cliente no parceiro	clientId (undefined) taxId (undefined) x-correlation-id (string)
onboarding/get_apps_by_client_id_well_known_customers_by_tax_id_legal_representatives	Obter os representantes legais da empresa cliente no parceiro	clientId (undefined) taxId (undefined) x-correlation-id (string)
onboarding/get_apps_by_client_id_well_known_customers_by_tax_id_documents	Obter um documento da empresa cliente no parceiro	clientId (undefined) taxId (undefined) x-correlation-id (string)
onboarding/get_apps_by_client_id_well_known_customers_by_tax_id_documents_by_path_suffix	Obter os a lista de documentos existentes da empresa cliente para download no parceiro	clientId (undefined) taxId (undefined) pathSuffix (undefined) x-correlation-id (string)
onboarding_utils/get_onboarding_types_profession	Obter lista de profissões	No parameters
onboarding_utils/get_onboarding_types_address	Obter a lista de estados e cidades	No parameters
openfinance_e_payments_2/get_by_company_id_banking_payments	Listar iniciação de pagamento ou transferência	companyId (string) pageSize (number) required pageNumber (number) required paymentType (string) receiver (string) batchId (string) minPaymentDate (string) maxPaymentDate (string) minAmount (number) maxAmount (number) status (string)
openfinance_e_payments_2/post_by_company_id_banking_payments	Criar iniciação de pagamento ou transferência	companyId (string) x-idempotency-key (string) data (undefined) required
openfinance_e_payments_2/get_by_company_id_banking_payments_by_payment_id	Listar um pagamento ou transferência específico	companyId (string) paymentId (string)
openfinance_e_payments_2/delete_by_company_id_banking_payments_by_payment_id	Cancelar um pagamento ou transferência agendado	companyId (string) paymentId (string)
openfinance_e_payments_2/get_by_company_id_banking_payments_barcodes	Consulta por código de barras	companyId (string) codes (string) required
openfinance_e_payments_2/delete_by_company_id_banking_payments_approvals_by_payment_id	Cancelar pagamento ou transferência pendente de aprovação	companyId (string) paymentId (string)
openfinance_e_payments_2/get_by_company_id_banking_payments_by_payment_id_receipt	Obter recibo	paymentId (string) companyId (string) Accept (string) required
openfinance_e_payments_2/get_v1_accounts_by_account_id	Consultar uma conta específica	accountId (string)
openfinance_e_payments_2/get_v1_accounts_by_account_id_balances	Consultar saldo de uma conta específica	accountId (string)
openfinance_e_payments_2/get_v1_accounts_by_account_id_statements	Consultar extrato de uma conta específica	accountId (string) startDate (string) endDate (string) type (undefined)
openfinance_e_payments_2/get_v1_accounts	Consultar contas	origin (string)
openfinance_e_payments_2/get_v1_accounts_statements	Consultar extrato das contas	No parameters
openfinance_e_payments_2/get_v1_accounts_balances	Consultar saldos das contas	No parameters
outrasapis/post_files	O objetivo dessa rota é fornecer um link pré-assinado temporário do S3 AWS para fazer o upload de qualquer arquivo para a plataforma do BTG Empresas. Após o upload do arquivo, o mesmo ficará disponível na nossa plataforma por até 3 dias corridos, até que seja vinculado a uma operação. Caso o prazo de expiração do arquivo seja atingido e o vinculo não tenha sido feito, será necessário gerar um novo link de upload e enviar o arquivo novamente.	No parameters
paymentlink/post_by_company_id_banking_payment_link	API responsável por criar um link de pagamento	companyId (string) data: { . name . amount . description . account . paymentMethods . notifications . schedule . type } (object) required
paymentlink/get_by_company_id_banking_payment_link	API responsável por listar os links de pagamento de uma empresa	companyId (string) pageSize (undefined) required pageNumber (undefined) required minCreatedAt (undefined) maxCreatedAt (undefined) minStartAt (undefined) maxStartAt (undefined) minEndAt (undefined) maxEndAt (undefined) minAmount (undefined) maxAmount (undefined) status (undefined) type (undefined) name (undefined)
paymentlink/put_by_company_id_banking_payment_link_by_payment_link_id	API responsável por editar um link de pagamento	paymentLinkId (undefined) companyId (string) data: { . name . amount . description . paymentMethods . notifications . schedule } (object) required
paymentlink/delete_by_company_id_banking_payment_link_by_payment_link_id	API responsável por cancelar um link de pagamento	paymentLinkId (undefined) companyId (string)
paymentlink/get_by_company_id_banking_payment_link_by_payment_link_id_collection	API responsável por listar as cobranças um link de pagamento	paymentLinkId (undefined) companyId (string) pageSize (undefined) required pageNumber (undefined) required status (undefined) type (undefined) minCreatedAt (undefined) maxCreatedAt (undefined) payer.name (undefined) payer.taxId (undefined)
payroll/get_by_company_id_banking_payroll_employees	Retorna lista paginada de colaboradores das empresas informadas com filtros opcionais. Paginação por cursor: use o valor de _links.next.href para navegar entre páginas. Status do colaborador: | Status | Significado | |---|---| | active | Colaborador ativo com conta BTG | | pending | Onboarding em andamento, conta ainda não ativada | | suspended | Conta suspensa | | inactive | Colaborador desligado |	companyId (string) companyTaxIds (array) pageSize (integer) cursor (string) status (string) accountType (string) name (string) employeeTaxId (string) branch (string) accountNumber (string) portability (boolean) contractType (string)
payroll/post_by_company_id_banking_payroll_onboarding_employees	Submete um ou mais colaboradores para abertura de conta BTG. O processamento é assíncrono e retorna 202 Accepted imediatamente. O campo issuingAuthority aceita apenas os códigos retornados por GET /companyId/banking/payroll/onboarding/issuers.	companyId (string) X-Idempotency-Key (string) required data (array) required
payroll/get_by_company_id_banking_payroll_onboarding_issuers	Retorna a lista de emissores de documento de identidade disponíveis para onboarding. Use o campo id de cada emissor como valor de issuingAuthority ao cadastrar colaboradores via POST /companyId/banking/payroll/onboarding/employees.	companyId (string)
payroll/get_by_company_id_banking_payroll_payments	Retorna lista paginada dos lotes de pagamento da empresa com filtros opcionais. Paginação por cursor: use o valor de _links.next.href para navegar entre páginas. Nota: A listagem aplica filtro implícito por janela de tempo. Pagamentos fora da janela padrão podem não aparecer mesmo após liquidação. Use startDate e endDate para ampliar o período de busca.	companyId (string) companyTaxIds (array) pageSize (integer) cursor (string) startDate (string) endDate (string) reference (string) status (array) unitPayment (boolean) recurrenceId (integer)
payroll/post_by_company_id_banking_payroll_payments	Submete um lote de pagamentos para processamento assíncrono. Retorna 202 Accepted com o identificador do lote paymentId e requestId. O header X-Idempotency-Key UUID v4 é obrigatório para evitar processamento duplicado em caso de retentativa.	companyId (string) X-Idempotency-Key (string) required data: { . description (string) . scheduledDate (string) . paymentType (integer) . companies (array) } (object) required
payroll/get_by_company_id_banking_payroll_payments_by_payment_id	Retorna o detalhe completo de um lote de pagamento, incluindo status individual de cada item. Estados terminais: settled · failed · cancelled	companyId (string) paymentId (integer) companyTaxIds (array)
payroll/post_by_company_id_banking_payroll_payments_by_request_id_cancel	Cancela um lote de pagamento identificado pelo requestId. Somente lotes nos status submitted ou pending_approval podem ser cancelados.	companyId (string) requestId (string) data: { . reason (string) } (object) required
payroll/get_by_company_id_banking_payroll_employees_by_employee_tax_id	Retorna o detalhe completo de um colaborador da empresa identificado pelo CPF, incluindo dados cadastrais, status, tipo de contrato e informações de conta bancária.	companyId (string) employeeTaxId (string)
payroll/get_by_company_id_banking_payroll_employees_by_employee_tax_id_account	Retorna o estado da conta bancária de um colaborador identificado pelo CPF. Parâmetro bank: | Valor | Comportamento | |---|---| | BTG padrão | Consulta a conta BTG do colaborador | | PAN | Fallback para colaboradores sem conta BTG ativa | Se a requisição sem bank retornar 404, tente com ?bank=PAN. Colaboradores no início do onboarding podem ainda não ter conta BTG ativa.	companyId (string) employeeTaxId (string) bank (string)
payroll/post_by_company_id_banking_payroll_employees_by_employee_tax_id_deactivate	Desliga inativa um colaborador ativo. Somente colaboradores com status active podem ser desligados. Após o desligamento o colaborador passa para o status inactive.	companyId (string) employeeTaxId (string) data: { . terminationDate (string) . reason (string) } (object) required
payroll/post_by_company_id_banking_payroll_employees_by_employee_tax_id_reactivate	Reativa um colaborador inativo. Somente colaboradores com status inactive podem ser reativados. Após a reativação o colaborador retorna ao status active.	companyId (string) employeeTaxId (string)
prepayment/get_prepayment_by_contract_number_balance	O objetivo dessa rota é exibir a posição do contrato.	contract_number (undefined) fund_tax_id (undefined) required position_date (undefined)
prepayment/post_prepayment_by_contract_number_simulate	Essa rota é responsável pela simulação de pré-pagamento, aplicando as regras do fundo para pré-pagamento e retornando o status	contract_number (undefined) data: { . fund_tax_id (string) . installments (array) . position_date (string) } (object) required
prepayment/post_prepayment_by_contract_number_confirm	Essa rota é responsável pela confirmação de uma simulação de pré-pagamento retornando o código de barras do boleto	contract_number (undefined) data: { . simulation_identification (string) } (object) required
prepayment/get_prepayment_by_simulation_identification_bankslip	O objetivo dessa rota é retornar o boleto de pré pagamento	simulation_identification (undefined)
saldoextratoopenfinance/get_by_company_id_banking_accounts_statements	Consultar extratos	companyId (string)
saldoextratoopenfinance/get_by_company_id_banking_accounts_by_account_id_statements	Consultar extrato por accountId	companyId (string) accountId (string) startDate (string) required endDate (string) required type (string) required pageSize (string)
saldoextratoopenfinance/get_by_company_id_banking_accounts	Consultar dados da conta	companyId (string) accountOrigin (string)
saldoextratoopenfinance/get_by_company_id_banking_accounts_by_account_id_balances	Consultar saldo	companyId (string) accountId (string)
saldoextratoopenfinance/get_by_company_id_banking_accounts_by_account_id_statements_pdf	GET pdf base64	companyId (string) accountId (string) startDate (string) required endDate (string) required order (string) required type (string) required
scf_bordero/post_borderos	Esta rota tem como objetivo criar um bordero para Antecipação de Recebíveis. Você nos enviará os recebíveis dos cedentes ou sacados, informando os campos necessários, com a possibilidade de informar a Estratégia cuja função é configurar as taxas da operação.	data: { . receivables (array) . product . strategy (string) } (object) required
scf_bordero/get_borderos_by_tracking_id_receivables	Esta rota serve para consultar os recebíveis de um bordero a partir do 'trackingId' retornado na criação. Na resposta, é possível verificar todos os dados.	trackingId (undefined)
scf_bordero/post_borderos_by_tracking_id_receivables_cancellation	Esta rota serve para cancelar recebíveis de um bordero.	trackingId (undefined) data: { . receivables (array) } (object) required
scf_companies/post_companies_by_payer_tax_id_payees	Esta rota serve para cadastrar novos fornecedores para o sacado.	payerTaxId (undefined) data: { . payees (array) } (object) required
scf_companies/get_companies_by_payer_tax_id_payees_by_payee_tax_id	Consulta dos status de onboardings do fornecedor identificado por 'payeeTaxId'.	payerTaxId (undefined) payeeTaxId (undefined)
scf_companies/post_companies_commercial_strategies	Associação de lote de empresas a uma estratégia comercial.	data: { . companies (array) . strategyUuid (string) } (object) required
scf_core/post_v1_scf_operations	Esta rota serve para criar operações de antecipação com os recebíveis selecionados.	data: { . payerTaxId (string) . payeeTaxId (string) . receivables (array) . account . files (array) . fees (array) } (object) required
scf_core/get_v1_scf_operations_by_operation_id	Esta rota serve para consultar uma operação utilizando o 'operationId' retornado na sua criação.	operationId (integer)
scf_core/post_v1_scf_settlements	O objetivo dessa rota é cadastrar um pedido de liquidação de recebiveis.	data: { . payerTaxId (string) . payment (object) . trades (array) } (object) required
scf_core/get_v1_scf_settlements_by_settlement_id	O objetivo dessa rota é pesquisar um pedido de liquidação previamente cadastrado.	settlementId (string)
scf_core/post_v1_scf_financiers_payer	No description available	data: { . PartnerConfigurationId (string) . Name (string) . Identification (string) . BirthDate (string) . PhoneNumber (string) . EmailAddress (string) . Addresses (array) . Documents (array) } (object) required
scf_onboarding_de_consignado/post_natural_person_payroll_loan_borrower	Criação de um processo de registro, validação, fraudes e compliance de entidade nos sistemas internos do BTG.	data: { . workflowConfigurationId (string) . name (string) . identification (string) . birthDate (string) . phoneNumber (string) . phoneNumberType (string) . emailAddress (string) . emailAddressType (string) . addresses (array) . documents (array) . spouse (object) . maritalStatus (string) . propertyRegime (string) . integrationType (string) . legalPersonality (string) } (object) required
scf_operations/post_operations	Esta rota serve para criar operações de antecipação com os recebíveis selecionados.	data: { . payerTaxId (string) . payeeTaxId (string) . receivables (array) . account . files (array) . fees (array) } (object) required
scf_operations/get_operations_by_operation_id	Esta rota serve para consultar uma operação utilizando o 'operationId' retornado na sua criação.	operationId (integer)
scf_receivables/put_receivables_files	Esta rota tem como objetivo anexar novos arquivos aos recebíveis indicados.	data: { . receivables (array) } (object) required
scf_trades/get_trades	Esta rota serve para consultar a carteira de operações. É obrigatorio o envio das informações do cursor ou do status ou dos tradeIds.	status (undefined) tradeIds (string) payerTaxId (undefined) payeeTaxId (undefined) cursor (string) limit (integer)
scf_trades/get_trades_by_trade_id	O objetivo dessa rota é pesquisar a posição de uma operação especifica realizada anteriormente.	tradeId (string)
solar_creditanalysis/post_credit_analysis	Gerar uma análise de crédito	data: { . primaryOriginatorAs (string) . customerIdentification (string) . customerName (string) . customerEmail (string) . distributorCnpj (string) . integratorCnpj (string) . marketPlaceCnpj (string) . operatorCpf (string) . monthlyBilling (number) . electricBillAverage (number) . projectValue (number) . cep (string) . address (string) . number (string) . complement (string) . district (string) . city (string) . state (string) } (object) required
solar_creditanalysis/get_originators	Verificar se uma determinada empresa está apta a operar o fluxo solar	cnpj (string) required type (string) required
solar_workflow/post_form_solar_invoices	No description available	data: { . workflowLeadCanonical } (object) required
solar_workflow/post_form_solar_invoices_pendencies	No description available	data: { . workflowLeadCanonical } (object) required
solar_workflow/post_form_solar_proposals_accept	No description available	data: { . workflowLeadCanonical } (object) required
solar_workflow/post_form_solar_receipts_installation	No description available	data: { . workflowLeadCanonical } (object) required
solar_workflow/post_form_solar_start	No description available	data: { . workflowLeadCanonical } (object) required
solar_workflow/post_form_solar_documents	No description available	data: { . workflowLeadCanonical } (object) required
solar_workflow/post_form_solar_documents_pendencies	No description available	data: { . workflowLeadCanonical } (object) required
solar_workflow/get_customers_by_customer_identification_operators_by_operator_identification_documents_by_external_identification	No description available	customerIdentification (string) operatorIdentification (string) externalIdentification (string)
solar_workflow/post_form_solar_render_proposals	No description available	data: { . workflowLeadCanonical } (object) required
solar_workflow/post_form_solar_notify_email_proposals	No description available	data: { . workflowLeadCanonical } (object) required
solar_workflow/post_form_solar_income_auth_cards	No description available	data: { . workflowLeadCanonical } (object) required
solar_workflow/post_form_solar_disbursement_receipts	No description available	data: { . workflowLeadCanonical } (object) required
webhooks/post_by_company_id_apps_by_app_id_webhooks	Criar um webhook	companyId (string) appId (string) data: { . appId (string) . endpoint (string) . description (string) . events (array) . messageFilter (object) . tags (object) . idAlias (string) . secret (string) } (object) required
webhooks/get_by_company_id_apps_by_app_id_webhooks_by_webhook_id	Listar o webhook especificado	companyId (string) appId (string) webhookId (string)
webhooks/post_by_company_id_apps_by_app_id_webhooks_by_webhook_id_secret	Alterar a secret de um webhook	companyId (string) appId (string) webhookId (string) data: { . value (string) } (object) required
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 (undefined) _headers (object)

Webhook Events

This connector emits 7 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
bank-slips-paid	Um boleto foi pago liquidado.
bank-slips	Todos os eventos de boletos criação, pagamento, baixa, etc..
transactions-debit	Um débito ocorreu na conta transferência, Pix, tarifa, etc..
transactions	Todos os eventos de transações da conta débitos e créditos.
collections	Todos os eventos de cobranças Pix cobrança, QR codes.
payments	Todos os eventos de pagamentos e transferências.
payroll	Todos os eventos de folha de pagamentos lotes, pagamentos a funcionários.