Introdução Banking - bs2.pj.apibanking.forintegration - Versão: 1

Introdução Banking

Clique aqui para acessar a versão anterior

O que é API de Banking?

API Banking disponibiliza operações relacionadas a gestão da conta bancária.

Quem pode usar a API de Banking?

Todos os clientes e parceiros do banco BS2.

Quais são requisitos para a utilização da API de Banking ?

Autenticação

Autenticação v2

Utilizamos em nossas API’s de autenticação um rate-limit, que permite até 10 requisições de Token e refresh por minuto, sendo necessário realizar o gerenciamento de token descrito abaixo:

Obtenção do Token

Para obter o token de acesso é necessário acessar a plataforma BS2 Empresas, entrar no produto API Banking e criar uma aplicação.

Ao criar a aplicação, deve ser informado as funcionalidades que a mesma terá acesso.

image

Após preencher as informações e seguir para o próximo passo, será solicitado o 2º fator de autenticação do usuário logado, podendo utilizar o token do aplicativo BS2 Empresas ou sms.

Com o token 2fa validado, serão apresentadas as credencias da aplicação.

image

Para obter o token de acesso é necessário realizar o fluxo de refresh_token com os dados do passo anterior.

Gerenciamento de Token

É necessário fazer a gestão do token de acesso e do refresh_token dentro do seu sistema.

Caso precise gerar as credenciais novamente, basta acessar a plataforma BS2 Empresas, entrar no produto API Banking, selecionar a aplicação desejada e clicar na opção Gerar novo token.

image

Pontos Importantes

O cadastro de aplicação é por conta bancária.

Só é necessário acessar a plataforma para gerar um novo token, caso não consiga realizar o fluxo de refresh_token.

O campo expires_in representa a validade do token em segundos, enquanto o token estiver válido, este token deve ser utilizado.

O refresh_token possui um tempo de validade maior que a validade do token (48 horas), ou seja, mesmo se o token de acesso estiver inválido há bastante tempo, e o refresh_token estiver válido, ainda é possível fazer o fluxo de refresh_token para gerar um novo token válido.

Quando o token estiver próximo da validade, deve-se gerar um novo token, usando um refresh_token, para assim, receber um novo token válido pelo mesmo período de tempo.

Não há limite de requisições enquanto o token estiver válido.

Quando um novo token é gerado, o token anterior passa a ser inválido.

É importante frisar que a cada novo token gerado, um novo refresh_token também é gerado.

O token de acesso é necessário para todas as requisições em nossas APIs.

Token de Atualização

1.1 Realizar uma requisição Basic Auth no endpoint abaixo com apikey e apisecret da aplicação.

1.2 Informar o valor refresh_token para o campo grant_type.

1.3 Informar o escopo da aplicação para o campo scope.

1.4 Informar o valor do refresh token recebido previamente para o campo refresh_token.

{
  "grant_type": "refresh_token",
  "scope": "scope aplicacao",
  "refresh_token": "refresh_token"
}
{
  "access_token": "seu_access_token_guid",
  "token_type": "tipo_de_token",
  "expires_in": "tempo_de_expiracao_em_segundos",
  "refresh_token": "seu_refresh_token_guid",
  "scope": "escopo da aplicação"
}

Parâmetros

Nome Localizado em Descrição Requerido
grant_type body Define o tipo de requisição Sim
scope body Define qual o escopo da requisição Sim
refresh_token body Inserir o refresh token recebido previamente Sim

Resposta

Código Descrição
200 Success
400 Bad Request
401 Unauthorized

Conta Corrente

Consulta de Saldo

Obtém o saldo da conta


--curl
"GET": "/pj/apibanking/forintegration/v1/contascorrentes/saldo"

{
    "valor": 0,
    "valorBloqueado": 0
}

Parâmetros

Não existe parâmetros!

Resposta

Código Descrição Schema
200 Success bs2.pj.banking.contasCorrentes.ObterSaldoResponse
400 Bad Request [ bs2.pJ.utilities.web.responseResult.DetalheBadRequest ]

