Skip to main content

Celcoin

Integração com a API BaaS 2.0 da Celcoin para contas, Pix, transferências, cobranças e webhooks.

Celcoin Logo

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 85 actions:

ActionPurposeParameters
get_account_checkVerificar Status da Conta.onboardingId (string)
clientCode (string)
put_account_natural_personConfira nosso tutorial - https://developers.celcoin.com.br/docs/atualizar-dados-da-contaAccount (string)
DocumentNumber (string)
data: {
. phoneNumber (string)
. email (string)
. socialName (string)
. isPoliticallyExposedPerson (boolean)
. address (object)
} (object) required
put_account_businessConfira nosso tutorial - https://developers.celcoin.com.br/docs/atualizar-dados-da-contaAccount (string)
DocumentNumber (string)
data: {
. businessEmail (string)
. contactNumber (string)
. owners (array)
. businessAddress (object)
} (object) required
get_account_fetchConfira nosso tutorial - https://developers.celcoin.com.br/docs/listar-contasAccount (string)
DocumentNumber (string)
get_account_fetch_businessConfira nosso tutorial - https://developers.celcoin.com.br/docs/listar-contasAccount (string)
DocumentNumber (string)
get_account_fetch_allConfira nosso tutorial - https://developers.celcoin.com.br/docs/listar-contasDateFrom (string) required
DateTo (string) required
LimitPerPage (integer)
Page (integer)
Account (string)
DocumentNumber (string)
get_account_fetch_all_businessConfira nosso tutorial - https://developers.celcoin.com.br/docs/listar-contasDateFrom (string) required
DateTo (string) required
Limit (integer)
Page (integer)
put_account_statusConfira nosso tutorial - https://developers.celcoin.com.br/docs/desativar-excluir-a-contaAccount (string)
DocumentNumber (string)
data: {
. status (string)
. reason (string)
} (object) required
delete_account_closeConfira nosso tutorial - https://developers.celcoin.com.br/docs/desativar-excluir-a-contaAccount (string)
DocumentNumber (string)
Reason (string) required
post_account_business_createConfira nosso tutorial - https://developers.celcoin.com.br/docs/criar-contadata: {
. clientCode (string)
. accountOnboardingType (string)
. documentNumber (string)
. contactNumber (string)
. businessEmail (string)
. businessName (string)
. tradingName (string)
. owner (object)
. businessAddress (object)
. cadastraChavePix (boolean)
. financialCompanyDetails (object)
} (object) required
post_account_natural_person_createConfira nosso tutorial - https://developers.celcoin.com.br/docs/criar-contadata: {
. clientCode (string)
. accountOnboardingType (string)
. documentNumber (string)
. phoneNumber (string)
. email (string)
. motherName (string)
. fullName (string)
. socialName (string)
. birthDate (string)
. address (object)
. isPoliticallyExposedPerson (boolean)
. cadastraChavePix (boolean)
. financialDetails (object)
} (object) required
get_wallet_balanceConfira nosso tutorial - https://developers.celcoin.com.br/docs/consultar-saldo-1Account (string)
DocumentNumber (string)
get_wallet_movementConfira nosso tutorial - https://developers.celcoin.com.br/docs/consultar-extrato-1Account (string)
DocumentNumber (string)
DateFrom (string) required
DateTo (string) required
LimitPerPage (string)
Page (string)
Order (string)
get_wallet_power_movementConsultar Extrato Detalhado BetaAccount (string) required
DateFrom (string)
DateTo (string)
Id (string)
EndToEndId (string)
ClientCode (string)
LimitPerPage (integer)
Page (integer)
Order (string)
MovementType (string)
get_pix_dict_entry_external_by_accountConfira nosso tutorial - https://developers.celcoin.com.br/docs/consultar-chaves-pix-externa-dictaccount (string)
key (string) required
ownerTaxId (string)
includeStatistics (boolean)
post_pix_paymentRetornará o evento de confirmação via webhook pix-payment-out Confira nosso tutorial - https://developers.celcoin.com.br/docs/pix-cash-out-pagamentodata: {
. amount (number)
. clientCode (string)
. transactionIdentification (string)
. endToEndId (string)
. initiationType (string)
. paymentType (string)
. urgency (string)
. transactionType (string)
. debitParty (object)
. creditParty (object)
. remittanceInformation (string)
. schedule (object)
} (object) required
get_pix_payment_statusConfira nosso tutorial - https://developers.celcoin.com.br/docs/verifica-o-status-de-uma-transa%C3%A7%C3%A3o-pixid (string)
clientCode (string)
endToEndId (string)
get_pix_participantConfira nosso tutorial - https://developers.celcoin.com.br/docs/sobre-o-pixISPB (string)
Name (string)
post_pix_reverseRetornará o evento de confirmação via webhook pix-reversal-outdata: {
. id (string)
. endToEndId (string)
. clientCode (string)
. amount (number)
. reason (string)
. reversalDescription (string)
} (object) required
get_pix_reverse_statusConsultar o Status de uma Devolução de Recebimento Pixid (string)
clientCode (string)
returnIdentification (string)
post_pix_dict_entryConfira nosso tutorial - https://developers.celcoin.com.br/docs/cadastrar-uma-chave-pixdata: {
. account (string)
. keyType (string)
. key (string)
} (object) required
put_pix_dict_entryNo description availabledata: {
. account (string)
. key (string)
. name (string)
. tradeName (string)
} (object) required
get_pix_dict_entry_by_accountConfira nosso tutorial - https://developers.celcoin.com.br/docs/consultar-chaves-pix-de-uma-conta-copyaccount (string)
delete_pix_dict_entry_by_keyConfira nosso tutorial - https://developers.celcoin.com.br/docs/excluir-chaves-pix-de-uma-contakey (string)
data: {
. account (string)
} (object) required
post_pix_dict_claimCadastra nova reivindicação/portabilidade de chave Pixdata: {
. key (string)
. keyType (string)
. account (string)
. claimType (string)
} (object) required
post_pix_dict_claim_confirmConfirma nova reivindicação/portabilidade de chave Pixdata: {
. id (string)
. reason (string)
} (object) required
post_pix_dict_claim_cancelCancela nova reivindicação/portabilidade de chave Pixdata: {
. id (string)
. reason (string)
} (object) required
get_pix_dict_claim_by_idConsulta reivindicação/portabilidade de chave Pixid (string)
get_pix_dict_claim_listConsulta lista de reivindicação/portabilidade de chave PixDateFrom (string)
DateTo (string)
LimitPerPage (string)
Page (string)
Status (string)
claimType (string)
post_duedate_splitSplit de Pix Cash-in por QR Code dinâmicoduedatedata: {
. clientRequestId (string)
. expirationAfterPayment (integer)
. duedate (string)
. debtor (object)
. receiver (object)
. locationId (integer)
. amount (number)
. amountDicount (array)
. amountAbatement (object)
. amountFine (object)
. amountInterest (object)
. additionalInformation (array)
. payerQuestion (string)
. key (string)
. feeInfo (object)
} (object) required
post_immediate_splitSplit de Pix Cash-in por QR Code dinâmico immediatedata: {
. clientRequestId (string)
. payerQuestion (string)
. key (string)
. locationId (integer)
. debtor (object)
. amount (object)
. calendar (object)
. additionalInformation (array)
. feeInfo (object)
} (object) required
patch_automatic_recurrencies_authorization_by_id_acceptAceita uma recorrência Jornada 1id (string)
data: {
. maxAmount (number)
. debitParty (object)
} (object) required
post_automatic_recurrencies_authorization_acceptAceita uma recorrência jornada 4data: {
. id (string)
. endToEnd (string)
. journeyType (integer)
. interval (object)
. amount (number)
. recurrencyMaxAmount (number)
. recurrencyAmountType (string)
. creditParty (object)
. debitParty (object)
. debtor (object)
. contract (object)
} (object) required
post_automatic_pix_paymentAceita uma recorrência Jornada 3data: {
. amount (number)
. clientCode (string)
. debitParty (object)
. endToEndId (string)
. creditParty (object)
. initiationType (string)
. transactionIdentification (string)
. paymentType (string)
. urgency (string)
. transactionType (string)
. recurrencyAccept (boolean)
. recurrency (object)
} (object) required
patch_automatic_recurrencies_authorization_by_id_denyRecusa uma recorrênciaid (string)
data: {
. deniedReason (string)
} (object) required
get_automatic_recurrencies_authorization_status_by_statusBusca recorrências por status com paginaçãostatus (string)
page-size (integer)
page (integer)
get_automatic_recurrencies_authorization_by_id_Busca uma recorrência pelo IDid (string)
post_automatic_recurrencies_authorization_by_id_cancelCancelamento de Autorizaçãoid (string)
data: {
. cancellingReason (string)
. taxId (string)
} (object) required
post_sheduling_by_endtoendid_cancelCancelamento de agendamentoendtoendid (string)
data: {
. reason (string)
. taxId (string)
} (object) required
post_automatic_recurrencies_journey1Crie uma recorrência com jornada 1data: {
. recurrencyId (string)
. recurrency (object)
} (object) required
post_automatic_recurrencies_journey2Crie uma recorrência com a jornada 2data: {
. locationId (integer)
. location (object)
. recurrencyId (string)
. recurrency (object)
} (object) required
post_automatic_collection_immediateJornada de autorização com pagamento imediato.data: {
. key (string)
. debtor (object)
. amount (object)
. calendar (object)
. clientRequestId (string)
. payerQuestion (string)
. locationId (integer)
. recurrency (object)
} (object) required
post_automatic_collection_duedateCrie uma recorrência jornada 4data: {
. clientRequestId (string)
. expirationAfterPayment (integer)
. duedate (string)
. debtor (object)
. receiver (object)
. locationId (integer)
. amount (number)
. key (string)
. recurrency (object)
} (object) required
put_automatic_recurrencies_by_recurrency_id_payment_instruction_by_end_to_end_idEnvio de agendamentorecurrencyId (string)
endToEndId (string)
data: {
. clientRequestId (string)
. amount (number)
. changeToNextWorkingDay (boolean)
} (object) required
post_automatic_recurrencies_by_recurrency_id_payment_instruction_by_end_to_end_id_new_attemptRetentativas de recebimentorecurrencyId (string)
endToEndId (string)
data: {
. newExpirationDate (string)
} (object) required
post_automatic_recurrencies_by_recurrency_id_payment_instruction_by_end_to_end_id_cancelCancelamento de agendamentorecurrencyId (string)
endToEndId (string)
data: {
. reason (string)
. taxId (string)
} (object) required
post_automatic_recurrencies_by_recurrency_id_cancelCancelamento da recorrênciarecurrencyId (string)
data: {
. cancellingReason (string)
} (object) required
get_automatic_recurrenciesConsulta por recorrênciarecurrencyId (string)
clientRequestId (string)
get_automatic_recurrencies_listConsulta lista de recorrênciasdateFrom (string)
dateTo (string)
status (string)
account (string)
page (integer)
page-size (integer)
clientId (string)
get_automatic_payment_instructionConsulta uma instrução de pagamentorecurrencyId (string)
endToEndId (string)
get_automatic_payment_instruction_listConsulta lista de instrução de pagamentodateFrom (string) required
dateTo (string) required
recurrencyId (string)
status (string)
account (string)
page (integer)
page-size (integer)
post_scheduler_pixAgendar um Pix Cashoutdata: {
. amount (string)
. clientCode (string)
. initiationType (string)
. paymentType (string)
. urgency (string)
. transactionType (string)
. endToEndId (string)
. debitParty (object)
. creditParty (object)
. scheduler (object)
. remittanceInformation (string)
. transactionIdentification (string)
} (object) required
get_scheduler_by_idConsultar agendamento de pixid (string)
delete_scheduler_by_idCancelar agendamento de pixid (string)
get_scheduler_list_by_account_by_accountEndpoint responsável por listar agendamentosaccount (string)
DateFrom (string)
DateTo (string)
Page (string)
LimitPerPage (string)
ClientCode (string)
SchedulerId (string)
Product (string)
Status (string)
post_spb_transferEnviar uma TEDdata: {
. amount (number)
. clientCode (string)
. debitParty (object)
. creditParty (object)
. clientFinality (string)
. description (string)
} (object) required
get_spb_transfer_statusConsultar Status de uma transferência TEDid (string)
clientCode (string)
post_vehicledebts_consultCriar pedido de consulta de débitos veiculares.data: {
. clientRequestId (string)
. documentNumber (string)
. licensePlate (string)
. renavam (string)
. state (string)
} (object) required
get_vehicledebts_consultConsultar pedido de consulta de débitos veiculares.IdConsult (string)
ClientRequestId (string)
DebitId (string)
post_vehicledebtsRealizar pagamento de Débito Veiculardata: {
. account (string)
. clientRequestId (string)
. idConsult (string)
. debtIdList (array)
. tags (array)
} (object) required
get_vehicledebtsConsultar pagamento e débitos veiculares.IdConsult (string)
ClientRequestId (string)
DebitId (string)
get_account_income_reportConfira nosso tutorial - https://developers.celcoin.com.br/docs/informe-de-rendimentosAccount (string)
CalendarYear (string)
Quarter (string)
post_webhook_subscriptionConfira nosso tutorial - https://developers.celcoin.com.br/docs/gerenciamento-de-webhookdata: {
. entity (string)
. webhookUrl (string)
. auth (object)
} (object) required
get_webhook_subscriptionConfira nosso tutorial - https://developers.celcoin.com.br/docs/gerenciamento-de-webhookEntity (string)
Active (boolean)
data required
put_webhook_subscription_by_entityConfira nosso tutorial - https://developers.celcoin.com.br/docs/gerenciamento-de-webhookentity (string)
data: {
. webhookUrl (string)
. auth (object)
. active (boolean)
. subscriptionId (string)
} (object) required
delete_webhook_subscription_by_entityConfira nosso tutorial - https://developers.celcoin.com.br/docs/gerenciamento-de-webhookentity (string)
subscriptionId (string)
get_webhook_entity_listConsultar lista de eventos enviados pelo webhookdata required
get_webhook_templatesConsultar Templates de WebhooksEntity (string)
Status (string)
Page (string)
Limit (string)
LimitPerPage (string)
data required
get_webhook_replay_by_entityConsultar quantidade de webhooks enviados.entity (string)
DateFrom (string) required
DateTo (string) required
OnlyPending (boolean)
webhookId (string)
documentNumber (string)
account (string)
id (string)
clientRequestId (string)
data required
put_webhook_replay_by_entityReenvio de webhooks pendentesentity (string)
DateFrom (string) required
DateTo (string) required
OnlyPending (boolean)
webhookId (string)
data: {
. filter (object)
} (object) required
get_webhook_replay_by_entity_detailsConsultar detalhes dos webhooks enviados.entity (string)
DateFrom (string) required
DateTo (string) required
Page (integer)
Limit (integer)
LimitPerPage (integer)
webhookId (string)
documentNumber (string)
account (string)
id (string)
clientRequestId (string)
OnlyPending (boolean)
data required
post_cnab_fileProcessamento de Arquivo CNABdata: {
. file (string)
. clientRequestId (string)
. account (string)
} (object) required
get_cnab_file_by_idConsulta de Dados CNAB enviadoid (string)
get_cnab_file_by_id_file_outputBaixar arquivo retorno do CNAB pelo id.id (string)
get_cnab_file_by_id_file_inputBaixar arquivo remessa do CNAB pelo id.id (string)
post_wallet_by_account_balance_blockConfira nosso tutorial - https://developers.celcoin.com.br/update/docs/bloqueio-de-saldoaccount (string)
data: {
. amount (number)
. clientRequestId (string)
. correlationBlockedId (string)
. reason (string)
. description (string)
. tags (array)
. name (string)
} (object) required
post_wallet_by_account_balance_unblockDesbloqueio de saldoaccount (string)
data: {
. correlationBlockedId (string)
. clientRequestId (string)
. reason (string)
. description (string)
. unblockAll (boolean)
. amount (number)
} (object) required
post_funds_recoveryConfira nosso tutorial - Criar recuperação de valoreshttps://developers.celcoin.com.br/update/docs/criar-recupera%C3%A7%C3%A3o-de-valores-1data: {
. flowType (string)
. rootEndToEnd (string)
. situationType (string)
. reportDetails (string)
. contactInformation (object)
. trackingGraphParameters (object)
} (object) required
get_funds_recovery_by_funds_recovery_idNo description availablefundsRecoveryId (string)
post_funds_recovery_by_funds_recovery_id_cancelNo description availablefundsRecoveryId (string)
post_infraction_by_infraction_report_id_closeNo description availableinfractionReportId (string)
data: {
. analysisResult (string)
. analysisDetails (string)
. fraudType (string)
} (object) required
post_webhook_subscription_Confira nosso tutorial - https://developers.celcoin.com.br/docs/gerenciamento-de-webhookdata: {
. entity (string)
. webhookUrl (string)
. auth (object)
} (object) required
post_wallet_internal_transferRealizar uma transferência entre contasdata: {
. amount (number)
. clientRequestId (string)
. debitParty (object)
. creditParty (object)
. description (string)
} (object) required
get_wallet_internal_transfer_statusConsultar status de uma transferência internaId (string)
ClientRequestId (string)
EndToEndId (string)
customCall 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)