Nexxera - Nix Empresas
API bancária Nix Empresas. Transferências, PIX, pagamento de contas, boletos, extrato e saldo.
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 61 actions:
| Action | Purpose | Parameters |
|---|---|---|
| post_auth | O método de LOGIN retornará o TOKEN transacional O TOKEN de autenticação e o account-id são necessário em todas as requisições das API's financeiras e devem ser enviadas no header da requisição. | data: { . user (string) . password (string) } (object) required |
| post_billet_levy | Este endpoint gera uma cobrança de taxa por meio da API do Nix Fee, desde que o client esteja integrado com o Nix Fee e a conta especificada no account-id possua um event type com o nome 'billet-issuance'. Para registrar um boleto do tipo Cobrança é necessário que o header e o body estejam corretamente preenchidos. Nesse caso, as regras dos campos são: Header Campo Descrição Tipo Obrigatório Formato Authorization Token adquerido após o login String ✅ Token Token social-number identifica | No parameters |
| get_billet_by_billet_auth_code | A API oferece a opção de buscar um boleto para isso é necessário o boleto esteja cadastrado em nosso banco de dados.Certificado que o boleto esteja no banco basta passar o authentication_code que é do tipo UUID, na URL, referente ao boleto que você que obter alguma informação. Todo boleto cadastrado tem um código único de authentication_code. Além do authentication_code é necessário que seja enviado um header como descrito abaixo. Header Campo Descrição Tipo Obrigatório Formato Authori | BILLET_AUTH_CODE (string) required |
| get_billet_by_billet_auth_code_pdf | Imprimir o PDF do boleto pelo auth code É possível gerar um arquivo no formato pdf quando usado esse endpoint. Para isso é necessário um BILLET_AUTH_CODEválido na URL. Um BILLET_AUTH_CODE válido significa que o boleto está registrado no banco de dados o auhtentication_code é único para cada boleto Após o request é possível obter .pdf do boleto. Passando um valor inválido o retorno será uma mensagem de erro. Nesse endpoint não recebe nenhum header, e nenhum body. Erros Mapeamento de erros | BILLET_AUTH_CODE (string) required |
| delete_billet_by_billet_auth_code | A API oferece a opção de cancelamento de boleto para isso é necessário o boleto tenha sido emitido pelo Banco Nix. Para cancelar, envie o authentication_code do boleto id fornecido na geração do boleto. Além do authentication_code é necessário que seja enviado um header como descrito abaixo. Header Campo Descrição Tipo Obrigatório Formato Authorization Token adquerido após o login String ✅ Token social-number identificação do cliente CNPJ/CPF da conta String ✅ Somente os Números accou | BILLET_AUTH_CODE (string) required |
| delete_billet_hybrid_delete_by_billet_hybrid_id | Para cancelar um boleto híbrido é necessário que o header e o path com o id do boleto híbrido estejam corretamente preenchidos.Nesse caso, as regras dos campos são: Header Campo Descrição Tipo Obrigatório Formato Authorization Token adquirido após o login String ✅ Bearer Token social-number Identificação do cliente CNPJ/CPF da conta String ✅ Somente os Números account-id ID identificador da conta String ✅ GUID Erros Mapeamento de erros | billet_hybrid_id (string) required |
| get_billet_hybrid_pdf_by_billet_hybrid_id | Para gera o pdf de um boleto híbrido é necessário que o header e o path com o id do boleto híbrido estejam corretamente preenchidos. Nesse caso, as regras dos campos são: Header Campo Descrição Tipo Obrigatório Formato Authorization Token adquirido após o login String ✅ Bearer Token social-number identificação do cliente CNPJ/CPF da conta String ✅ Somente os Números account-id ID identificador da conta String ✅ GUID Response Ao realizar uma requisição um response com um link para d | billet_hybrid_id (string) required |
| get_billet_hybrid_by_billet_hybrid_id | Para consultar um boleto híbrido é necessário que o header e o path com o id do boleto híbrido estejam corretamente preenchidos.Nesse caso, as regras dos campos são: Header Campo Descrição Tipo Obrigatório Formato Authorization Token adquirido após o login String ✅ Bearer Token social-number Identificação do cliente CNPJ/CPF da conta String ✅ Somente os Números account-id ID identificador da conta String ✅ GUID Response Ao realizar uma requisição um response com as seguintes inform | billet_hybrid_id (string) required |
| post_split | Campos principais Campo Descrição Tipo Obrigatório Formato externalId Identificador externo de controle da configuração String ✅ Livre recomendado único alias Nome descritivo da configuração de split String ✅ Até 255 caracteres isActive Define se a configuração estará ativa para uso Boolean ✅ true ou false isMain Define se esta é a configuração principal da conta Boolean ✅ true ou false split Lista de recebedores e regras de divisão Array Json ✅ Vide estrutura abaixo Objeto sp | data: { . externalId (string) . alias (string) . isActive (boolean) . isMain (boolean) . split (array) } (object) required |
| get_statement | Este endpoint permite consultar os lançamentos de uma conta em um período específico. Ele retornará todos os lançamentos que ocorreram dentro do intervalo informado, considerando também os filtros enviados como parâmetros. ⚠️ Limitação de Período O intervalo máximo permitido por requisição é de 7 dias. Caso seja enviado um período superior a 7 dias, o endpoint retornará um erro de validação. Para consultar períodos maiores, existem duas alternativas: Realizar múltiplas consultas, cada uma com n | start_event_date (string) end_event_date (string) event_model (string) ordering (string) limit (string) offset (string) |
| get_statement_export_xlsx | Consultar lançamentos da conta informada. | startEventDate (string) endEventDate (string) eventModel (string) |
| get_statement_export_csv | Gera os lançamentos da conta informada em formato CSV. | startEventDate (string) endEventDate (string) eventModel (string) |
| get_statement_export_ofx | Gera os lançamentos da conta informada no formato OFX. | startEventDate (string) endEventDate (string) eventModel (string) |
| post_statement_send_mail | Envio de Extrato por E-mail O envio de extratos por e-mail passa por um processo de validação de consistência entre a nossa base de dados e a base dos bancos parceiros. Caso seja identificada alguma inconsistência em um ou mais dias, não será possível gerar o extrato completo até que o problema seja resolvido. Como funciona a validação Todos os dias são verificados individualmente. Se algum dia apresentar divergências entre as bases, o sistema bloqueia a geração do extrato que inclua essa data | data: { . recipient (string) . start_event_date (string) . end_event_date (string) } (object) required |
| post_statement_validate_xlsx | Valida se o arquivo Xlsx. é um arquivo sem alteração de terceiros. | No parameters |
| get_account_balance | Consultando saldo da conta informada. | No parameters |
| get_account_balance_list | Consultando saldo da conta informada. | No parameters |
| post_transfer | Para registrar uma transferencia é necessário que o header e o body estejam corretamente preenchidos.Nesse caso, as regras dos campos são: Body Campo Descrição Tipo Obrigatório Formato amount Valor a ser pago. Double ✅ Duas casas após o ponto ex: 3.45 recipient Dados da Conta de Destino da transferencia Json ✅ Para mais detalhes ver a tabela abaixo clientFinality Finalidade da transferencia String 1 - Pagamento de Impostos, Tributos e Taxas 3 - Pagamentos de Dividendos 4 - Pagament | data: { . amount (number) . description (string) . recipient (object) } (object) required |
| get_transfer_by_auth_code_transfer | Buscar uma transferência pelo Auth Code UUID | auth_code_transfer (string) required |
| get_transfer_voucher | A Api de geração de comprovantes retorna um link, onde é possível fazer o download de um pdf com uma transação em detalhes, como favorecido, fonte, informações financeiras e estado atual. Comprovantes e recibos só serão gerados em transações em que o status atual seja Sucesso, ou Em Processamento. Esta Api fornece comprovantes para transferência e agendamento de transfrência. Ao socilitar um comprovante o seguintes QueryParams devem ser informados: Comprovante de Transferência: type: transfer | No parameters |
| post_transfer_schedule | Ao agendar uma transferência, a transação será executada na data de agendamento que foi determinada durante a criação do agendamento. Caso a conta não necessite confirmação de agendamento, o agendamento será criado com o status SCHEDULE, onde estará pronto para a execução na data determinada. Caso a conta necessite de confirmação de agendamento, o agendamento será criado com o status PENDING_APPROVAL. Utilize o endpoint de confirmação para alterar o status para SCHEDULED. obs.: Agendamentos que | No parameters |
| post_transfer_schedule_confirm | Contas que necessitam de confirmações para agendar transferência, precisam utilizar este endpoint para confirmar seus agendamentos. A confirmação deverá ser feita pela própria conta que agendou a transferência. Ao alcançar as confirmações necessárias, será enviado um webhook apresentado na documentação de Agendar transferência com o status de SCHEDULED. Requisição: Headers Authorization Requiredtype: String Token de autenticação social-number Requiredtype: String CPF ou CNPJ da conta e | No parameters |
| get_transfer_schedule | Através deste endpoint é possível consultar todas as transferências agendadas por uma conta. | start_scheduled_date (string) end_scheduled_date (string) ordering (string) limit (string) offset (string) id (string) |
| delete_transfer_schedule_by_id | Só é possível cancelar agendamentos com status de SCHEDULED ou PENDING_APPROVAL. Ao ser cancelado, é enviado um webhook com status CANCELLED com o formato no padrão informado no endpoint de Agendar transferência. | id (string) required |
| post_bill_payment_validate | Validar linha digitável | data: { . code (string) } (object) required |
| post_bill_payment_confirm | Realizar a confirmação do pagamento de uma linha digitável previamente validada | data: { . code (string) . digitable (string) . paymentAmount (string) . description (string) . identifier (string) } (object) required |
| get_bill_payment_detail_by_id | Consultar os detalhes de um pagamento de linha digitável através do auth code UUID do pagamento | id (string) required |
| post_bill_payment_schedule | Ao agendar um pagamento de contas, não é necessário validar antes no endpoint validate. Ao ser executado o pagamento na data agendada, será enviado um webhook com as seguintes informações: 'id': UUID, 'status': String, 'type': 'SCHEDULED_BILL_PAYMENT' | data: { . code (string) . amount (number) . schedule_date (string) . description (string) . identifier (string) } (object) required |
| get_bill_payment_schedule | Através deste endpoint é possível listar todos os pagamentos agendados de uma conta. | No parameters |
| patch_bill_payment_schedule_update_by_id | Nossa API realiza a edição de um pagamento de conta agendado. Caso a conta necessite de confirmção, e o agendamento já tenha sido confirmado de maneira intergral ou parcial, será necessário uma nova confirmação após edição. obs.: Agendamentos que necessitem de confirmação, e que não tenham sido confirmados até a data de agendamento, serão cancelados. Request Para realizar o pagamento é necessário que o header e o body estejam corretamente preenchidos. Além disso, o id do agendamento deve ser pas | id (string) required |
| delete_bill_payment_schedule_by_scheduled_bill_payment_id | Para cancelar um agendamento, basta informar o id do agendamento via path params. | SCHEDULED_BILL_PAYMENT_ID (string) required |
| get_bill_payment_voucher | A Api de geração de comprovantes retorna um link, onde é possível fazer o download de um pdf com uma transação em detalhes, como favorecido, fonte, informações financeiras e estado atual. Comprovantes só serão gerados em transações em que o status atual seja Sucesso, ou Em Processamento. Esta Api fornece comprovantes para pagamentos e agendamento de pagamentos. Ao socilitar um comprovante o seguintes QueryParams devem ser informados: Comprovante de Pagamento: type: bill_payment authentication_ | No parameters |
| post_pix_entries | Registrando uma chave PIX para a conta nix. Campos da Api Campo Descrição Tipo Observações type Tipo da chave. String Informe: CPF, EVP, CNPJ - 'EVP' é a chave aleatória UUID Regras: - A chave a ser registrada neste endpoint não pode estrar registrada em outras contas bancárias.- Se a conta é de pessoa fisica, só pode ser registrado o CPF informado na abertura da conta.- Se a conta é de pessoa jurídica, só pode ser registrado o CNPJ informado na abertura da conta.- Conta PJ não pode te | data: { . type (string) } (object) required |
| get_pix_get_entries | Para consultar as chaves PIX de uma conta NIX é necessário: Social-Number Obrigatório Account-ID Obrigatório Inserindo no Headers as informações necessárias, terá o Response conforme o exemplo do Body Regras:Chaves reserved: true não podem ser deletadas. Elas são utilizadas no Nix Empresas e em fluxos de Open Banking. | No parameters |
| get_pix_entries_by_addressing_key | Consultar uma chave PIX para realizar transferencia via PIX Para que seja possível utilizar este endpoint, é necessário que: O cliente possua uma conta ativa; A chave a ser cadastrada não esteja em uso nesta ou em outra instituição financeira. TIPO EXEMPLO CPF 47742663023 CNPJ 34183937000161 Chave Aleatório EVP 123e4567-e89b-12d3-a456-426655440008 Telefone +5523415162342 E-mail teste@teste.com.br | addressing_key (string) required |
| delete_pix_entries_by_nix_addressing_key | Endpoint responsável por deletar uma chave Pix. Para utilizá-lo é necessário passar a chave pix ao endpoint, assim a chave pix será apagada. Regras:Chaves reserved: true não podem ser deletadas. Elas são utilizadas no Nix Empresas e em fluxos de Open Banking. | nix_addressing_key (string) required |
| post_totp_create_key_register | campos da API: Campo Descrição Tipo Observações context N/A String Deve ser preenchido com o valor 'Pix'. operation Tipo da operação String Deve ser preenchido com RegisterEntry. data N/A Dicionário Deve conter um campo chamado 'type' contendo o tipo da chave pix e um campo chamado 'value' contendo o valor da chave pix. template N/A String | data: { . context (string) . operation (string) . data (object) } (object) required |
| patch_totp_validate | campos da API: Campos Descrição Tipo Observações key GUID de retorno na solicitação do totp-key-register String pin Código recebido pelo usuário. String Deve informar o código recebido pelo usuário por e-mail ou SMS. 6 dígitos | data: { . key (string) . pin (string) } (object) required |
| post_pix_qrcode_static | Endpoint para geração de um QRCode de PIX Estático. Antes vamos esclarecer uma diferença:QRCode dinâmico podem ter regras de negócios pagamento único, vencimento, etc. O QRCode estático não tem regras de negócios dinâmicas. A Api abaixo de QRCode estático, você consegue gerar um QRCode com ou sem valor. E em outra api, consultar depois para saber se o QRCode foi pago. Na resposta da requisição virá o encodedValue em base64. Ao decodificar a base64 deste valor você tem o código do 'pix copia e c | data: { . merchantId (string) . amount (integer) . recipientName (string) . addressingKey (object) } (object) required |
| post_pix_qrcode_dynamic | Endpoint para geração de um QRCode de PIX Dinâmico. Antes vamos esclarecer uma diferença:QRCode dinâmico podem ter regras de negócios vencimento, pagamento único etc. O QRCode estático não tem regras de negócios dinâmicas. A Api abaixo de QRCode dinâmico, você consegue gerar um QRCode com ou sem valor, informar se o QRCode pode ser pago multiplas vezes, tem obrigatóriamente vencimento, ten pagador e tem mensagens adicionais semelhante ao demonstrativo de um boleto. Em outra api, você pode consu | data: { . recipientName (string) . addressingKey (object) . amount (integer) . changeAmountType (string) . merchantId (string) . expiresAt (string) . payerRequestText (string) . additionalData (array) . singlePayment (boolean) . payer (object) . amountDiscount (object) . amountInterest (object) . amountAbatement (object) . amountFine (object) } (object) required |
| get_pix_qrcode | Lista todos os QR Codes gerados pelo social-number informado. Para uma busca mais específica, são disponibilizados os seguintes filtros: startCreateDate; endCreateDate; conciliationId ID do QR - ID nosso merchantId ID do QR - seu ID type: 'STATIC', 'DYNAMIC'; offset; limit; ordering: created, conciliation_id, merchant_id, encoded_value, type, payers_count, payers, -created, -conciliation_id, -merchant_id, -encoded_value, -type, -payers_count, -payers | No parameters |
| get_pix_cash_out_by_authentication_code | Ao fazer um pix cashout, você obtem um autheticationCode. Utilize este endpoint para consultar novamente o resultado de um pix cashout. Dica para desenvolvimento:status DONE - é um pix realizado com sucesso.status CANCELLED - o pix não foi concretizado. Houve algum problema com a realização do cashout. | authentication_code (string) required |
| get_pix_qrcode_static_by_conciliation_id_payers | Mostra informação de todas as contas que pagaram o QR Code em questão. | conciliation_id (string) required |
| post_pix_qrcode_decode | 1- Após a câmera ler o QRCode, você tem uma string. Essa string é o código do qrcode.2- Converta esta string para base64.3- Utilze este endpoint para obter o conteúdo do código. Guarde os dados de resultado pois através deles, você fará a transferência/pagamento.4- Chame o endpoint de transferencia PIX por QRCode. Campos da Api Campo Descrição Tipo Observações encodedValue QRCode em base64 Campo String | data: { . encodedValue (string) } (object) required |
| get_pix_qrcode_voucher | A API de geração de comprovantes retorna um link, onde é possível fazer o download de um pdf com uma transação em detalhes, como favorecido, fonte, informações financeiras e estado atual. Comprovantes só serão gerados em transações em que o status atual seja Sucesso, ou Em Processamento. Esta API fornece comprovantes para pagamento Pix e agendamento de pagamento Pix. Ao solicitar um comprovante o seguintes QueryParams devem ser informados: Comprovante de Pagamento: type: qrcode authentication_ | No parameters |
| post_pix_cash_out | Realiza uma transferência PIX com os dados bancários do destinatário. Campo Descrição Tipo amount valor a ser enviado Double description descrição opcional String branch número da agência String number número da conta String type tipo da conta String ispb identificador do banco no banco central String documentNumber número do documento CPF/CNPJ do destinatário String name nome do destinatário String initializationType Modo que se dará a transação. 'Manual' para transações | data (object) required |
| get_pix_cash_out_voucher | A API de geração de comprovantes retorna um link, onde é possível fazer o download de um pdf com uma transação em detalhes, como favorecido, fonte, informações financeiras e estado atual. Comprovantes só serão gerados em transações em que o status atual seja Sucesso, ou Em Processamento. Esta API fornece comprovantes para transferência Pix e agendamento de transferência Pix. Ao solicitar um comprovante o seguintes QueryParams devem ser informados: Comprovante de Transferência: type: pix authen | type (string) authentication_code (string) |
| post_pix_cash_out_refund | Realizar reembolso de pix realizado Campos da Api Campo Descrição Tipo deposit_transaction_id id da transação Campo String amount Valor da Transação Campo Number refund_code Código de Reembolso Campo String valores AM05, AM09, BE08, DS28, FOCR, FR01, MD06, RUTA, SL11, SL12, UPAY, NARR, SL02 refund_reason Razão de Reembolso Campo String description Descrição Campo String | data: { . deposit_transaction_id (string) . amount (number) . refund_code (string) . refund_reason (string) . description (string) . identifier (string) } (object) required |
| post_pix_cash_out_schedule | Agendar transferência PIX | data: { . amount (string) . description (string) . recipient (object) . initializationType (string) . scheduleDate (string) } (object) required |
| post_pix_cash_out_instant_or_schedule | A premissa para utilização deste endpoint é que você configure no Nix Empresa a alçada de aprovações em sua conta. Basta acessar configurações and gt; Aprovadores | data: { . description (string) . recipient (object) . initializationType (string) . amount (string) } (object) required |
| post_pix_cash_out_schedule_confirm | Confirmar transferência PIX | data: { . id (string) . user_id (string) } (object) required |
| patch_pix_cash_out_schedule_edit_by_id | Edição de pix agendado | id (string) required data: { . scheduleDate (string) . amount (integer) . description (string) . recipient (object) . initializationType (string) . changeAmount (integer) } (object) required |
| get_pix_cash_out_schedule_list | Listar agendamentos de PIX | id (string) start_scheduled_date (string) end_scheduled_date (string) limit (string) offset (string) ordering (string) |
| delete_pix_cash_out_schedule_by_id_agendamento_cancel | Cancelar agendamento | id_agendamento (string) required |
| post_totp_claims | campos da API: Campo Descrição Tipo Observações context N/A String Deve ser preenchido com o valor 'Pix'. operation Tipo da reivindicação String Deve ser preenchido com Portability ou Ownership. data N/A Dicionario Deve conter um campo chamado 'claim_id' com o valor gerado na criação do pedido de reivindicação. template N/A String Um campo opcional, caso o parceiro queira personalizar o envio da mensagem email ou sms com o código para o cliente realizar a validação do TOTP. | No parameters |
| post_account_webhook | Cadastrar Webhook | data (object) required |
| get_income | Para consultar o informe de rendimentos de uma conta PFPessoa Fisica, basta informar o ano base como QUERY PARAM 'reference_year'. Exemplo: /income?reference_year=2024 Para consultar o informe de rendimentos de uma conta PJPessoa Juridica, é obrigatório especificar o trimestre desejado, Basta informar o ano base como QUERY PARAM 'reference_year' e o 'quarter' Exemplo: /income?quarter=1 and amp;reference_year=2024 | reference_year (string) quarter (string) |
| get_income_2020_pdf | Para consultar o informe de rendimentos, basta informar o ano base no PATH PARAM. Exemplo: .../income/2020/pdf | No parameters |
| get_bank_list | Responses Code 200 'ISPB': 'string', 'ShortName': 'string', 'Code': 'string', 'Name': 'string' Code 403: Forbidden 'errors': 'message': 'Authentication credentials were not provided.', 'code': 'not_authenticated' | id (string) name (string) page (string) pageSize (string) |
| get_account_accountant_email | Consultar email cadastrado do contador | No parameters |
| put_account_accountant_email | Alterar email cadastrado do contador | data: { . accountant_email (string) } (object) required |