Consulta de Extrato

Obtém o extrato da conta


--curl
"GET": "/pj/apibanking/forintegration/v1/contascorrentes/extrato"

{
    "saldo": {
        "inicial": 0,
        "final": 0,
        "bloqueado": {
            "por24Horas": 0,
            "por48Horas": 0,
            "acima": 0,
            "judicial": 0
        }
    },
    "chequeEspecial": {
        "taxaJuros": 0,
        "valorLimite": 0,
        "vencimento": "2021-8-2T22:50:57.307Z",
        "iof": 0,
        "juros": 0,
        "cet": 0,
        "diasUtilizacao": 0
    },
    "movimentacoes": [
    {
        "movimentadoEm": "2021-8-2T22:50:57.307Z",
        "descricao": "string",
        "descricaoAbreviada": "string",
        "valor": 0,
        "tipoMovimentacao": "1-Debito", // enum: "1-Debito", "2-Credito"
        "tipoCategoria": "1-Pagamento", // enum: "1-Pagamento", "2-Transferencia", "3-Deposito", "4-Saque", "5-EstornoPagamento", "6-EstornoTransferencia", "7-Tarifa", "8-EstornoTarifa", "99-Outros"
        "documento": "string",
        "observacao": "string",
        "protocolo": "string",
        "remetente": {
            "nome": "string",
            "documento": "string",
            "nomeBanco": "string",
            "banco": 0,
            "agencia": 0,
            "conta": 0
        },
        "favorecido": {
            "nome": "string",
            "documento": "string",
            "nomeBanco": "string",
            "banco": 0,
            "agencia": 0,
            "conta": 0
        }
    }
    ],
    "inicio": 0,
    "limite": 0,
    "total": 0
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
movimentoInicial query   Não dateTime
movimentoFinal query   Não dateTime
inicio query   Não integer
limite query   Não integer

Resposta

Código Descrição Schema
200 Success bs2.pj.banking.contasCorrentes.ObterExtratoResponse
400 Bad Request [ bs2.pJ.utilities.web.responseResult.DetalheBadRequest ]

Transferência

Efetua TED para qualquer titularidade sem cadastro do favorecido


{
    "favorecido": {
        "nome": "string",
        "documento": "string",
        "contaDestino": {
            "agencia": "string",
            "numero": "string",
            "banco": {
                "codigo": 0,
                "nome": "string"
            },
            "tipoConta": "1-Pagamento" // enum: "1-Pagamento", "2-Corrente", "3-Poupanca"
        }
    },
    "mesmaTitularidade": false,
    "valor": 0,
    "efetuarEm": "2021-8-2T22:50:57.307Z"
}

{
    "solicitacaoId": "string",
    "executada": false,
    "mensagem": "string"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pj.transferencias.EfetuarTransferenciaRequest

Resposta

Código Descrição Schema
201 Success bs2.pj.transferencias.EfetuarTransferenciaResponse
400 Bad Request [ bs2.pJ.utilities.web.responseResult.DetalheBadRequest ]

Obter dados da transferência

Obtém detalhes da transferência


--curl
"GET": "/pj/apibanking/forintegration/v1/transferencias/{solicitacaoId}"

{
    "id": "string",
    "contaOrigem": 0,
    "valor": 0,
    "codigoFinalidade": 0,
    "dataTransacao": "2021-8-2T22:50:57.307Z",
    "favorecido": {
        "nome": "string",
        "documento": "string",
        "contaDestino": {
            "banco": {
                "codigo": 0,
                "nome": "string"
            },
            "agencia": "string",
            "numero": "string"
        }
    }
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
solicitacaoId path   Sim string (uuid)

Resposta

Código Descrição Schema
200 Success bs2.pj.transferencias.ObterTransferenciaPorIdResponse
400 Bad Request [ bs2.pJ.utilities.web.responseResult.DetalheBadRequest ]

Consulta do status da solicitação de transferência

Consulta a situação da solicitação de transferência


--curl
"GET": "/pj/apibanking/forintegration/v1/transferencias/solicitacoes/{solicitacaoId}"

{
    "id": "string",
    "situacao": "string",
    "status": "1-Cancelado" // enum: "1-Cancelado", "2-CanceladoAutomaticamente", "3-Agendado", "4-Processando", "5-Concluido", "6-AguardandoAprovacao", "7-Reprovado", "8-Falha"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
solicitacaoId path   Sim string (uuid)

Resposta

Código Descrição Schema
200 Success bs2.pj.transferencias.ObterStatusSolicitacaoTransferenciaPorIdResponse
400 Bad Request [ bs2.pJ.utilities.web.responseResult.DetalheBadRequest ]

Pagamento de boleto

Efetua pagamento de título de cobrança ou arrecadação pelo código de barras ou pela linha digitável


{
    "codigoIdentificacao": "string",
    "valor": 0,
    "efetuarEm": "2021-8-2T22:50:57.307Z",
    "vencimentoEm": "2021-8-2T22:50:57.307Z"
}

{
    "solicitacaoId": "string",
    "executada": false,
    "mensagem": "string"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pj.banking.pagamentos.EfetuarPagamentoRequest

Resposta

Código Descrição Schema
201 Success bs2.pj.banking.pagamentos.EfetuarPagamentoResponse
400 Bad Request [ bs2.pJ.utilities.web.responseResult.DetalheBadRequest ]

Consulta de boleto

Consulta pagamento de título de cobrança ou arrecadação pelo código de barras ou pela linha digitável


--curl
"GET": "/pj/apibanking/forintegration/v1/pagamentos/{codigoIdentificacao}"

{
    "dataPagamento": "2021-8-2T22:50:57.308Z",
    "dataVencimento": "2021-8-2T22:50:57.308Z",
    "banco": {
        "codigo": 0,
        "nome": "string"
    },
    "beneficiario": {
        "nome": "string",
        "documento": "string"
    },
    "valores": {
        "boleto": 0,
        "cobrado": 0,
        "descontos": 0,
        "documento": 0,
        "mora": 0,
        "outrasDeducoes": 0,
        "outrosAcrescimos": 0
    },
    "descricaoPagamento": "string",
    "nomePagador": "string",
    "codigoBarras": "string",
    "linhaDigitavel": "string",
    "cedente": "string"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
codigoIdentificacao path   Sim string

Resposta

Código Descrição Schema
200 Success bs2.pj.banking.pagamentos.ObterPagamentoResponse
400 Bad Request [ bs2.pJ.utilities.web.responseResult.DetalheBadRequest ]

Consulta do status da solicitação de pagamento

Consulta a situação da solicitação de pagamento


--curl
"GET": "/pj/apibanking/forintegration/v1/pagamentos/solicitacoes/{solicitacaoId}"

{
    "id": "string",
    "situacao": "string",
    "status": "1-Cancelado" // enum: "1-Cancelado", "2-CanceladoAutomaticamente", "3-Agendado", "4-Processando", "5-Concluido", "6-AguardandoAprovacao", "7-Reprovado", "8-Falha"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
solicitacaoId path   Sim string (uuid)

Resposta

Código Descrição Schema
200 Success bs2.pj.banking.pagamentos.ObterStatusSolicitacaoPagamentoPorIdResponse
400 Bad Request [ bs2.pJ.utilities.web.responseResult.DetalheBadRequest ]

Webhook

Webhook de movimentação de CC (extrato)

O Banco BS2 disponibiliza um webhook para notificar os clientes em tempo real sobre as movimentações que ocorram na conta. Cada linha do extrato é enviada para o cliente que deseja receber esse webhook no momento em que o evento entra no extrato. Para utilizar o webhook, por favor entre em contato com a equipe do BS2 informando uma URL para que possamos ativar o webhook para você. No momento essa operação é feita apenas manualmente, sendo necessário a solicitação para a equipe Tech do BS2 Empresas.

Funcionamento

O webhook será disparado via uma requisição HTTP POST até que o cliente retorne com um status de sucesso (família HTTP 200).

Contrato

Abaixo segue o contrato que será enviado na requisição com os dados da transferência. Cada webhook é exclusivo para uma transferência. Para cada transferência uma nova chamada será feita.

{
  "Id": "dfc2b944-4572-4d94-83a0-791de441ab99",
  "Conta": 254584,
  "DataNotificacao": "2019-10-22T20:18:55.8463059-03:00",
  "Cliente": {
    "Nome": "DXS GESTAO E CONSULTORIA EMPRESARIAL EIRELI",
    "CpfCnpj": "30177427000120"
  },
  "FavorecidoRemetente": {
    "Nome": "JAIR JUNIOR DOS REIS BORGES",
    "CpfCnpj": "04153796603"
  },
  "ContaOrigem": {
    "Banco": 218,
    "Agencia": 1,
    "Conta": 259608
  },
  "ContaDestino": {
    "Banco": 218,
    "Agencia": 1,
    "Conta": 254924
  },
  "Movimento": {
    "Data": "2019-10-22T20:17:45.343+00:00",
    "Tipo": "C",
    "Codigo": 786,
    "Descricao": "RECEB.TRANSF.ENT.CONTAS IB"
  },
  "Valor": 258.74
}

Descrição dos campos do modelo principal

Abaixo segue tabela descritiva dos campos enviados na notificação:

Campo Descrição
Id Código único da notificação
Conta Identificação da conta bancária
DataNotificacao Data do disparo do webhook ao parceiro
Cliente Dados do cliente que está recebendo a notificação. [Vide tabela abaixo]
FavorecidoRemetente Dados do favorecido/remetente. [Vide tabela Cliente abaixo]
ContaOrigem Banco, agência e conta do remetente da transferência. [Vide tabela Conta abaixo]
ContaDestino Banco, agência e conta do favorecido, no momento, seus dados
Movimento Detalhes do movimento [Vide tabela abaixo]
Valor Valor da transferência

Descrição dos campos do modelo Cliente

Abaixo segue a tabela descritiva dos campos enviados nos itens Cliente e FavorecidoRemetente

Campo Descrição
Nome Nome do portador do CPF/CNPJ
CpfCnpj Documento

Descrição dos campos do modelo Conta

Abaixo segue a tabela descritiva dos campos enviados nos itens ContaOrigem e ContaDestino

Campo Descrição
Banco Código do banco
Agencia Número da agência
Conta Número da conta

Descrição dos campos do modelo Movimento

Abaixo segue a tabela descritiva dos campos enviados no item Movimento

Campo Descrição
Data Data em que a operação foi realizada
Tipo Tipo de operação - C – Crédito / D – Débito
Codigo Código do tipo de movimento
Descricao Descrição do tipo movimento

Models

DetalheBadRequest

bs2.pJ.utilities.web.responseResult.DetalheBadRequest

Nome Tipo Descrição Tamanho Requerido
tag string   - Não
descricao string   - Não

Bloqueado

bs2.pj.banking.contasCorrentes.Bloqueado

Dto de bloqueio

Nome Tipo Descrição Tamanho Requerido
por24Horas double Valor bloqueado por 24 horas - Não
por48Horas double Valor bloqueado por 48 horas - Não
acima double Valor bloqueado acima - Não
judicial double Valor bloqueado judicialmente - Não

Saldo

bs2.pj.banking.contasCorrentes.Saldo

Dto de Saldo

Nome Tipo Descrição Tamanho Requerido
inicial double Saldo anterior as movimentações no periodo pesquisado - Não
final double Saldo posterior as movimentações no periodo pesquisado - Não
bloqueado bs2.pj.banking.contasCorrentes.Bloqueado   - Não

ChequeEspecial

bs2.pj.banking.contasCorrentes.ChequeEspecial

Dto de cheque especial

Nome Tipo Descrição Tamanho Requerido
taxaJuros double Taxa de juros do cheque especial - Não
valorLimite double Valor limite do cheque especial - Não
vencimento dateTime Data de vencimento - Não
iof double IOF cobrado - Não
juros double Total de juros acumulados - Não
cet double Custo efetivo total - Não
diasUtilizacao integer Quantidade de dias de utilização do cheque especial - Não

TipoMovimentacao

bs2.pj.banking.contasCorrentes.TipoMovimentacao

Nome Tipo Descrição Tamanho Requerido
bs2.pj.banking.contasCorrentes.TipoMovimentacao integer   -  

TipoCategoria

bs2.pj.banking.contasCorrentes.TipoCategoria

Nome Tipo Descrição Tamanho Requerido
bs2.pj.banking.contasCorrentes.TipoCategoria integer   -  

ContaBancariaMovimento

bs2.pj.banking.contasCorrentes.ContaBancariaMovimento

Conta bancária relacionada a um movimento

Nome Tipo Descrição Tamanho Requerido
nome string Nome da pessoa - Não
documento string Documento da pessoa - Não
nomeBanco string Nome do banco relacionado a conta - Não
banco integer Número do banco relacionado a conta - Não
agencia integer Número da agência - Não
conta long Número da conta - Não

Movimento

bs2.pj.banking.contasCorrentes.Movimento

Dto de movimento

Nome Tipo Descrição Tamanho Requerido
movimentadoEm dateTime Data de movimentação - Não
descricao string Descrição do movimento - Não
descricaoAbreviada string Descrição abreviada do movimento - Não
valor double Valor do movimento - Não
tipoMovimentacao enum 1-Debito, 2-Credito - Não
tipoCategoria enum 1-Pagamento, 2-Transferencia, 3-Deposito, 4-Saque, 5-EstornoPagamento, 6-EstornoTransferencia, 7-Tarifa, 8-EstornoTarifa, 99-Outros - Não
documento string Documentação do movimento - Não
observacao string Observação do movimento - Não
protocolo string Número de identificação do movimento - Não
remetente bs2.pj.banking.contasCorrentes.ContaBancariaMovimento   - Não
favorecido bs2.pj.banking.contasCorrentes.ContaBancariaMovimento   - Não

ObterExtratoResponse

bs2.pj.banking.contasCorrentes.ObterExtratoResponse

Resposta de extrato

Nome Tipo Descrição Tamanho Requerido
saldo bs2.pj.banking.contasCorrentes.Saldo   - Não
chequeEspecial bs2.pj.banking.contasCorrentes.ChequeEspecial   - Não
movimentacoes [ bs2.pj.banking.contasCorrentes.Movimento ] Histórico de movimentação no período pesquisado - Não
inicio integer índice da paginação - começando por zero - Não
limite integer Número limite de transações por página - Não
total long Total de transações encontradas - Não

ObterSaldoResponse

bs2.pj.banking.contasCorrentes.ObterSaldoResponse

Resposta de saldo

Nome Tipo Descrição Tamanho Requerido
valor double Valor do saldo disponível - Não
valorBloqueado double Valor do saldo bloqueado - Não

DetalheBadRequest

bs2.pJ.empresas.http.responseResult.DetalheBadRequest

Nome Tipo Descrição Tamanho Requerido
tag string   - Não
descricao string   - Não

NotificacaoMovimentacaoConta

bs2.pj.notificacao.movimentacaoConta.NotificacaoMovimentacaoConta

Nome Tipo Descrição Tamanho Requerido
conta integer   - Não
nomeCliente string   - Não
cpfCnpjCliente string   - Não
valor double   - Não
nomeFavorecidoRemetente string   - Não
cpfCnpjFavorecidoRemetente string   - Não
tipoMovimento string   - Não
codigoMovimento integer   - Não
descricaoMovimento string   - Não
bancoOrigem integer   - Não
agenciaOrigem integer   - Não
contaOrigem long   - Não
bancoDestino integer   - Não
agenciaDestino integer   - Não
contaDestino long   - Não
dataHoraMovimento dateTime   - Não

EfetuarPagamentoRequest

bs2.pj.banking.pagamentos.EfetuarPagamentoRequest

Requisição para efetuar pagamento

Nome Tipo Descrição Tamanho Requerido
codigoIdentificacao string Linha digitável do pagamento - Sim
valor double Valor do pagamento, deverá ser maior que ZERO. Exemplo: 99.99 - Sim
efetuarEm dateTime Data em que o pagamento deve ser efetuado - Sim
vencimentoEm dateTime Data em que o pagamento irá vencer - Não

EfetuarPagamentoResponse

bs2.pj.banking.pagamentos.EfetuarPagamentoResponse

Resposta para solicitação de pagamento

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid) Identificador da solicitação - Não
executada boolean Solicitação executada ou não - Não
mensagem string Mensagem de retorno da solicitação - Não

BancoPagamento

bs2.pj.banking.pagamentos.BancoPagamento

Dto de banco do pagamento

Nome Tipo Descrição Tamanho Requerido
codigo integer Código do banco - Não
nome string Nome do banco - Não

BeneficiarioPagamento

bs2.pj.banking.pagamentos.BeneficiarioPagamento

Dto de beneficiário do pagamento

Nome Tipo Descrição Tamanho Requerido
nome string Nome do beneficiário - Não
documento string Documento do beneficiário - Não

Valores

bs2.pj.banking.pagamentos.Valores

Dto de valores de pagamento

Nome Tipo Descrição Tamanho Requerido
boleto double Valor de boleto - Não
cobrado double Valor cobrado - Não
descontos double Valor de descontos - Não
documento double Valor do documento - Não
mora double Valor da mora - Não
outrasDeducoes double Valor de outras deduções - Não
outrosAcrescimos double Valor de outros acréscimos - Não

ObterPagamentoResponse

bs2.pj.banking.pagamentos.ObterPagamentoResponse

Resposta de Obter Pagamento

Nome Tipo Descrição Tamanho Requerido
dataPagamento dateTime Data do pagamento - Não
dataVencimento dateTime Data do vencimento - Não
banco bs2.pj.banking.pagamentos.BancoPagamento   - Não
beneficiario bs2.pj.banking.pagamentos.BeneficiarioPagamento   - Não
valores bs2.pj.banking.pagamentos.Valores   - Não
descricaoPagamento string Descrição do pagamento - Não
nomePagador string Nome do pagador - Não
codigoBarras string Código de barras - Não
linhaDigitavel string Linha digitável - Não
cedente string Cedente do pagamento - Não

StatusSolicitacaoPagamento

bs2.pJ.apiBanking.integrations.internetBanking.pagamentos.StatusSolicitacaoPagamento

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.apiBanking.integrations.internetBanking.pagamentos.StatusSolicitacaoPagamento integer   -  

ObterStatusSolicitacaoPagamentoPorIdResponse

bs2.pj.banking.pagamentos.ObterStatusSolicitacaoPagamentoPorIdResponse

Nome Tipo Descrição Tamanho Requerido
id string (uuid) Descrição do status - Não
situacao string Descrição do status - Não
status enum 1-Cancelado, 2-CanceladoAutomaticamente, 3-Agendado, 4-Processando, 5-Concluido, 6-AguardandoAprovacao, 7-Reprovado, 8-Falha - Não

Banco

bs2.pj.compartilhados.Banco

Nome Tipo Descrição Tamanho Requerido
codigo integer Codigo do banco da conta de destino, deverá ser maior que ZERO. - Sim
nome string Nome do banco da conta de destino. 30 Não

TipoContaBancaria

bs2.pj.compartilhados.TipoContaBancaria

Nome Tipo Descrição Tamanho Requerido
bs2.pj.compartilhados.TipoContaBancaria integer   -  

ContaDestino

bs2.pj.compartilhados.ContaDestino

Nome Tipo Descrição Tamanho Requerido
agencia string Agência da conta de destino. Exemplo: 0000 (4 dígitos) 15 Sim
numero string Número da conta de destino. Exemplo: 0000000000000 (13 dígitos, no máximo) 13 Sim
banco bs2.pj.compartilhados.Banco   - Não
tipoConta enum 1-Pagamento, 2-Corrente, 3-Poupanca - Não

Favorecido

bs2.pj.compartilhados.Favorecido

Dtp de Favorecido

Nome Tipo Descrição Tamanho Requerido
nome string Nome do favorecido. 60 Sim
documento string Cpf/Cnpj do favorecido. 14 Sim
contaDestino bs2.pj.compartilhados.ContaDestino   - Não

EfetuarTransferenciaRequest

bs2.pj.transferencias.EfetuarTransferenciaRequest

Requisição de transferência

Nome Tipo Descrição Tamanho Requerido
favorecido bs2.pj.compartilhados.Favorecido   - Não
mesmaTitularidade boolean Determina se a transferencia será realizada para a mesma titularidade (CPNJ/CPF) ou para uma diferente. - Não
valor double Valor da ted, deverá ser maior que ZERO. Exemplo: 99.99 - Sim
efetuarEm dateTime Data em que a transferência será efetuada - Não

EfetuarTransferenciaResponse

bs2.pj.transferencias.EfetuarTransferenciaResponse

Resposta de solicitação de transferência

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid) Identificador da solicitação - Não
executada boolean Sinaliza se a transferência foi executada ou não - Não
mensagem string Mensagem de retorno - Não

StatusSolicitacaoTransferencia

bs2.pJ.apiBanking.integrations.internetBanking.transferencias.StatusSolicitacaoTransferencia

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.apiBanking.integrations.internetBanking.transferencias.StatusSolicitacaoTransferencia integer   -  

ObterStatusSolicitacaoTransferenciaPorIdResponse

bs2.pj.transferencias.ObterStatusSolicitacaoTransferenciaPorIdResponse

Resposta de solicitação de transferência

Nome Tipo Descrição Tamanho Requerido
id string (uuid) Identificador da solicitação - Não
situacao string Descrição do status - Não
status enum 1-Cancelado, 2-CanceladoAutomaticamente, 3-Agendado, 4-Processando, 5-Concluido, 6-AguardandoAprovacao, 7-Reprovado, 8-Falha - Não

BancoTransferencia

bs2.pj.transferencias.BancoTransferencia

Dto de banco da transferência

Nome Tipo Descrição Tamanho Requerido
codigo integer Código do banco - Não
nome string Nome do banco - Não

ContaDestinoTransferencia

bs2.pj.transferencias.ContaDestinoTransferencia

Dto de conta de destino

Nome Tipo Descrição Tamanho Requerido
banco bs2.pj.transferencias.BancoTransferencia   - Não
agencia string Número de agência - Não
numero string Número de conta - Não

FavorecidoTransferencia

bs2.pj.transferencias.FavorecidoTransferencia

Dto de favorecido de transferência

Nome Tipo Descrição Tamanho Requerido
nome string Nome do favorecido - Não
documento string Documento do favorecido - Não
contaDestino bs2.pj.transferencias.ContaDestinoTransferencia   - Não

ObterTransferenciaPorIdResponse

bs2.pj.transferencias.ObterTransferenciaPorIdResponse

Resposta de Obter Transferência

Nome Tipo Descrição Tamanho Requerido
id string (uuid) Identificador da transferência - Não
contaOrigem integer Número da conta de origem - Não
valor double Valor da transferência - Não
codigoFinalidade integer Código de finalidade - Não
dataTransacao dateTime Data da transação - Não
favorecido bs2.pj.transferencias.FavorecidoTransferencia   - Não

Precisa de mais informações?

Se você ainda tem dúvidas, entre em contato conosco, estamos prontos para atende-lo:

empresas@bs2.com