Celcoin
Integração com a API BaaS 2.0 da Celcoin para contas, Pix, transferências, cobranças e webhooks.
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:
| Action | Purpose | Parameters |
|---|---|---|
| get_account_check | Verificar Status da Conta. | onboardingId (string) clientCode (string) |
| put_account_natural_person | Confira nosso tutorial - https://developers.celcoin.com.br/docs/atualizar-dados-da-conta | Account (string) DocumentNumber (string) data: { . phoneNumber (string) . email (string) . socialName (string) . isPoliticallyExposedPerson (boolean) . address (object) } (object) required |
| put_account_business | Confira nosso tutorial - https://developers.celcoin.com.br/docs/atualizar-dados-da-conta | Account (string) DocumentNumber (string) data: { . businessEmail (string) . contactNumber (string) . owners (array) . businessAddress (object) } (object) required |
| get_account_fetch | Confira nosso tutorial - https://developers.celcoin.com.br/docs/listar-contas | Account (string) DocumentNumber (string) |
| get_account_fetch_business | Confira nosso tutorial - https://developers.celcoin.com.br/docs/listar-contas | Account (string) DocumentNumber (string) |
| get_account_fetch_all | Confira nosso tutorial - https://developers.celcoin.com.br/docs/listar-contas | DateFrom (string) required DateTo (string) required LimitPerPage (integer) Page (integer) Account (string) DocumentNumber (string) |
| get_account_fetch_all_business | Confira nosso tutorial - https://developers.celcoin.com.br/docs/listar-contas | DateFrom (string) required DateTo (string) required Limit (integer) Page (integer) |
| put_account_status | Confira nosso tutorial - https://developers.celcoin.com.br/docs/desativar-excluir-a-conta | Account (string) DocumentNumber (string) data: { . status (string) . reason (string) } (object) required |
| delete_account_close | Confira nosso tutorial - https://developers.celcoin.com.br/docs/desativar-excluir-a-conta | Account (string) DocumentNumber (string) Reason (string) required |
| post_account_business_create | Confira nosso tutorial - https://developers.celcoin.com.br/docs/criar-conta | data: { . 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_create | Confira nosso tutorial - https://developers.celcoin.com.br/docs/criar-conta | data: { . 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_balance | Confira nosso tutorial - https://developers.celcoin.com.br/docs/consultar-saldo-1 | Account (string) DocumentNumber (string) |
| get_wallet_movement | Confira nosso tutorial - https://developers.celcoin.com.br/docs/consultar-extrato-1 | Account (string) DocumentNumber (string) DateFrom (string) required DateTo (string) required LimitPerPage (string) Page (string) Order (string) |
| get_wallet_power_movement | Consultar Extrato Detalhado Beta | Account (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_account | Confira nosso tutorial - https://developers.celcoin.com.br/docs/consultar-chaves-pix-externa-dict | account (string) key (string) required ownerTaxId (string) includeStatistics (boolean) |
| post_pix_payment | Retornará o evento de confirmação via webhook pix-payment-out Confira nosso tutorial - https://developers.celcoin.com.br/docs/pix-cash-out-pagamento | data: { . 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_status | Confira nosso tutorial - https://developers.celcoin.com.br/docs/verifica-o-status-de-uma-transa%C3%A7%C3%A3o-pix | id (string) clientCode (string) endToEndId (string) |
| get_pix_participant | Confira nosso tutorial - https://developers.celcoin.com.br/docs/sobre-o-pix | ISPB (string) Name (string) |
| post_pix_reverse | Retornará o evento de confirmação via webhook pix-reversal-out | data: { . id (string) . endToEndId (string) . clientCode (string) . amount (number) . reason (string) . reversalDescription (string) } (object) required |
| get_pix_reverse_status | Consultar o Status de uma Devolução de Recebimento Pix | id (string) clientCode (string) returnIdentification (string) |
| post_pix_dict_entry | Confira nosso tutorial - https://developers.celcoin.com.br/docs/cadastrar-uma-chave-pix | data: { . account (string) . keyType (string) . key (string) } (object) required |
| put_pix_dict_entry | No description available | data: { . account (string) . key (string) . name (string) . tradeName (string) } (object) required |
| get_pix_dict_entry_by_account | Confira nosso tutorial - https://developers.celcoin.com.br/docs/consultar-chaves-pix-de-uma-conta-copy | account (string) |
| delete_pix_dict_entry_by_key | Confira nosso tutorial - https://developers.celcoin.com.br/docs/excluir-chaves-pix-de-uma-conta | key (string) data: { . account (string) } (object) required |
| post_pix_dict_claim | Cadastra nova reivindicação/portabilidade de chave Pix | data: { . key (string) . keyType (string) . account (string) . claimType (string) } (object) required |
| post_pix_dict_claim_confirm | Confirma nova reivindicação/portabilidade de chave Pix | data: { . id (string) . reason (string) } (object) required |
| post_pix_dict_claim_cancel | Cancela nova reivindicação/portabilidade de chave Pix | data: { . id (string) . reason (string) } (object) required |
| get_pix_dict_claim_by_id | Consulta reivindicação/portabilidade de chave Pix | id (string) |
| get_pix_dict_claim_list | Consulta lista de reivindicação/portabilidade de chave Pix | DateFrom (string) DateTo (string) LimitPerPage (string) Page (string) Status (string) claimType (string) |
| post_duedate_split | Split de Pix Cash-in por QR Code dinâmicoduedate | data: { . 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_split | Split de Pix Cash-in por QR Code dinâmico immediate | data: { . 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_accept | Aceita uma recorrência Jornada 1 | id (string) data: { . maxAmount (number) . debitParty (object) } (object) required |
| post_automatic_recurrencies_authorization_accept | Aceita uma recorrência jornada 4 | data: { . 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_payment | Aceita uma recorrência Jornada 3 | data: { . 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_deny | Recusa uma recorrência | id (string) data: { . deniedReason (string) } (object) required |
| get_automatic_recurrencies_authorization_status_by_status | Busca recorrências por status com paginação | status (string) page-size (integer) page (integer) |
| get_automatic_recurrencies_authorization_by_id_ | Busca uma recorrência pelo ID | id (string) |
| post_automatic_recurrencies_authorization_by_id_cancel | Cancelamento de Autorização | id (string) data: { . cancellingReason (string) . taxId (string) } (object) required |
| post_sheduling_by_endtoendid_cancel | Cancelamento de agendamento | endtoendid (string) data: { . reason (string) . taxId (string) } (object) required |
| post_automatic_recurrencies_journey1 | Crie uma recorrência com jornada 1 | data: { . recurrencyId (string) . recurrency (object) } (object) required |
| post_automatic_recurrencies_journey2 | Crie uma recorrência com a jornada 2 | data: { . locationId (integer) . location (object) . recurrencyId (string) . recurrency (object) } (object) required |
| post_automatic_collection_immediate | Jornada 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_duedate | Crie uma recorrência jornada 4 | data: { . 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_id | Envio de agendamento | recurrencyId (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_attempt | Retentativas de recebimento | recurrencyId (string) endToEndId (string) data: { . newExpirationDate (string) } (object) required |
| post_automatic_recurrencies_by_recurrency_id_payment_instruction_by_end_to_end_id_cancel | Cancelamento de agendamento | recurrencyId (string) endToEndId (string) data: { . reason (string) . taxId (string) } (object) required |
| post_automatic_recurrencies_by_recurrency_id_cancel | Cancelamento da recorrência | recurrencyId (string) data: { . cancellingReason (string) } (object) required |
| get_automatic_recurrencies | Consulta por recorrência | recurrencyId (string) clientRequestId (string) |
| get_automatic_recurrencies_list | Consulta lista de recorrências | dateFrom (string) dateTo (string) status (string) account (string) page (integer) page-size (integer) clientId (string) |
| get_automatic_payment_instruction | Consulta uma instrução de pagamento | recurrencyId (string) endToEndId (string) |
| get_automatic_payment_instruction_list | Consulta lista de instrução de pagamento | dateFrom (string) required dateTo (string) required recurrencyId (string) status (string) account (string) page (integer) page-size (integer) |
| post_scheduler_pix | Agendar um Pix Cashout | data: { . 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_id | Consultar agendamento de pix | id (string) |
| delete_scheduler_by_id | Cancelar agendamento de pix | id (string) |
| get_scheduler_list_by_account_by_account | Endpoint responsável por listar agendamentos | account (string) DateFrom (string) DateTo (string) Page (string) LimitPerPage (string) ClientCode (string) SchedulerId (string) Product (string) Status (string) |
| post_spb_transfer | Enviar uma TED | data: { . amount (number) . clientCode (string) . debitParty (object) . creditParty (object) . clientFinality (string) . description (string) } (object) required |
| get_spb_transfer_status | Consultar Status de uma transferência TED | id (string) clientCode (string) |
| post_vehicledebts_consult | Criar pedido de consulta de débitos veiculares. | data: { . clientRequestId (string) . documentNumber (string) . licensePlate (string) . renavam (string) . state (string) } (object) required |
| get_vehicledebts_consult | Consultar pedido de consulta de débitos veiculares. | IdConsult (string) ClientRequestId (string) DebitId (string) |
| post_vehicledebts | Realizar pagamento de Débito Veicular | data: { . account (string) . clientRequestId (string) . idConsult (string) . debtIdList (array) . tags (array) } (object) required |
| get_vehicledebts | Consultar pagamento e débitos veiculares. | IdConsult (string) ClientRequestId (string) DebitId (string) |
| get_account_income_report | Confira nosso tutorial - https://developers.celcoin.com.br/docs/informe-de-rendimentos | Account (string) CalendarYear (string) Quarter (string) |
| post_webhook_subscription | Confira nosso tutorial - https://developers.celcoin.com.br/docs/gerenciamento-de-webhook | data: { . entity (string) . webhookUrl (string) . auth (object) } (object) required |
| get_webhook_subscription | Confira nosso tutorial - https://developers.celcoin.com.br/docs/gerenciamento-de-webhook | Entity (string) Active (boolean) data required |
| put_webhook_subscription_by_entity | Confira nosso tutorial - https://developers.celcoin.com.br/docs/gerenciamento-de-webhook | entity (string) data: { . webhookUrl (string) . auth (object) . active (boolean) . subscriptionId (string) } (object) required |
| delete_webhook_subscription_by_entity | Confira nosso tutorial - https://developers.celcoin.com.br/docs/gerenciamento-de-webhook | entity (string) subscriptionId (string) |
| get_webhook_entity_list | Consultar lista de eventos enviados pelo webhook | data required |
| get_webhook_templates | Consultar Templates de Webhooks | Entity (string) Status (string) Page (string) Limit (string) LimitPerPage (string) data required |
| get_webhook_replay_by_entity | Consultar 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_entity | Reenvio de webhooks pendentes | entity (string) DateFrom (string) required DateTo (string) required OnlyPending (boolean) webhookId (string) data: { . filter (object) } (object) required |
| get_webhook_replay_by_entity_details | Consultar 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_file | Processamento de Arquivo CNAB | data: { . file (string) . clientRequestId (string) . account (string) } (object) required |
| get_cnab_file_by_id | Consulta de Dados CNAB enviado | id (string) |
| get_cnab_file_by_id_file_output | Baixar arquivo retorno do CNAB pelo id. | id (string) |
| get_cnab_file_by_id_file_input | Baixar arquivo remessa do CNAB pelo id. | id (string) |
| post_wallet_by_account_balance_block | Confira nosso tutorial - https://developers.celcoin.com.br/update/docs/bloqueio-de-saldo | account (string) data: { . amount (number) . clientRequestId (string) . correlationBlockedId (string) . reason (string) . description (string) . tags (array) . name (string) } (object) required |
| post_wallet_by_account_balance_unblock | Desbloqueio de saldo | account (string) data: { . correlationBlockedId (string) . clientRequestId (string) . reason (string) . description (string) . unblockAll (boolean) . amount (number) } (object) required |
| post_funds_recovery | Confira nosso tutorial - Criar recuperação de valoreshttps://developers.celcoin.com.br/update/docs/criar-recupera%C3%A7%C3%A3o-de-valores-1 | data: { . flowType (string) . rootEndToEnd (string) . situationType (string) . reportDetails (string) . contactInformation (object) . trackingGraphParameters (object) } (object) required |
| get_funds_recovery_by_funds_recovery_id | No description available | fundsRecoveryId (string) |
| post_funds_recovery_by_funds_recovery_id_cancel | No description available | fundsRecoveryId (string) |
| post_infraction_by_infraction_report_id_close | No description available | infractionReportId (string) data: { . analysisResult (string) . analysisDetails (string) . fraudType (string) } (object) required |
| post_webhook_subscription_ | Confira nosso tutorial - https://developers.celcoin.com.br/docs/gerenciamento-de-webhook | data: { . entity (string) . webhookUrl (string) . auth (object) } (object) required |
| post_wallet_internal_transfer | Realizar uma transferência entre contas | data: { . amount (number) . clientRequestId (string) . debitParty (object) . creditParty (object) . description (string) } (object) required |
| get_wallet_internal_transfer_status | Consultar status de uma transferência interna | Id (string) ClientRequestId (string) EndToEndId (string) |
| 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) |