Cielo Extrato Eletrônico

Cielo Extrato Eletrônico (EDI) — cadastramento e manutenção de caixa postal para arquivos EDI via fluxo de concessão do cliente.

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

Action	Purpose	Parameters
post_consent_v1_oauth_access_token	Serviço que realiza o consumo do Authorization Code retornado via callback pelo Customer Consent Flow e realiza a criação do access_token, que é necessário para acesso aos demais serviços. O refresh_token também é criado neste serviço e deve ser armazenado para que se obtenha um novo access_token quando este expirar 1 dia sem a necessidade de novo consentimento do cliente. Váriaveis utilizadas: client_secret_base_64 autenticação do parceiro, no header e authorization_code retornado via callback	data: { . grant_type (string) . code (string) } (object) required
get_edi_api_v2_edi_merchantgroup	Realiza a listagem dos clientes matriz e filiais abaixo do access_token informado. Pode ser utilizado o filtro não obrigatório para listar somente os Disponíveis AVAILABLE ou os Indisponíveis UNAVAILABLE. Estar indisponível significa que a filial já participa de outro cadastramento EDI, devendo ser retirado deste antes de poder compor um novo. Nos serviços de credenciamento e edição, há validação para permitir que somente os disponíveis sejam informados. Váriaveis utilizadas: access_token no h	No parameters
post_edi_api_v2_edi_registers	Realiza o cadastramento dos clientes do grupo comercial. Existem validações com relação às necessidades dos clientes estarem disponíveis para o credenciamento e também pertencerem ao cadastro da mesma raiz de CNPJ do grupo informado. O serviço permite algumas customizações: - Cadastrar no nível de grupo comercial: todos os clientes serão cadastrados e, em caso de crescimento deste grupo por conta de novas filiais, esta é incluída automaticamente no grupo. Para que se escolha essa opção, o parâ	data: { . merchantEMail (string) . type (array) } (object) required
get_edi_api_v2_edi_registers_by_register_id	Confirma o status de criação da estrutura de caixa postal de um credenciamento através do atributo 'status', que pode receber as informações PROCESSING e COMPLETED. Quando o status virar COMPLETED, significa que a partir do dia seguinte os arquivos já se encontrarão disponíveis na caixa postal da conciliadora. Outras informações também são listadas para que se possa confirmar se as filiais escolhidas refletiram corretamente. Váriaveis utilizadas: access_token no header e register_id na request	register_id (string) required
get_edi_api_v2_edi	Realiza a consulta de um registro EDI e serve de apoio para o serviço de edição Pode ser consultado utilizando o registerId retorno da API ou matriz de extrato casos anteriores à API. Informar ao menos um deles é obrigatório. Váriaveis utilizadas: access_token no header, register_id no param e main_merchant_id no param.	registerID (string) mainMerchantID (string)
put_edi_api_v2_edi	Realiza a edição de um registro EDI e serve de apoio para o serviço de edição Pode ser chamado utilizando o registerId retorno da API ou matriz de extrato casos anteriores à API. Informar ao menos um deles é obrigatório. Observar que deve ser informado o status em que se deseja deixar o registro. Atentar-se aos pontos: - Informar sem o atributo 'merchants': aplica-se a mesma regra do credenciamento, onde todas as filiais serão consideradas. - Informar com clientes no atributo significa q	data: { . mainMerchantID (string) . registerID (string) . merchants (array) . type (array) } (object) required
delete_edi_api_v2_edi	Realiza a exclusão de um registro EDI. Esta operação não poderá ser desfeita e passará a não ser mais retornado no serviço de consulta. Pode ser consultado utilizando o registerId retorno da API ou matriz de extrato casos anteriores à API. Informar ao menos um deles é obrigatório. Após a exclusão de um registro que contém o cliente, este torna-se disponível para novos credenciamentos. Váriaveis utilizadas: access_token, register_id e main_merchant_id todos no header.	No parameters
get_edi_api_v2_edi_mainmerchants	Através deste GET é possível saber se você poderá ou não fazer a duplicação de matriz, se o editStatus retornar 'UNAVAILABLE' é necessário acionar o time de EDI edi@cielo.com.br e solicitar a duplicação manualmente, mas caso o editStatus retornar 'AVAILABLE', será necessário fazer a chamada de PUT, informar o registerID, mainMerchantId e as demais filiais nessa chamada. Lembrando que é por objeto, se um objeto retornar 'AVAILABLE' e o outro 'UNAVAILABLE', você irá fazer a chamada de PUT para um	No parameters
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)