Pagare
Digital accounts, PIX, payments and banking services with Pagare
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 102 actions:
| Action | Purpose | Parameters |
|---|---|---|
| get_digitalaccount_balance | Consulta o saldo da conta vinculada à conta atrelada ao AccessToken usuário logado. | No parameters |
| get_digitalaccount_transactions | Consulta a lista de transações vinculadas à conta atrelada ao AccessToken usuário logado entre datas padrão 'yyyy-MM-dd' | InitialDate (string) FinalDate (string) Type (string) Limit (integer) |
| get_digitalaccount_transactions_future | Consulta a lista de transações vinculadas à conta atrelada ao AccessToken usuário logado agendadas à partir de amanha não incuso o dia de hoje, apenas transações futuras. | Limit (integer) |
| get_digitalaccount_transaction | Consulta umas transação específica do AccessToken usuário logado | TransactionId (string) required |
| post_digitalaccount_invoice_create | Realiza a geração de um código de barras para que possa ser feito o 'Chash In' para a conta digital. O campo 'date' pode estar 'null' data de vencimento e será considerada a data atual, ou deve ser enviado no formato 'yyyy-MM-dd'. No caso no 'toPerson' vier null, será considerado o próprio dado do usuário. | data: { . value (number) . date (string) . toPerson } (object) required |
| get_digitalaccount_invoice | Consulta informações de um boleto à partir do código de barras. | Barcode (string) DigitableLine (string) |
| post_digitalaccount_movement | Realiza uma movimentação financeira entre a conta atrelada ao AccessToken usuário logado e outra conta RoadPass. Para movimentação instantânea, o campo 'date' pode estar 'null' e para movimentações agendadas, deve ser enviado 'yyyy-MM-dd' | UserPassword (string) required data: { . value (number) . description (string) . date (string) . toAccount } (object) required |
| post_digitalaccount_ted | Realiza um TED entre a conta atrelada ao AccessToken usuário logado e uma conta bancária externa | UserPassword (string) required data: { . value (number) . description (string) . date (string) . toAccount } (object) required |
| post_digitalaccount_send_document | Evento para envio do documento RG/CNH para liberação do acesso total Device_ID - and gt; id único do dispositivo | Device_ID (string) required data: { . base64 (string) } (object) required |
| post_digitalaccount_get_images | Retorna a imagem cadastrada durante a criação da conta e a imagem enviada durante o processo de liberar o acesso do dispositivo Id - and gt; id único gerado durante o cadastro do dispositivo | Id (integer) required |
| post_digitalaccount_release_acess | Evento para liberar o acesso total após comparar as imagens do documento Id - and gt; id único gerado durante o cadastro do dispositivo | Id (integer) required |
| post_digitalaccount_update_status_device | Evento para atualizar status de pendente para autorizado Header Id - and gt; retorno da validação SMS Body: id - and gt; id único gerado durante o cadastro do dispositivo. | Id (string) required data: { . id (integer) } (object) required |
| post_digitalaccount_update_acess_type_device | Evento para atualizar tipo de acesso do dispositivo Acesso Parcial/Total Header: Id - and gt; retorno da validação SMS Device_id - and gt; Id único do dispositivo Body: id - and gt; id único gerado durante o cadastro do dispositivo. | UserPassword (string) required Id (string) required Device_id (string) required data: { . id (integer) } (object) required |
| delete_digitalaccount_delete_device | Remove uma chave Pix para o AccessToken usuário logado. Header: Id_sms - and gt; Id retornado do endpoint de validação Id - and gt; id único gerado durante o cadastro do dispositivo que será deletado. Device_id - and gt; Id único do dispositivo com acesso total IsOwner - and gt; Flag para identificar se o proprietário reconhece a tentativa de login false - and gt; não reconhece | UserPassword (string) required Id_sms (string) required Id (string) required Device_id (string) IsOwner (boolean) |
| get_digitalaccount_get_devices_auth | Evento para listar dispositivos liberados para acessar a conta. | No parameters |
| post_digitalaccount_send_sms | Evento para envio do sms para confirmação. | No parameters |
| post_digitalaccount_send_email | Evento para envio do e-mail para confirmação. | No parameters |
| post_digitalaccount_validate | Evento para validar o token enviado por sms/email. | Id (string) required Token (string) required |
| post_digitalaccount_validate_token | Evento para validar o token enviado por sms/email. Channel SMS ou EMAIL | Id guid retorno do envio sms ou email | Channel (string) required Id (string) required Token (string) required |
| post_create_account | No description available | OnboardingId (string) Password (string) MicroType (string) data: { . name (string) . document (string) . email (string) . ddd (string) . phone (string) . street (string) . complement (string) . neighborhood (string) . number (string) . city (string) . state (string) . zipcode (string) . password (string) . hash (string) . additionalData } (object) required |
| get_api_user_document | Consultar um documento de uma conta. | Id (string) required |
| post_api_user_document | Atualiza ou inserir um arquivo para o portador. O nome deve ser o tipo do document IDENTIFICAÇÃO, RESIDÊNCIA, DOCUMENTO | data: { . name (string) . extention (string) . data (string) . documentType (string) . documentDate (string) . documentNumber (string) . entityDocument (string) . estateEntityDocument (string) } (object) required |
| post_api_user_document_term_residence | Insere o termo assinado de declaração de residência para o portador. O Type pode ser do tipo RESIDENCIA | Type (string) required |
| post_api_email_random_password | No description available | No parameters |
| get_invoice | Retorna as faturas vinculadas a uma conta cartão, para discriminar o tipo fatura no header informe o campo invoiceType com as opções RESUME, DETAILED, CLOSED, OPEN, PDF e BARCODE. | AccessKey (string) required CardCode (string) InvoiceType (string) required StartDate (string) EndDate (string) |
| get_invoice_accesskey_by_accesskey_cardcode_by_cardcode_pdf_by_pdf | retorna a fatura em pdf . | accesskey (string) cardcode (string) pdf (string) |
| get_invoice_pdf | No description available | AccessKey (string) required CardCode (string) required EndDate (string) required |
| get_invoice_duedate | Consulta a data de fechamento da fatura do cartão. | AccessKey (string) required CardCode (string) |
| put_invoice_duedate | Realiza alteração da data de vencimento da fatura, as datas disponiveis são 1, 15, 27. | AccessKey (string) required CardCode (string) required data: { . newduedate (integer) } (object) required |
| get_api_manage_onboarding_consult | No description available | pass (string) required document (string) required |
| get_onboarding_userstatus | Verifica se o usuario existe na base de dados tabela Leads | document (string) required ProductType (integer) |
| post_onboarding_register | Registra ou atualiza os dados do usuário, gerando informações de acesso e portador Pré-cadastro. | OperationalPassword (string) data: { . guid (string) . name (string) . document (string) . email (string) . password (string) . birthdate (string) . zipcode (string) . street (string) . number (string) . complement (string) . neighborhood (string) . city (string) . uf (string) . occupation (string) . income (number) . ddd (string) . phone (string) . mother (string) . father (string) . birth_local (string) . gender (string) . associated_guid (string) . origin (string) . documentTypeEnum (string) . isGuest (boolean) . productType (integer) } (object) required |
| get_onboarding_register | Busca o registro de usuário com a visão de segmentos validados, na tabela LeadsPré-cadastro. | Id (string) required |
| get_onboarding_register_document | Busca o registro de usuário com a visão de segmentos validados, na tabela LeadsPré-cadastro. | Document (string) required |
| get_onboarding_register_evaluate | Realiza a avaliação no datatrust para os dados realizados no pré-cadastro, caso estejam con todas as marcações concluídas. | Id (string) required |
| post_onboarding_register_convert | Realiza a conversão do pré-cadastro em um novo usuário no caso de apresentar a pontuação suficiente. | Id (string) required data: { . device_name (string) . device_id (string) } (object) required |
| patch_onboarding_photo_doc | End point para validar documento | Id (string) required |
| put_onboarding_data_guest | Atualiza dados da tabela Leads. Possibilidades de income em string: 'Até R$ 1.000,00', 'De R$ 1.000,00 à R$ 2.000,00', 'De R$ 2.000,00 à R$ 5.000,00', 'Mais de. R$ 5.000,01'. qq outra cai no default que é 0.0f.s | Id (string) required data: { . fullName (string) . birthDate (string) . nationality (string) . gender (string) . motherName (string) . fatherName (string) . income (string) . documentInstitution (string) } (object) required |
| post_onboarding_income | Atualiza dados da tabela Leads. | Id (string) required data: { . income (string) } (object) required |
| patch_onboarding_face_match | Endpoint para validar FaceMatch | Id (string) required |
| get_onboarding_document_copy | No description available | Id (string) required |
| get_onboarding_phone_email | Realiza a consulta de dados telefone e email de um usuario cadastrado. | Id (string) required |
| post_onboarding_token_send_sms | Envia um novo token por sms para o número cadastrado. | Id (string) required Update (boolean) data: { . ddd (string) . number (string) } (object) required |
| post_onboarding_token_send_email | Gera uma nova senha e envia par ao e-mail de notificação cadastrado. | Id (string) required Update (boolean) data: { . email (string) } (object) required |
| get_onboarding_token_validate_sms | Valida o token enviado para o usuário por SMS resultados possíveis: Valid, Incorrect, Invalid ou Expired | Id (string) required Token (string) required |
| get_onboarding_token_validate_email | Valida o token enviado para o usuário por E-mail resultados possíveis: Valid, Incorrect, Invalid ou Expired | Id (string) required Token (string) required |
| get_onboarding_term | Necessario passar a TenantKey e o tipo de termo termType como string. | TermType (string) PDF (boolean) |
| post_onboarding_term | Necessario passar a TenantKey e o tipo de termo termType como string, o guid do registerUser como id e o accessToken do webUser | TermType (string) Id (string) |
| get_onboarding_declaration | Necessario passar a TenantKey e o tipo de declaration declarationType como string. | DeclarationType (string) Pdf (boolean) |
| post_onboarding_declaration | Necessario passar a TenantKey como string, o accessToken do webUser e o booleano dizendo se o PPE é true ou false. | Id (string) DeclarationType (string) PPE (boolean) required |
| post_onboarding_account_open | Realiza oo processo de abertura de conta | No parameters |
| post_onboarding_facematch_liveness | No description available | LivenessId (string) required Id (string) required |
| post_onboarding_pixaccount | Atender novos clientes-parceiros que precisam abrir contas de seus clientes na estrutura de conta digital | Password (string) required data: { . name (string) . document (string) . email (string) . password (string) . birthDate (string) . zipCode (string) . street (string) . number (string) . complement (string) . neighborhood (string) . city (string) . state (string) . occupation (string) . income (number) . ddd (string) . phone (string) . motherName (string) . fatherName (string) . birthLocal (string) . gender (string) . ipSignature (string) . dateTimeSignature (string) . pep (boolean) . acceptTerms (boolean) . sendEMail (boolean) . sendNotification (boolean) } (object) required |
| post_payment_consult | Consulta os dados do boleto ou convênio por meio de uma conta associada a um AccessToken usuário logado. | data: { . barcode (string) } (object) required |
| post_payment_pay_invoice_deprecated | No description available | UserPassword (string) required data: { . valueKind } (object) required |
| get_payment_pay_consult | No description available | accessToken (string) invoice (string) isDarf (boolean) dueDate (string) |
| post_payment_pay_invoice | No description available | UserPassword (string) required data: { . cnpjCpfBeneficiario (string) . cnpjCpfPagador (string) . codigoDeBarras (string) . linhaDigitavel (string) . situacao (string) . codigoSituacao (string) . motivo (string) . nomeBeneficiario (string) . nomePagador (string) . razaoSocialBeneficiario (string) . permitePagamentoParcial (boolean) . permiteAlterarValorTotal (boolean) . validarDuplicidade (boolean) . habilitaMP (boolean) . valorDesconto (number) . desconto (number) . valorAbatimento (number) . abatimento (number) . juros (number) . multa (number) . valor (number) . valorNominal (number) . valorMaximo (number) . valorMinimo (number) . valorTotal (number) . dataVencimento (string) . dataLimitePagamento (string) . dataHoraConsultaBoleto (string) . tipoAutorizacaoRecebimentoValorDivergente (string) . tipoPagamentoDiverso (string) . codigoEspecieTitulo (string) . type . sacadorAvalista } (object) required |
| get_person_notifications_list | No description available | skip (integer) required size (integer) required accessToken (string) required |
| post_api_v1_pix_payment_pay_account | Realiza a criação de uma ordem de pagamento, enviando uma quantia por PIX a um cpf ou cnpj a travéz da informação de agencia e conta válida do recebedor. Para agendar um pagamento, o campo date deve seguir o seguinte formato: yyyy-MM-dd. | UserPassword (string) required data: { . agency (string) . account (string) . accountType (string) . document (string) . value (number) . date (string) . description (string) . reference (string) . bank (string) . name (string) } (object) required |
| get_api_v1_pix_limits | Realiza a consulta dos limites para transações da conta digital do usuario logado. | No parameters |
| post_api_v1_pix_limits_by_modality | Realiza a alteração dos limites para transações da conta digital do usuario logado. | Modality (string) UserPassword (string) required data: { . personNigthTimeLimit (number) . personDayTimeLimit (number) . enterpriseNigthTimeLimit (number) . enterpriseDayTimeLimit (number) } (object) required |
| get_api_v1_pix_get_night_time | No description available | No parameters |
| get_api_v1_pix_list_night_time_options | No description available | No parameters |
| patch_api_v1_pix_set_night_time | No description available | data: { . nightTimeIdentifier (string) . nightTime (string) } (object) required |
| post_pix_addressing_claim | Realiza a solicitação de portabilidade ou revindicação de uma chave Pix para o AccessToken usuário logado. Os dados utilizados Os tipos permitidos são 'OWNERSHIP' revindicação ou 'PORTABILITY' portabilidade. Os tipos de chave permitidos são 'EMAIL', 'CPF/CNPJ' ou 'CELULAR' | data: { . type (string) . key (string) . keyType (string) } (object) required |
| post_pix_addressing_claim_confirm | Realiza a confirmação do recebimento da revindicação de chave Os motivos aceitos são: 'USER_REQUESTED', 'ACCOUNT_CLOSURE', 'DEFAULT_OPERATION' | Id (string) required Reason (string) required |
| post_pix_addressing_claim_cancel | Cancela uma reivindicação de chave de endereçamento. Serviço para cancelar um processo de reivindicação/portabilidade. Os motivos aceitos são: 'USER_REQUESTED', 'ACCOUNT_CLOSURE', 'FRAUD', 'DEFAULT_OPERATION' | Id (string) required Reason (string) required |
| post_pix_addressing_claim_list | Lista todas as solicitações de revindicação/portabildiade de chaves PIX conforme os filtros selecionados no corpo da requisição | data: { . isDonor (boolean) . isClaimer (boolean) . claimStatus (string) . claimType (string) . modifiedAfter (string) . modifiedBefore (string) . limit (integer) . isClaimerPerson (boolean) . claimerParticipant (string) . isDonorPerson (boolean) . donorParticipant (string) } (object) required |
| get_pix_addressing_claim_by_id | Retorna a solicitação de revindicação/portabildiade de chave PIX pelo Id da requisição | id (string) |
| post_pix_addressing_create | Realiza a geração de uma chave Pix para o AccessToken usuário logado. Os dados utilizados para geração de chave estão devidamente validados no cadastro ou atualização de dados do usuário, sendo necessário apenas passar um dos tipos de chave permitidos: CPF/CNPJ, CELULAR, EMAIL ou EVP | KeyType (string) required |
| delete_pix_addressing_delete | Remove uma chave Pix para o AccessToken usuário logado. | KeyType (string) required |
| get_pix_addressing_account_by_key | Consulta uma chave Pix para o AccessToken usuário logado que foi criada no RPNet. | key (string) |
| get_pix_addressing_account_list | Consulta a lista de chaves Pix para o AccessToken usuário logado que foram criadas no RPNet. | No parameters |
| get_pix_addressing_consult_by_key | Consulta uma chave Pix qualquer no sistema do Banco Central. | key (string) |
| get_pix_addressing_consult_list_by_document | Consulta a lista de chaves Pixs associadas à um documento CPF/CNPJ no sistema do Banco Central. | document (string) |
| get_pix_addressing_consult_list_by_document_by_agency | Consulta a lista de chaves Pixs associadas à um documento CPF/CNPJ e agência bancária no sistema do Banco Central. | document (string) agency (string) |
| get_pix_addressing_consult_list_by_document_by_agency_by_account | Consulta a lista de chaves Pixs associadas à um documento CPF/CNPJ, agência bancária e número de conta no sistema do Banco Central. | document (string) agency (string) account (string) |
| post_pix_qrcode_consult | Realiza a consulta de um código QR estático, utilizado o código QA e o tipo de código aplicado, podendo ser DEFAULT ou BASE64. | data: { . qrCodeType (string) . qrCode (string) } (object) required |
| post_pix_qrcode_static | Realiza a geração de um código QR estático, utilizado em operações de identificação de conta à partir de uma chave ou realizações de pagamentos repetidos por mieo do mesmo código QR. As opções de tipos de códigos pode ser DEFAULT, BASE64, IMAGE ou URLBASE. | QRCodeType (string) required data: { . value (number) . key (string) . description (string) . identification (string) } (object) required |
| post_pix_qrcode_dinamic | Realiza a geração de um código QR dinâmico, utilizado em operações específicas à partir de uma chave em grande parte para realização de uma transação única, mas é possível a reutilização, caso marcado para isso. As opções de tipos de códigos pode ser DEFAULT, BASE64, IMAGE ou URLBASE. | QRCodeType (string) required data: { . expirationSeconds (integer) . validDaysAfterExpiration (integer) . dueDate (string) . payerDocument (string) . payerName (string) . value (number) . interestValue (number) . indentification (string) . fineValue (number) . discoutValue (number) . reductionValue (number) . key (string) . description (string) . reuse (boolean) } (object) required |
| post_pix_payment_pay_key | Realiza a criação de uma ordem de pagamento, enviando uma quantia por PIX atravéz de uma chave própria válida para outra chave de usuário. Para agendar um pagamento, o campo date deve seguir o seguinte formato: yyyy-MM-dd. | UserPassword (string) required data: { . key (string) . value (number) . keyType (string) . date (string) . description (string) . reference (string) . dueDate (string) . interestPercent (number) . interestValue (number) . lateFeePercent (number) . lateFeeValue (number) . finePeriod (string) . discountValue (number) } (object) required |
| get_pix_scheduled_list | No description available | InitialDate (string) required FinalDate (string) required |
| get_pix_scheduled_by_transaction_id | No description available | transactionId (string) |
| delete_pix_scheduled_by_transaction_id | No description available | transactionId (string) |
| get_api_user_avatar | Consultar o avatar do portador. | No parameters |
| post_api_user_auth | Operação de login na carteira pede as credenciais previamente informadas no cadastro de portador. Cada portador possui um login número do documento e uma senha de 6 digitos. | data: { . login (string) . password (string) . expiration (integer) } (object) required |
| post_api_user_login | Obtém dados básicos do usuário e gera o AccessToken para realização das operações. | Device_id (string) Device_name (string) data: { . login (string) . password (string) . expiration (integer) } (object) required |
| post_api_user_refresh | Obtém um novo 'AccessToken' com o tempo de expiração renovado. | No parameters |
| post_api_user_resetpass | Gera uma nova senha e envia par ao e-mail de notificação cadastrado. | data: { . email (string) . login (string) . operationalpassword (string) } (object) required |
| put_api_user_update_register | Atualiza os dados de registro do usuário. | data: { . name (string) . birthdate (string) . zipcode (string) . street (string) . number (string) . complement (string) . neighborhood (string) . city (string) . uf (string) . occupation (string) . income (number) . mother (string) . father (string) . birth_local (string) . gender (string) } (object) required |
| post_api_user_update | Atualiza os dados do portador. | data: { . name (string) . document (string) . birthdate (string) . notificationEmail (string) . celphone (string) . zipcode (string) . street (string) . number (string) . complement (string) . neighborhood (string) . city (string) . state (string) . documentType (string) . documentNumber (string) . documentDate (string) . documentDispatcher (string) . documentDispatcherState (string) . ddd (string) . phone (string) . publicPersonpublic (boolean) . remuneration (number) . gender (string) . mother (string) . father (string) . birth_local (string) . entityDocument (string) . estateEntityDocument (string) . associated_guid (string) } (object) required |
| post_api_user_avatar_upsert | Atualiza ou inserir um avatar para o portador. | data: { . extention (string) . data (string) } (object) required |
| get_api_user_notification_list | Listar as notificações de usuário, permitindo a filtragem por 'Lido' ou 'Todos' e a limitaçãod e quantidade semrpe ordernado do mais recente para o mais antigo | OnlyUnreaded (boolean) Limit (integer) |
| get_api_user_notification | Obtém uma notificação específica por meio de um Id único. | Id (string) required |
| get_api_user_notification_not_read_count | Retorna a quantidade de notificações não lidas de um usuário. | No parameters |
| post_api_user_notification_read | Marca uma notificação como 'Lida'. | Id (string) required |
| get_api_utils_associateds | Lista os associados ao Tenant | No parameters |
| get_api_utils_associated | Busca o associado ao Tenant por código único | Guid (string) required |
| get_api_utils_banks | Lista os bancos e seus respectivos códigos para realização de trasferências | No parameters |
| get_api_utils_account | Consulta uma conta à partir do número do documento de um portador | document (string) required |
| get_api_utils_cep_by_cep | Método para consulta de endereço pelo CEP. | CEP (string) |
| get_api_utils_occupations | Método para consulta a lsita de profissões. | No parameters |