Geral - bs2.pj.pix.forintegration.direto - Versão: 1

Geral

Autenticação

Gerenciamento de Token

É necessário fazer a gestão do token de acesso da sua aplicação.

Gerar um token utilizando ClientId e ClientSecret. Fluxo de geração de token descrito no passo abaixo. O token possui uma validade em segundos, apresentada no campo expires_in. 420 segundos em Sandbox e 300 segundos em Produção.

Pontos Importantes

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

Quando o token estiver próximo da validade, deve-se gerar um novo token, para assim, receber um novo token valido 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.

Token de Autenticação

Para usar a API é necessário obter o token de autenticação. Para e emissão do token de acesso reproduza os seguintes passos:

1.1 Realizar uma requisição Basic Auth no endpoint abaixo

1.2 Definir o valor client_credentials para o campo grant_type

1.3 Definir o valor desejado de acesso para o campo scope [Vide tabela Permissões abaixo]

1.4 Inserir ​​​​​​​clientId e ​​​​​​​clientSecret válidos no campo Authorization do Header

Permissões

Scope Descrição
cob.write Permissão para alteração de cobranças
cob.read Permissão para consulta de cobranças
pix.write Permissão para alteração de Pix
pix.read Permissão para consulta de Pix
webhook.read Permissão para consulta do webhook
webhook.write Permissão para alteração do webhook
{
  "grant_type": "client_credentials",
  "scope": "cob.write cob.read pix.write pix.read webhook.read webhook.write"
}
{
  "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": "client_credentials"
}

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
Authorization header Inserir um ​​​​​​​clientId e ​​​​​​​clientSecret previamente cadastrado no banco BS2 Sim

Resposta

Código Descrição
200 Success
400 Bad Request
401 Unauthorized
  SandBox Produção
Requisições Solicitar URL ao time BS2 https://api.bs2.com:8443/auth/oauth/v2/token

Token de Atualização

Após a geração de um token de autenticação é recomendável que o gerenciamento do seu tempo de expiração seja feita pelo fluxo de atualização de token conforme os seguintes passos:

1.1 Realizar uma requisição Basic Auth no endpoint abaixo

1.2 Definir o valor refresh_token para o campo grant_type

1.3 Definir o valor desejado de acesso para o campo scope [Vide tabela Permissões acima]

1.4 Definir o valor do refresh token recebido previamente para o campo refresh_token

{
  "grant_type": "refresh_token",
  "scope": "cob.write cob.read pix.write pix.read webhook.read webhook.write",
  "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": "apibanking"
}

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

Webhook - Cliente

Webhook Pix Reivindicação

O Banco BS2 disponibiliza um webhook para notificar os clientes em tempo real sobre os eventos que possam ocorrer em suas transações Pix. Para utilizar o webhook, configure-o nos endpoints disponiveis, a documentação para tal se encontra no menu Webhook.

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

Para cada evento que ocorra, um webhook é disparado com a devida informação. Abaixo segue o contrato que será enviado a cada requisição com os dados de cada evento.

{
    "Identificador":"0675fda6-89ae-47b5-9616-c192a6b1fe5a",
    "Tipo": "POSSE",
    "Status": "CONFIRMADO",
    "DataFinalResolucao": "2020-01-01 00:00:00",
    "DataFinalEncerramento": "2020-01-01 00:00:00",
    "Chave": {
        "Valor": "12345678910",
        "Tipo": "CPF"
    },
    "Doador": {
        "Pessoa": {
            "Nome": "Fulano Ciclano",
            "NomeFantasia": "FULANO NOME FANTASIA",
            "Documento": "12345678901",
            "DocumentoTipo": "CPF",
            "Apelido": "APELIDO FULANO"
        },
        "Conta":{
            "Agencia": "0001",
            "Numero": "1234567890",
            "Tipo": "CC"
        }
    },
    "Reivindicador": {
        "Pessoa": {
            "Nome": "Fulano Ciclano",
            "NomeFantasia": "FULANO NOME FANTASIA",
            "Documento": "12345678901",
            "DocumentoTipo": "CPF",
            "Apelido": "APELIDO FULANO"
        },
        "Conta":{
            "Agencia": "0001",
            "Numero": "1234567890",
            "Tipo": "CC"
        }
    }
}

Descrição dos campos

Abaixo segue tabela descritiva dos campos enviados na notificação. Importante se atentar que o identificador deve ser ser utilizado para a busca. O objetivo do webhook é ser apenas uma “campainha”, o detalhamento precisa ser buscado nos endpoints de consulta.

Campo Descrição
Identificador Identificador da reivindicação.
Tipo Tipo da reivindicação, podendo ser “POSSE” ou “PORTABILIDADE”.
Status Status da reivindicação, podendo ser entre ABERTO, AGUARDANDO_RESOLUCAO, CONFIRMADO, CANCELADO, COMPLETO.
DataFinalResolucao Data-hora quando termina o período de resolução.
DataFinalEncerramento Data-hora quando termina o período de encerramento. Apenas para reivindicação de posse.
Chave Dados da chave. [Vide tabela Chave abaixo]
Doador Dados do doador da chave. [Vide tabela Doador/Reivindicador abaixo]
Reivindicador Dados do reivindicador da chave. [Vide tabela Doador/Reivindicador abaixo]

Descrição dos campos do modelo Chave

Abaixo segue a tabela descritiva dos campos enviados no item Chave

Campo Descrição
Valor Valor da chave renvindicada.
Tipo Tipo da chave, podendo ser entre CPF, CNPJ, PHONE, EMAIL, EVP.

Descrição dos campos do modelo Doador/Reivindicador

Abaixo segue a tabela descritiva dos campos enviados no item Doador/Reivindicador

Campo Descrição
Pessoa Dados da pessoa. [Vide tabela Pessoa abaixo]
Conta Dados da conta. [Vide tabela Conta abaixo]

Descrição dos campos do modelo Pessoa

Abaixo segue a tabela descritiva dos campos enviados no item Pessoa

Campo Descrição
Nome Nome do cliente ou razão social da empresa.
NomeFantasia Nome fantasia do cliente (obrigatório caso seja PJ).
Documento Valor do CPF/CNPJ do cliente (somente números)
DocumentoTipo Tipo do documento do cliente, podendo ser CPF ou CNPJ
Apelido Apelido do cliente, nome o qual ele irá ser notificado

Descrição dos campos do modelo Conta

Abaixo segue a tabela descritiva dos campos enviados no item Conta

Campo Descrição
Agencia Agência do cliente, sem dígito.
Numero Conta do cliente, com dígito.
Tipo Tipo da conta do cliente, podendo ser, CC (Corrente), SL (Salário), PP (Poupança).

Webhook Pix Transacional

O Banco BS2 disponibiliza um webhook para notificar os clientes em tempo real sobre os eventos que possam ocorrer em suas transações Pix. Para utilizar o webhook, configure-o nos endpoints disponiveis, a documentação para tal se encontra no menu Webhook.

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

Para cada evento que ocorra, um webhook é disparado com a devida informação. Abaixo segue o contrato que será enviado a cada requisição com os dados de cada evento.

{
    "pix": 
    [
        {
        "endToEndId":"string",
        "txid":"string",
        "valor":"string",
        "horario":"string date-time",
        "pagador":{
            "cpf|cnpj":"string",
            "nome":"string"
        },
        "infoPagador":"string",
        "devolucoes":[
            {
                "id":"string",
                "rtrId":"string",
                "valor":"string",
                "horario":{
                    "solicitacao":"string date-time",
                    "liquidacao":"string date-time"
                },
                "status":"EM_PROCESSAMENTO"
            }
        ]
        }
    ]
}

Descrição dos campos

Abaixo segue tabela descritiva dos campos enviados na notificação. Importante se atentar que o identificador deve ser ser utilizado para a busca. O objetivo do webhook é ser apenas uma “campainha”, o detalhamento precisa ser buscado nos endpoints de consulta.

Campo Descrição
pix Array com os pix recebidos. [Vide tabela Pix abaixo]

Descrição dos campos do modelo Pix

Abaixo segue a tabela descritiva dos campos enviados no item Pix

Campo Descrição
endToEndId EndToEndIdentification que transita na PACS002, PACS004 e PACS008.
txid Identificador da transação.
valor Valor do recebimento.
horario Data-hora quando foi efetuado.
pagador Dados do pagador. [Vide tabela Pagador abaixo]
infoPagador Campo livre do pagador.
devolucoes Array com as devoluções. [Vide tabela Devolução abaixo]

Descrição dos campos do modelo Pagador

Abaixo segue a tabela descritiva dos campos enviados no item Pagador

Campo Descrição
cpf CPF do usuário pagador.
nome Nome do usuário pagador.

Descrição dos campos do modelo Devolução

Abaixo segue a tabela descritiva dos campos enviados no item Devolução

Campo Descrição
id Id gerado pelo cliente para representar unicamente uma devolução.
rtrId ReturnIdentification que transita na PACS004.
valor Valor devolvido.
horario Dados do horario. [Vide tabela Horario abaixo ]
status Status da devolução, podendo ser, “EM_PROCESSAMENTO” “DEVOLVIDO” “NAO_REALIZADO”

Descrição dos campos do modelo Horario

Abaixo segue a tabela descritiva dos campos enviados no item Horario

| Campo | Descrição | | — | — | | solicitacao | Data-hora quando foi solicitada a devolução no PSP. | | liquidacao | Data-hora quando foi liquidada a devolução no PSP. |

Webhook - Configurar

Webhook - Configurar


{
 "webhookUrl": "string"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.empresas.webhook.inscricao.configurar.InscricaoParaConfigurar

Resposta

Código Descrição Schema
201 Inscrição configurada com sucesso  
400 Ocorreu um erro ao tentar configurar inscrição. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Webhook - Excluir

Webhook - Excluir


--curl
"DELETE": "/pix/direto/forintegration/v1/webhook"

Parâmetros

Não existe parâmetros!

Resposta

Código Descrição Schema
204 Inscrição excluída com sucesso.  
400 Ocorreu um erro ao tentar excluir a inscrição. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Webhook - Consultar

Webhook - Consultar


--curl
"GET": "/pix/direto/forintegration/v1/webhook"

{
 "webhookUrl": "string"
}

Parâmetros

Não existe parâmetros!

Resposta

Código Descrição Schema
200 Inscrição obtida com sucesso. bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.empresas.webhook.inscricao.obterInscricao.InscricaoEncontrada
400 Ocorreu um erro ao tentar obter a inscrição. [ bs2.pJ.empresas.http.responseResult.DetalheBadRequest ]

Webhook - Incluir certificado

Webhook - Incluir certificado em inscrição para notificações de pix recebidos


--curl
"PUT": "/pix/direto/forintegration/v1/webhook/certificado"

Parâmetros

Não existe parâmetros!

Resposta

Código Descrição Schema
204 Certificado incluído com sucesso  
400 Ocorreu um erro ao tentar incluir certificado. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

DICT - Cliente

Chave - Criar

Chave - Criar


{
 "valor": "string",
 "tipo": [CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA],
 "apelido": "string"
}

{
 "chaveId": "string"
}

Descrição:

Independente do tipo de vínculo chave, contas PF podem possuir no máximo 5 chaves, já PJ no máximo 20.

Chave tipo CPF/CNPJ somente poderão ser registradas para o próprio documento cadastrado na conta.

Chave tipo PHONE deve iniciar com o caractere “+”, seguido de dois dígitos de código do país (55 para Brasil), dois dígitos de DDD, nove dígitos do celular

Chave tipo EMAIL deve possuir apenas caracteres minúsculos, um caractere “@”, e após ele, no mínimo um “.”

Chave tipo EVP é gerada pelo DICT, qualquer valor de chave inserido será desconsiderado

Endpoint idempotente

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.dict.criarChave.ChaveParaCriar

Resposta

Código Descrição Schema
201 Chave criada com sucesso bs2.pj.dict.criarChave.ChaveCriada
202 Chave já cadastrada, deve-se sugerir uma reivindicação bs2.pj.dict.criarChave.Reivindicacao
400   [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Chave - Excluir

Chave - Excluir


--curl
"DELETE": "/pix/direto/forintegration/v1/chaves/{chaveId}"

Parâmetros

Nome Localizado em Descrição Requerido Schema
chaveId path Identificador da chave. Sim string (uuid)

Resposta

Código Descrição Schema
204 Chave excluída com sucesso.  
400 Ocorreu um erro ao tentar excluir a chave. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Chave - Consultar

Chave - consultar


--curl
"GET": "/pix/direto/forintegration/v1/chaves"

{
 "items": [
   {
    "id": "string",
    "valor": "string",
    "tipo": [CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA],
    "dataCriacao": "2021-2-2T22:11:58.850Z",
    "contaBancaria": {
     "id": "string",
     "agencia": 0,
     "numero": 0,
     "tipo": 0
    },
    "apelido": "string",
    "solicitante": "string",
    "sistemaOrigem": "string"
   }
 ]
}

Parâmetros

Não existe parâmetros!

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pJ.pix.apis.queries.compartilhados.ChavesEncontradas
204 Consulta realizada com sucesso, porém sem resultados.  
400 Ocorreu um erro ao tentar consultar a reivindicação. [ bs2.pJ.empresas.http.responseResult.DetalheBadRequest ]

Reivindicação - Iniciar

Reivindicações - iniciar


{
 "tipo": [posse, portabilidade],
 "chave": {
  "valor": "string",
  "tipo": [CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA]
 }
}

{
 "reivindicacaoId": "string"
}

Descrição:

Operações do tipo POSSE é válida apenas para chaves do tipo EMAIL e PHONE.

Operações do tipo PORTABILIDADE é válida para chaves do tipo CPF, CNPJ, PHONE e EMAIL

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.dict.reivindicacoes.solicitar.ReivindicacaoParaSolicitar

Resposta

Código Descrição Schema
201 Reivindicação solicitada com sucesso. bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.dict.reivindicacoes.solicitar.ReivindicacaoCriada
400 Ocorreu um erro ao tentar solicitar a reivindicação. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Reivindicação - Confirmar

Reivindicações - confirmar


{
 "reivindicador": {
  "reivindicacoes": "array"
 },
 "doador": {
  "reivindicacoes": "array"
 }
}

{
 "reivindicador": {
  "reivindicacoes": [
    {
     "solicitacaoId": "string",
     "aprovada": false,
     "mensagem": "string"
    }
  ]
 },
 "doador": {
  "reivindicacoes": [
    {
     "solicitacaoId": "string",
     "aprovada": false,
     "mensagem": "string"
    }
  ]
 }
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pJ.pix.apis.commands.compartilhados.ReivindicacoesParaProcessar

Resposta

Código Descrição Schema
200 Reivindicação confirmada com sucesso. bs2.pJ.pix.apis.commands.compartilhados.ReivindicacoesProcessadas
400 Ocorreu um erro ao tentar confirmar a reivindicação. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Reivindicação - Cancelar

Reivindicações - cancelar


{
 "reivindicador": {
  "reivindicacoes": "array"
 },
 "doador": {
  "reivindicacoes": "array"
 }
}

{
 "reivindicador": {
  "reivindicacoes": [
    {
     "solicitacaoId": "string",
     "aprovada": false,
     "mensagem": "string"
    }
  ]
 },
 "doador": {
  "reivindicacoes": [
    {
     "solicitacaoId": "string",
     "aprovada": false,
     "mensagem": "string"
    }
  ]
 }
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pJ.pix.apis.commands.compartilhados.ReivindicacoesParaProcessar

Resposta

Código Descrição Schema
200 Reivindicação cancelada com sucesso. bs2.pJ.pix.apis.commands.compartilhados.ReivindicacoesProcessadas
400 Ocorreu um erro ao tentar cancelar a reivindicação. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Reivindicação - Consultar

Reivindicações - consultar


--curl
"GET": "/pix/direto/forintegration/v1/chaves/reivindicacoes/reivindicador"

{
 "items": [
   {
    "reivindicacaoId": "string",
    "tipo": [posse, portabilidade],
    "status": [ABERTO, AGUARDANDO_RESOLUCAO, CONFIRMADO, CANCELADO, COMPLETO],
    "dataFinalResolucao": "2021-2-2T22:11:58.851Z",
    "dataFinalEncerramento": "2021-2-2T22:11:58.851Z",
    "dataUltimaAtualizacao": "2021-2-2T22:11:58.851Z",
    "reivindicador": {
     "conta": {
      "banco": "string",
      "bancoNome": "string",
      "agencia": "string",
      "numero": "string",
      "tipo": [ContaCorrente, ContaSalario, Poupanca]
     },
     "pessoa": {
      "documento": "string",
      "tipoDocumento": [CPF, CNPJ],
      "nome": "string",
      "nomeFantasia": "string"
     }
    },
    "chave": {
     "id": "string",
     "valor": "string",
     "tipo": [CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA],
     "apelido": "string"
    }
   }
 ],
 "pagina": {
  "qtd": 0,
  "paginaAtual": 0,
  "itensPorPagina": 0
 }
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
PaginaAtual query   Não integer
ItensPorPagina query   Não integer

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.dict.reivindicacao.obterReivindicacoesReivindicador.PaginaReivindicacoesReivindicadorEncontradas
204 Consulta realizada com sucesso, porém sem resultados.  
400 Ocorreu um erro ao tentar consultar a reivindicação. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Reivindicação - Consultar doações

Reivindicações - consultar doações


--curl
"GET": "/pix/direto/forintegration/v1/chaves/reivindicacoes/doador"

{
 "items": [
   {
    "reivindicacaoId": "string",
    "tipo": [posse, portabilidade],
    "status": [ABERTO, AGUARDANDO_RESOLUCAO, CONFIRMADO, CANCELADO, COMPLETO],
    "dataFinalResolucao": "2021-2-2T22:11:58.851Z",
    "dataFinalEncerramento": "2021-2-2T22:11:58.851Z",
    "dataUltimaAtualizacao": "2021-2-2T22:11:58.851Z",
    "reivindicador": {
     "conta": {
      "banco": "string",
      "bancoNome": "string",
      "agencia": "string",
      "numero": "string",
      "tipo": [ContaCorrente, ContaSalario, Poupanca]
     },
     "pessoa": {
      "documento": "string",
      "tipoDocumento": [CPF, CNPJ],
      "nome": "string",
      "nomeFantasia": "string"
     }
    },
    "doador": {
     "conta": {
      "banco": "string",
      "bancoNome": "string",
      "agencia": "string",
      "numero": "string",
      "tipo": [ContaCorrente, ContaSalario, Poupanca]
     },
     "pessoa": {
      "documento": "string",
      "tipoDocumento": [CPF, CNPJ],
      "nome": "string",
      "nomeFantasia": "string"
     }
    },
    "chave": {
     "id": "string",
     "valor": "string",
     "tipo": [CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA],
     "apelido": "string"
    }
   }
 ],
 "pagina": {
  "qtd": 0,
  "paginaAtual": 0,
  "itensPorPagina": 0
 }
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
PaginaAtual query   Não integer
ItensPorPagina query   Não integer

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.dict.reivindicacao.obterReivindicacoesDoador.PaginaReivindicacoesDoadorEncontradas
204 Consulta realizada com sucesso, porém sem resultados.  
400 Ocorreu um erro ao tentar consultar a reivindicação. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Pagamentos - Cliente

Pagamento - Iniciar pagamento por QR Code

Pagamento - Iniciar pagamento por QR Code


{
 "qrCode": "string"
}

{
 "pagamentoId": "string",
 "endToEndId": "string",
 "pagador": {
  "ispb": "string",
  "conta": {
   "banco": "string",
   "bancoNome": "string",
   "agencia": "string",
   "numero": "string",
   "tipo": [ContaCorrente, ContaSalario, Poupanca]
  },
  "pessoa": {
   "documento": "string",
   "tipoDocumento": [CPF, CNPJ],
   "nome": "string",
   "nomeFantasia": "string"
  }
 },
 "recebedor": {
  "ispb": "string",
  "conta": {
   "banco": "string",
   "bancoNome": "string",
   "agencia": "string",
   "numero": "string",
   "tipo": [ContaCorrente, ContaSalario, Poupanca]
  },
  "pessoa": {
   "documento": "string",
   "tipoDocumento": [CPF, CNPJ],
   "nome": "string",
   "nomeFantasia": "string"
  }
 },
 "valor": 0,
 "tipo": [estatico, dinamico],
 "campoLivre": "string",
 "cobranca": {
  "id": "string",
  "calendario": {
   "criacao": "2021-2-2T22:11:58.866Z",
   "apresentacao": "2021-2-2T22:11:58.866Z",
   "expiracao": 0,
   "vencimento": "2021-2-2T22:11:58.866Z",
   "recebivelAposVencimento": false
  },
  "documento": {
   "revisao": 0,
   "versao": 0
  },
  "pagador": {
   "nome": "string",
   "cpf": "string",
   "cnpj": "string"
  },
  "valor": {
   "original": 0,
   "final": 0,
   "juros": 0,
   "multa": 0,
   "desconto": 0,
   "permiteAlteracao": false
  },
  "chave": {
   "valor": "string",
   "tipo": [CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA]
  },
  "solicitacao": "string",
  "infoAdicionais": [
    {
     "nome": "string",
     "valor": "string"
    }
  ]
 },
 "txId": "string"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.iniciarPagamentoPorQrCode.PagamentoParaIniciar

Resposta

Código Descrição Schema
201 Iniciação realizada com sucesso. bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.iniciarPagamentoPorQrCode.PagamentoIniciado
400 Ocorreu um erro ao tentar iniciar um pagamento. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Pagamento - Iniciar pagamento por chave

Pagamento - Iniciar pagamento por chave


{
 "chave": {
  "id": "string",
  "valor": "string",
  "tipo": [CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA],
  "apelido": "string"
 }
}

{
 "pagamentoId": "string",
 "endToEndId": "string",
 "recebedor": {
  "ispb": "string",
  "conta": {
   "banco": "string",
   "bancoNome": "string",
   "agencia": "string",
   "numero": "string",
   "tipo": [ContaCorrente, ContaSalario, Poupanca]
  },
  "pessoa": {
   "documento": "string",
   "tipoDocumento": [CPF, CNPJ],
   "nome": "string",
   "nomeFantasia": "string"
  }
 },
 "pagador": {
  "ispb": "string",
  "conta": {
   "banco": "string",
   "bancoNome": "string",
   "agencia": "string",
   "numero": "string",
   "tipo": [ContaCorrente, ContaSalario, Poupanca]
  },
  "pessoa": {
   "documento": "string",
   "tipoDocumento": [CPF, CNPJ],
   "nome": "string",
   "nomeFantasia": "string"
  }
 }
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.iniciarPagamentoPorChave.PagamentoParaIniciar

Resposta

Código Descrição Schema
201 Iniciação realizada com sucesso. bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.iniciarPagamentoPorChave.PagamentoIniciado
400 Ocorreu um erro ao tentar iniciar um pagamento. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Pagamento - Iniciar pagamento por manual

Pagamento - Iniciar pagamento por manual


{
 "recebedor": {
  "ispb": "string",
  "conta": {
   "agencia": 0,
   "numero": 0,
   "tipo": [ContaCorrente, ContaSalario, Poupanca]
  },
  "pessoa": {
   "documento": "string",
   "tipoDocumento": [CPF, CNPJ],
   "nome": "string",
   "nomeFantasia": "string"
  }
 }
}

{
 "pagamentoId": "string",
 "endToEndId": "string",
 "recebedor": {
  "ispb": "string",
  "conta": {
   "banco": "string",
   "bancoNome": "string",
   "agencia": "string",
   "numero": "string",
   "tipo": [ContaCorrente, ContaSalario, Poupanca]
  },
  "pessoa": {
   "documento": "string",
   "tipoDocumento": [CPF, CNPJ],
   "nome": "string",
   "nomeFantasia": "string"
  }
 },
 "pagador": {
  "ispb": "string",
  "conta": {
   "banco": "string",
   "bancoNome": "string",
   "agencia": "string",
   "numero": "string",
   "tipo": [ContaCorrente, ContaSalario, Poupanca]
  },
  "pessoa": {
   "documento": "string",
   "tipoDocumento": [CPF, CNPJ],
   "nome": "string",
   "nomeFantasia": "string"
  }
 }
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.iniciarPagamentoManual.PagamentoParaIniciar

Resposta

Código Descrição Schema
201 Iniciação realizada com sucesso. bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.iniciarPagamentoManual.PagamentoIniciado
400 Ocorreu um erro ao tentar iniciar um pagamento. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Pagamento - Confirmar

Pagamento - Confirmar


{
 "recebedor": {
  "ispb": "string",
  "conta": {
   "agencia": 0,
   "numero": 0,
   "tipo": [ContaCorrente, ContaSalario, Poupanca]
  },
  "pessoa": {
   "documento": "string",
   "tipoDocumento": [CPF, CNPJ],
   "nome": "string",
   "nomeFantasia": "string"
  }
 },
 "valor": 0,
 "campoLivre": "string"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.confirmarPagamento.PagamentoParaConfirmar
pagamentoId path Identificador do pagamento. Sim string (uuid)

Resposta

Código Descrição Schema
202 O pagamento foi confirmado com sucesso e o valor já foi bloqueado na conta do cliente pagador.  
400 Ocorreu um erro ao tentar confirmar um pagamento. [ bs2.pJ.empresas.http.responseResult.DetalheBadRequest ]

Pagamento - Consultar

Pagamento - Consultar


--curl
"GET": "/pix/direto/forintegration/v1/pagamentos"

{
 "items": [
   {
    "pagamentoId": "string",
    "endToEndId": "string",
    "dataHoraCriacao": "2021-2-2T22:11:58.866Z",
    "pagador": {
     "ispb": "string",
     "conta": {
      "banco": "string",
      "bancoNome": "string",
      "agencia": "string",
      "numero": "string",
      "tipo": [ContaCorrente, ContaSalario, Poupanca]
     },
     "pessoa": {
      "documento": "string",
      "tipoDocumento": [CPF, CNPJ],
      "nome": "string",
      "nomeFantasia": "string"
     }
    },
    "recebedor": {
     "ispb": "string",
     "conta": {
      "banco": "string",
      "bancoNome": "string",
      "agencia": "string",
      "numero": "string",
      "tipo": [ContaCorrente, ContaSalario, Poupanca]
     },
     "pessoa": {
      "documento": "string",
      "tipoDocumento": [CPF, CNPJ],
      "nome": "string",
      "nomeFantasia": "string"
     }
    },
    "informacoesEntreUsuarios": "string",
    "status": [INICIADO, CONFIRMADO, EFETIVADO, REJEITADO, ERRO, EXPIRADO],
    "valor": 0
   }
 ],
 "pagina": {
  "qtd": 0,
  "paginaAtual": 0,
  "itensPorPagina": 0
 }
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
Inicio query Filtra os registros cuja data de criação seja maior ou igual a data de início. Sim dateTime
Fim query Filtra os registros cuja data de criação seja menor ou igual a data de fim. Sim dateTime
Status query Filtra os registros cujo o Status seja igual. Não bs2.pJ.pix.compartilhados.enums.StatusPagamento
Tipo query Filtra os registros cujo o Tipo seja igual. Não bs2.pJ.pix.compartilhados.enums.TipoPagamento
Paginacao.PaginaAtual query   Não integer
Paginacao.ItensPorPagina query   Não integer

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pJ.pix.apis.queries.forIntegration.direto.pagamentos.obterPagamentos.PaginaPagamentoEncontrado
204 Consulta realizada com sucesso, porém sem resultados.  
400 Ocorreu um erro ao tentar consultar os pagamentos. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Pagamento - Consultar por PagamentoId

Pagamento - Consultar por PagamentoId


--curl
"GET": "/pix/direto/forintegration/v1/pagamentos/{pagamentoId}"

{
 "endToEndId": "string",
 "qrCode": {
  "categoria": 0,
  "moeda": 0,
  "pais": "string",
  "cidade": "string",
  "txId": "string"
 },
 "cobranca": {
  "id": "string",
  "calendario": {
   "criacao": "2021-2-2T22:11:58.867Z",
   "apresentacao": "2021-2-2T22:11:58.867Z",
   "expiracao": 0,
   "vencimento": "2021-2-2T22:11:58.867Z",
   "recebivelAposVencimento": false
  },
  "documento": {
   "revisao": 0,
   "versao": 0
  },
  "pagador": {
   "nome": "string",
   "cpf": "string",
   "cnpj": "string"
  },
  "valor": {
   "original": 0,
   "final": 0,
   "juros": 0,
   "multa": 0,
   "desconto": 0,
   "permiteAlteracao": false
  },
  "chave": {
   "valor": "string",
   "tipo": [CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA]
  },
  "solicitacao": "string",
  "infoAdicionais": [
    {
     "nome": "string",
     "valor": "string"
    }
  ]
 },
 "recebedor": {
  "ispb": "string",
  "conta": {
   "banco": "string",
   "bancoNome": "string",
   "agencia": "string",
   "numero": "string",
   "tipo": [ContaCorrente, ContaSalario, Poupanca]
  },
  "pessoa": {
   "documento": "string",
   "tipoDocumento": [CPF, CNPJ],
   "nome": "string",
   "nomeFantasia": "string"
  }
 }
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
pagamentoId path Identificador do pagamento. Sim string (uuid)

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pJ.pix.apis.queries.forIntegration.direto.pagamentos.obterPagamentoPorId.PagamentoEncontrado
204 Consulta realizada com sucesso, porém sem resultados.  
400 Ocorreu um erro ao tentar consultar os pagamentos. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Participantes - Consultar

Participante - consultar


--curl
"GET": "/pix/direto/forintegration/v1/participantes"

{
 "items": [
   {
    "ispb": "string",
    "bancoCodigo": "string",
    "nome": "string",
    "parceiro": false
   }
 ],
 "pagina": {
  "qtd": 0,
  "paginaAtual": 0,
  "itensPorPagina": 0
 }
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
parceiro query   Não boolean
PaginaAtual query   Não integer
ItensPorPagina query   Não integer

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.participantes.obterParticipantes.PaginaParticipantesEncontrados
204 Consulta realizada com sucesso, porém sem resultados.  
400 Ocorreu um erro ao tentar consultar os particapantes. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Recebimentos - Cliente

Cobrança estática - Criar

Cobrança estática - Criar


{
 "chave": "string",
 "valor": 0,
 "campoLivre": "string",
 "txId": "string"
}

{
 "txId": "string",
 "qrCode": "string",
 "dataCriacao": "2021-2-2T22:11:58.882Z"
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pj.recebimentos.criarRecebimentoPorQrCodeEstatico.RecebimentoParaCriar

Resposta

Código Descrição Schema
201 QR Code criado com sucesso. bs2.pj.recebimentos.criarRecebimentoPorQrCodeEstatico.RecebimentoCriado
400 Ocorreu um erro ao tentar criar o QR Code. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Cobrança dinâmica - Criar

Cobrança dinâmica - Criar


{
 "calendario": {
  "expiracao": 0
 },
 "devedor": {
  "cnpj": "string",
  "cpf": "string",
  "nome": "string"
 },
 "valor": {
  "original": 0
 },
 "chave": "string",
 "solicitacaoPagador": "string",
 "infoAdicionais": [
   {
    "nome": "string",
    "valor": "string"
   }
 ]
}

{
 "calendario": {
  "expiracao": 0,
  "criacao": "2021-2-2T22:11:58.882Z"
 },
 "status": [ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP],
 "txId": "string",
 "revisao": 0,
 "location": "string",
 "devedor": {
  "cnpj": "string",
  "cpf": "string",
  "nome": "string"
 },
 "valor": {
  "original": 0,
  "juros": 0,
  "multa": 0,
  "desconto": 0,
  "final": 0,
  "permiteAlteracao": false
 },
 "chave": "string",
 "solicitacaoPagador": "string",
 "infoAdicionais": [
   {
    "nome": "string",
    "valor": "string"
   }
 ]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pj.gerenciarCobrancas.criarCobranca.CobrancaRequest
txId path Identificador da transação Sim string

Resposta

Código Descrição Schema
201 Cobrança criada com sucesso. bs2.pj.gerenciarCobrancas.criarCobranca.CobrancaResponse
400 Ocorreu um erro ao tentar criar a cobrança. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Cobrança - Revisar

Cobrança - Revisar


{
 "calendario": {
  "expiracao": 0
 },
 "status": [ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP],
 "devedor": {
  "cnpj": "string",
  "cpf": "string",
  "nome": "string"
 },
 "valor": {
  "original": 0,
  "juros": 0,
  "multa": 0,
  "desconto": 0,
  "final": 0,
  "permiteAlteracao": false
 },
 "chave": "string",
 "solicitacaoPagador": "string",
 "informacoesAdicionais": [
   {
    "nome": "string",
    "valor": "string"
   }
 ]
}

{
 "calendario": {
  "expiracao": 0,
  "criacao": "2021-2-2T22:11:58.882Z"
 },
 "status": [ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP],
 "txId": "string",
 "revisao": 0,
 "location": "string",
 "devedor": {
  "cnpj": "string",
  "cpf": "string",
  "nome": "string"
 },
 "valor": {
  "original": 0,
  "juros": 0,
  "multa": 0,
  "desconto": 0,
  "final": 0,
  "permiteAlteracao": false
 },
 "chave": "string",
 "solicitacaoPagador": "string",
 "infoAdicionais": [
   {
    "nome": "string",
    "valor": "string"
   }
 ]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pj.gerenciarCobrancas.revisarCobranca.RevisarRequest
txId path Identificador da transação. Sim string

Resposta

Código Descrição Schema
200 Cobrança alterada com sucesso. bs2.pj.gerenciarCobrancas.revisarCobranca.RevisarResponse
400 Ocorreu um erro ao tentar criar a cobrança. [ bs2.pJ.empresas.http.responseResult.DetalheBadRequest ]

Cobrança - Consultar por TxId

Cobrança - Consultar por TxId


--curl
"GET": "/pix/direto/forintegration/v1/cob/{txId}"

{
 "calendario": {
  "expiracao": 0,
  "criacao": "2021-2-2T22:11:58.882Z"
 },
 "status": [ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP],
 "txId": "string",
 "revisao": 0,
 "location": "string",
 "devedor": {
  "cnpj": "string",
  "cpf": "string",
  "nome": "string"
 },
 "valor": {
  "original": 0
 },
 "chave": "string",
 "solicitacaoPagador": "string",
 "infoAdicionais": [
   {
    "nome": "string",
    "valor": "string"
   }
 ],
 "pix": [
   {
    "endToEndId": "string",
    "txId": "string",
    "valor": 0,
    "horario": "2021-2-2T22:11:58.882Z",
    "pagador": {
     "cpf": "string",
     "cnpj": "string",
     "nome": "string"
    },
    "infoPagador": "string",
    "devolucoes": [
      {
       "id": "string",
       "rtrId": "string",
       "valor": 0,
       "horario": {
        "solicitacao": "2021-2-2T22:11:58.882Z",
        "liquidacao": "2021-2-2T22:11:58.882Z"
       },
       "status": [EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO]
      }
    ]
   }
 ]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
txId path Identificador da transação. Sim string
revisao query Permite recuperar revisões anteriores de uma cobrança. Na ausência desse parâmetro, sempre será retornada a cobrança conforme consta em sua última revisão. Não integer

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pj.gerenciarCobrancas.consultarCobranca.ConsultarResponse
204 Consulta realizada com sucesso, porém sem resultados.  
400 Ocorreu um erro ao tentar consultar a cobrança. [ bs2.pJ.empresas.http.responseResult.DetalheBadRequest ]

Cobrança - Consultar

Cobrança - Consultar


--curl
"GET": "/pix/direto/forintegration/v1/cob"

{
 "parametros": {
  "inicio": "2021-2-2T22:11:58.883Z",
  "fim": "2021-2-2T22:11:58.883Z",
  "cpf": "string",
  "cnpj": "string",
  "status": [ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP],
  "paginacao": {
   "paginaAtual": 0,
   "itensPorPagina": 0,
   "quantidadeDePaginas": 0,
   "quantidadeTotalDeItens": 0
  }
 },
 "cobs": [
   {
    "calendario": {
     "expiracao": 0,
     "criacao": "2021-2-2T22:11:58.883Z"
    },
    "status": [ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP],
    "txId": "string",
    "revisao": "string",
    "location": "string",
    "devedor": {
     "cnpj": "string",
     "cpf": "string",
     "nome": "string"
    },
    "valor": {
     "original": 0
    },
    "chave": "string",
    "solicitacaoPagador": "string",
    "infoAdicionais": [
      {
       "nome": "string",
       "valor": "string"
      }
    ],
    "pix": [
      {
       "endToEndId": "string",
       "txId": "string",
       "valor": 0,
       "horario": "2021-2-2T22:11:58.883Z",
       "pagador": {
        "cpf": "string",
        "cnpj": "string",
        "nome": "string"
       },
       "infoPagador": "string",
       "devolucoes": [
         {
          "id": "string",
          "rtrId": "string",
          "valor": 0,
          "horario": {
           "solicitacao": "2021-2-2T22:11:58.883Z",
           "liquidacao": "2021-2-2T22:11:58.883Z"
          },
          "status": [EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO]
         }
       ]
      }
    ]
   }
 ]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
Inicio query Filtra os registros cuja data de criação seja maior ou igual a data de início. Sim dateTime
Fim query Filtra os registros cuja data de criação seja menor ou igual a data de fim. Sim dateTime
CPF query Filtro pelo CPF do pagador. Não pode ser utilizado ao mesmo tempo que o CNPJ. Não string
CNPJ query Filtro pelo CNPJ do pagador. Não pode ser utilizado ao mesmo tempo que o CPF. Não string
Status query Filtro pelo status da cobrança. Não bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.StatusCobranca
Paginacao.PaginaAtual query   Não integer
Paginacao.ItensPorPagina query   Não integer

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pj.gerenciarCobrancas.consultarListaCobranca.ListaCobrancaResponse
204 Consulta realizada com sucesso, porém sem resultados.  
400 Ocorreu um erro ao tentar consultar as cobranças. [ bs2.pJ.empresas.http.responseResult.DetalheBadRequest ]

Recebimento - Consultar

Recebimento - Consultar


--curl
"GET": "/pix/direto/forintegration/v1/recebimentos"

{
 "items": [
   {
    "endToEndId": "string",
    "recebimentoId": 0,
    "txId": "string",
    "data": "2021-2-2T22:11:58.883Z",
    "valor": 0,
    "status": [Efetivado, Rejeitado, Validade, Unknow],
    "pagador": {
     "ispb": "string",
     "conta": {
      "banco": "string",
      "bancoNome": "string",
      "agencia": "string",
      "numero": "string",
      "tipo": [ContaCorrente, ContaSalario, Poupanca]
     },
     "pessoa": {
      "documento": "string",
      "tipoDocumento": [CPF, CNPJ],
      "nome": "string",
      "nomeFantasia": "string"
     }
    },
    "recebedor": {
     "ispb": "string",
     "conta": {
      "banco": "string",
      "bancoNome": "string",
      "agencia": "string",
      "numero": "string",
      "tipo": [ContaCorrente, ContaSalario, Poupanca]
     },
     "pessoa": {
      "documento": "string",
      "tipoDocumento": [CPF, CNPJ],
      "nome": "string",
      "nomeFantasia": "string"
     }
    },
    "chaveDict": "string",
    "campoLivre": "string",
    "situacao": [ACCC, ACSC, ACSP, RJCT],
    "devolucoes": [
      {
       "id": "string",
       "rtrId": "string",
       "valor": 0,
       "horario": {
        "solicitacao": "2021-2-2T22:11:58.883Z",
        "liquidacao": "2021-2-2T22:11:58.883Z"
       },
       "status": [EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO],
       "motivo": "string"
      }
    ]
   }
 ],
 "pagina": {
  "qtd": 0,
  "paginaAtual": 0,
  "itensPorPagina": 0
 }
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
Inicio query Filtra os registros cuja data de criação seja maior ou igual a data de início. Sim dateTime
Fim query Filtra os registros cuja data de criação seja menor ou igual a data de fim. Sim dateTime
TxId query   Não string
Paginacao.PaginaAtual query   Não integer
Paginacao.ItensPorPagina query   Não integer

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pj.recebimentos.obterRecebimentos.PaginaRecebimentoEncontrados
204 Consulta realizada com sucesso, porém sem resultados.  
400 Ocorreu um erro ao tentar consultar a cobrança. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Recebimento - Consultar por RecebimentoId

Recebimento - Consultar por RecebimentoId


--curl
"GET": "/pix/direto/forintegration/v1/recebimentos/{recebimentoId}"

{
 "recebimentoId": 0,
 "txId": "string",
 "endToEndId": "string",
 "data": "2021-2-2T22:11:58.883Z",
 "valor": 0,
 "status": [Efetivado, Rejeitado, Validade, Unknow],
 "pagador": {
  "ispb": "string",
  "conta": {
   "banco": "string",
   "bancoNome": "string",
   "agencia": "string",
   "numero": "string",
   "tipo": [ContaCorrente, ContaSalario, Poupanca]
  },
  "pessoa": {
   "documento": "string",
   "tipoDocumento": [CPF, CNPJ],
   "nome": "string",
   "nomeFantasia": "string"
  }
 },
 "recebedor": {
  "ispb": "string",
  "conta": {
   "banco": "string",
   "bancoNome": "string",
   "agencia": "string",
   "numero": "string",
   "tipo": [ContaCorrente, ContaSalario, Poupanca]
  },
  "pessoa": {
   "documento": "string",
   "tipoDocumento": [CPF, CNPJ],
   "nome": "string",
   "nomeFantasia": "string"
  }
 },
 "chaveDict": "string",
 "campoLivre": "string",
 "situacao": [ACCC, ACSC, ACSP, RJCT],
 "devolucoes": [
   {
    "id": "string",
    "rtrId": "string",
    "valor": 0,
    "horario": {
     "solicitacao": "2021-2-2T22:11:58.883Z",
     "liquidacao": "2021-2-2T22:11:58.883Z"
    },
    "status": [EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO],
    "motivo": "string"
   }
 ]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
recebimentoId path Identificador de Recebimento. Sim long

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pj.recebimentos.obterRecebimentos.RecebimentoEncontrado
204 Consulta realizada com sucesso, porém sem resultado.  
400 Ocorreu um erro ao tentar consultar a cobrança. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Devoluções - Cliente

Devolução - Solicitar por e2eid e idExterno

Devolução - Solicitar por e2eid e idExterno


{
 "valor": 0
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
body body   Sim bs2.pj.pixRecebidos.solicitarDevolucao.DevolucaoRequest
e2eid path EndToEndIdentification que transita na PACS002, PACS004 e PACS008. Sim string
idExterno path Id gerado pelo cliente para representar unicamente uma devolução. Sim string

Resposta

Código Descrição Schema
202 Solicitação de devolução criada com sucesso. bs2.pj.pixRecebidos.solicitarDevolucao.SolicitarDevolucaoResponse
400 Ocorreu um erro ao tentar solicitar devolução. [ bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest ]

Devolução - Consultar por e2eid e idExterno

Devolução - Consultar por e2eid e idExterno


--curl
"GET": "/pix/direto/forintegration/v1/pix/{e2eid}/devolucao/{idExterno}"

{
 "id": "string",
 "rtrId": "string",
 "valor": 0,
 "horario": {
  "solicitacao": "2021-2-2T22:11:58.904Z",
  "liquidacao": "2021-2-2T22:11:58.904Z"
 },
 "status": [EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
e2eid path EndToEndIdentification que transita na PACS002, PACS004 e PACS008. Sim string
idExterno path Id gerado pelo cliente para representar unicamente uma devolução. Sim string

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pj.pixRecebidos.consultarDevolucao.ConsultarDevolucaoResponse
204 Consulta realizada com sucesso, porém sem resultados.  
400 Ocorreu um erro ao tentar consultar as devoluções. [ bs2.pJ.empresas.http.responseResult.DetalheBadRequest ]

Recebimento - Consultar por e2eid

Recebimento - Consultar por e2eid


--curl
"GET": "/pix/direto/forintegration/v1/pix/{e2eid}"

{
 "endToEndId": "string",
 "txid": "string",
 "valor": "string",
 "horario": "2021-2-2T22:11:58.904Z",
 "pagador": {
  "cpf": "string",
  "cnpj": "string",
  "nome": "string"
 },
 "infoPagador": "string",
 "devolucoes": [
   {
    "id": "string",
    "rtrId": "string",
    "valor": "string",
    "horario": {
     "solicitacao": "2021-2-2T22:11:58.904Z",
     "liquidacao": "2021-2-2T22:11:58.904Z"
    },
    "status": [EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO],
    "motivo": "string"
   }
 ]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
e2eid path EndToEndIdentification que transita na PACS002, PACS004 e PACS008. Sim string

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pj.pixRecebidos.consultarPix.ConsultarPixResponse
204 Consulta realizada com sucesso, porém sem resultados.  
400 Ocorreu um erro ao tentar consultar o pix realizado. [ bs2.pJ.empresas.http.responseResult.DetalheBadRequest ]
404 Not Found microsoft.aspNetCore.mvc.ProblemDetails

Recebimento - Consultar

Recebimento - Consultar


--curl
"GET": "/pix/direto/forintegration/v1/pix"

{
 "parametros": {
  "inicio": "2021-2-2T22:11:58.904Z",
  "fim": "2021-2-2T22:11:58.904Z",
  "cpf": "string",
  "cnpj": "string",
  "status": [ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP],
  "paginacao": {
   "paginaAtual": 0,
   "itensPorPagina": 0,
   "quantidadeDePaginas": 0,
   "quantidadeTotalDeItens": 0
  }
 },
 "pix": [
   {
    "id": 0,
    "endToEndId": "string",
    "txId": "string",
    "valor": "string",
    "horario": "2021-2-2T22:11:58.904Z",
    "data": "2021-2-2T22:11:58.904Z",
    "pagador": {
     "cpf": "string",
     "cnpj": "string",
     "nome": "string"
    },
    "pagadorConta": {
     "banco": "string",
     "bancoNome": "string",
     "agencia": "string",
     "numero": "string",
     "ispb": "string",
     "tipo": [CC, SL, PP, UNKNOWN]
    },
    "recebedor": {
     "cpf": "string",
     "cnpj": "string",
     "nome": "string"
    },
    "recebedorConta": {
     "banco": "string",
     "bancoNome": "string",
     "agencia": "string",
     "numero": "string",
     "ispb": "string",
     "tipo": [CC, SL, PP, UNKNOWN]
    },
    "infoPagador": "string",
    "chaveDict": "string",
    "situacao": "string",
    "campoLivre": "string",
    "devolucoes": [
      {
       "id": "string",
       "rtrId": "string",
       "valor": "string",
       "horario": {
        "solicitacao": "2021-2-2T22:11:58.904Z",
        "liquidacao": "2021-2-2T22:11:58.904Z"
       },
       "status": [EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO],
       "motivo": "string"
      }
    ]
   }
 ]
}

Parâmetros

Nome Localizado em Descrição Requerido Schema
Inicio query Filtra os registros cuja data de criação seja maior ou igual a data de início. Sim dateTime
Fim query Filtra os registros cuja data de criação seja menor ou igual a data de fim. Sim dateTime
TxId query Filtra pelo Identificador da transação. Não string
CPF query Filtro pelo CPF do pagador. Não pode ser utilizado ao mesmo tempo que o CNPJ. Não string
CNPJ query Filtro pelo CNPJ do pagador. Não pode ser utilizado ao mesmo tempo que o CPF. Não string
Paginacao.PaginaAtual query   Não integer
Paginacao.ItensPorPagina query   Não integer

Resposta

Código Descrição Schema
200 Consulta realizada com sucesso. bs2.pj.pixRecebidos.consultarPixRecebidos.ConsultarPixRecebidosResponse
204 Consulta realizada com sucesso, porém sem resultados.  
400 Ocorreu um erro ao tentar consultar os pix recebidos. [ bs2.pJ.empresas.http.responseResult.DetalheBadRequest ]

Models

DevolucaoRequest

bs2.pj.pixRecebidos.solicitarDevolucao.DevolucaoRequest

Nome Tipo Descrição Tamanho Requerido
valor double   - Sim

Horario

bs2.pJ.pix.compartilhados.models.pixRecebidos.Horario

Nome Tipo Descrição Tamanho Requerido
solicitacao dateTime   - Não
liquidacao dateTime   - Não

PixDevolucaoStatus

bs2.pJ.pix.compartilhados.models.pixRecebidos.PixDevolucaoStatus

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.models.pixRecebidos.PixDevolucaoStatus string   -  

SolicitarDevolucaoResponse

bs2.pj.pixRecebidos.solicitarDevolucao.SolicitarDevolucaoResponse

Nome Tipo Descrição Tamanho Requerido
id string   - Não
rtrId string   - Não
valor double   - Não
horario bs2.pJ.pix.compartilhados.models.pixRecebidos.Horario   - Não
status enum EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO - Não

DetalheBadRequest

bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest

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

ConsultarDevolucaoResponse

bs2.pj.pixRecebidos.consultarDevolucao.ConsultarDevolucaoResponse

Nome Tipo Descrição Tamanho Requerido
id string   - Não
rtrId string   - Não
valor double   - Não
horario bs2.pJ.pix.compartilhados.models.pixRecebidos.Horario   - Não
status enum EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO - Não

DetalheBadRequest

bs2.pJ.empresas.http.responseResult.DetalheBadRequest

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

StatusCobranca

bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.StatusCobranca

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.StatusCobranca string   -  

PaginaResponseAuxConsultaPix

bs2.pJ.pix.compartilhados.models.pixRecebidos.PaginaResponseAuxConsultaPix

Nome Tipo Descrição Tamanho Requerido
paginaAtual integer   - Não
itensPorPagina integer   - Não
quantidadeDePaginas integer   - Não
quantidadeTotalDeItens integer   - Não

ParametrosConsultaPixRecebidos

bs2.pJ.pix.compartilhados.models.pixRecebidos.ParametrosConsultaPixRecebidos

Nome Tipo Descrição Tamanho Requerido
inicio dateTime   - Não
fim dateTime   - Não
cpf string   - Não
cnpj string   - Não
status enum ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP - Não
paginacao bs2.pJ.pix.compartilhados.models.pixRecebidos.PaginaResponseAuxConsultaPix   - Não

PagadorPix

bs2.pJ.pix.compartilhados.models.pixRecebidos.PagadorPix

Nome Tipo Descrição Tamanho Requerido
cpf string   - Não
cnpj string   - Não
nome string   - Não

TipoContaDevolucao

bs2.pJ.pix.compartilhados.models.recebimentos.TipoContaDevolucao

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.models.recebimentos.TipoContaDevolucao string   -  

ContaPix

bs2.pJ.pix.compartilhados.models.pixRecebidos.ContaPix

Nome Tipo Descrição Tamanho Requerido
banco string   - Não
bancoNome string   - Não
agencia string   - Não
numero string   - Não
ispb string   - Não
tipo enum CC, SL, PP, UNKNOWN - Não

DevolucoesPix

bs2.pJ.pix.compartilhados.models.pixRecebidos.DevolucoesPix

Nome Tipo Descrição Tamanho Requerido
id string   - Não
rtrId string   - Não
valor string   - Não
horario bs2.pJ.pix.compartilhados.models.pixRecebidos.Horario   - Não
status enum EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO - Não
motivo string   - Não

ConsultaPixRecebidosPix

bs2.pJ.pix.compartilhados.models.pixRecebidos.ConsultaPixRecebidosPix

Nome Tipo Descrição Tamanho Requerido
id integer   - Não
endToEndId string   - Não
txId string   - Não
valor string   - Não
horario dateTime   - Não
data dateTime   - Não
pagador bs2.pJ.pix.compartilhados.models.pixRecebidos.PagadorPix   - Não
pagadorConta bs2.pJ.pix.compartilhados.models.pixRecebidos.ContaPix   - Não
recebedor bs2.pJ.pix.compartilhados.models.pixRecebidos.PagadorPix   - Não
recebedorConta bs2.pJ.pix.compartilhados.models.pixRecebidos.ContaPix   - Não
infoPagador string   - Não
chaveDict string   - Não
situacao string   - Não
campoLivre string   - Não
devolucoes [ bs2.pJ.pix.compartilhados.models.pixRecebidos.DevolucoesPix ]   - Não

ConsultarPixRecebidosResponse

bs2.pj.pixRecebidos.consultarPixRecebidos.ConsultarPixRecebidosResponse

Nome Tipo Descrição Tamanho Requerido
parametros bs2.pJ.pix.compartilhados.models.pixRecebidos.ParametrosConsultaPixRecebidos   - Não
pix [ bs2.pJ.pix.compartilhados.models.pixRecebidos.ConsultaPixRecebidosPix ]   - Não

ConsultarPixResponse

bs2.pj.pixRecebidos.consultarPix.ConsultarPixResponse

Nome Tipo Descrição Tamanho Requerido
endToEndId string   - Não
txid string   - Não
valor string   - Não
horario dateTime   - Não
pagador bs2.pJ.pix.compartilhados.models.pixRecebidos.PagadorPix   - Não
infoPagador string   - Não
devolucoes [ bs2.pJ.pix.compartilhados.models.pixRecebidos.DevolucoesPix ]   - Não

ProblemDetails

microsoft.aspNetCore.mvc.ProblemDetails

Nome Tipo Descrição Tamanho Requerido
type string   - Não
title string   - Não
status integer   - Não
detail string   - Não
instance string   - Não
extensions object   - Não

StatusSolicitarDevolucao

bs2.pJ.pix.compartilhados.models.pixRecebidos.StatusSolicitarDevolucao

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.models.pixRecebidos.StatusSolicitarDevolucao string   -  

StatusRecebimento

bs2.pJ.pix.compartilhados.models.recebimentos.StatusRecebimento

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.models.recebimentos.StatusRecebimento string   -  

TipoContaBancaria

bs2.pJ.pix.compartilhados.enums.TipoContaBancaria

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.enums.TipoContaBancaria string   -  

Conta

bs2.pJ.pix.compartilhados.models.Conta

Nome Tipo Descrição Tamanho Requerido
banco string   - Não
bancoNome string   - Não
agencia string   - Não
numero string   - Não
tipo enum ContaCorrente, ContaSalario, Poupanca - Não

TipoDocumento

bs2.pJ.pix.compartilhados.enums.TipoDocumento

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.enums.TipoDocumento string   -  

Pessoa

bs2.pJ.pix.compartilhados.models.Pessoa

Nome Tipo Descrição Tamanho Requerido
documento string   - Não
tipoDocumento enum CPF, CNPJ - Não
nome string   - Não
nomeFantasia string   - Não

PagadorRecebedor

bs2.pJ.pix.compartilhados.models.PagadorRecebedor

Nome Tipo Descrição Tamanho Requerido
ispb string   - Não
conta bs2.pJ.pix.compartilhados.models.Conta   - Não
pessoa bs2.pJ.pix.compartilhados.models.Pessoa   - Não

Situacao

bs2.pJ.pix.compartilhados.models.Situacao

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.models.Situacao string   -  

Recebimento

bs2.pJ.pix.compartilhados.integrations.bs2Core.devolucao.Recebimento

Nome Tipo Descrição Tamanho Requerido
recebimentoId long   - Não
txId string   - Não
data dateTime   - Não
valor double   - Não
status enum Efetivado, Rejeitado, Validade, Unknow - Não
pagador bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
recebedor bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
chaveDict string   - Não
situacao enum ACCC, ACSC, ACSP, RJCT - Não

DevolucaoDetalhadaResponse

bs2.pJ.pix.compartilhados.integrations.bs2Core.devolucao.DevolucaoDetalhadaResponse

Nome Tipo Descrição Tamanho Requerido
devolucaoId long   - Não
endToEndId string   - Não
valor double   - Não
campoLivre string   - Não
status enum INICIADO, CONFIRMADO, EFETIVADO, REJEITADO - Não
dataCriacao dateTime   - Não
dataLiquidacao dateTime   - Não
recebimento bs2.pJ.pix.compartilhados.integrations.bs2Core.devolucao.Recebimento   - Não

PaginaResponseAux

bs2.pJ.pix.compartilhados.models.PaginaResponseAux

Nome Tipo Descrição Tamanho Requerido
qtd integer   - Não
paginaAtual integer   - Não
itensPorPagina integer   - Não

PaginaDevolucaoEncontrada

bs2.pJ.pix.apis.queries.forIntegration.direto.pixRecebidos.consultarDevolucoes.PaginaDevolucaoEncontrada

Nome Tipo Descrição Tamanho Requerido
items [ bs2.pJ.pix.compartilhados.integrations.bs2Core.devolucao.DevolucaoDetalhadaResponse ]   - Não
pagina bs2.pJ.pix.compartilhados.models.PaginaResponseAux   - Não

TipoReivindicacao

bs2.pJ.pix.domain.models.reivindicacaoAggregate.TipoReivindicacao

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.domain.models.reivindicacaoAggregate.TipoReivindicacao string   -  

TipoChave

bs2.pJ.pix.compartilhados.enums.TipoChave

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.enums.TipoChave string   -  

Chave

bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.dict.reivindicacoes.solicitar.Chave

Nome Tipo Descrição Tamanho Requerido
valor string   - Não
tipo enum CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA - Não

ReivindicacaoParaSolicitar

bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.dict.reivindicacoes.solicitar.ReivindicacaoParaSolicitar

Nome Tipo Descrição Tamanho Requerido
tipo enum posse, portabilidade - Não
chave bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.dict.reivindicacoes.solicitar.Chave   - Não

ReivindicacaoCriada

bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.dict.reivindicacoes.solicitar.ReivindicacaoCriada

Nome Tipo Descrição Tamanho Requerido
reivindicacaoId string (uuid)   - Não

ReivindicadorParaProcessar

bs2.pJ.pix.apis.commands.compartilhados.ReivindicadorParaProcessar

Nome Tipo Descrição Tamanho Requerido
reivindicacoes [ string (uuid) ]   - Não

DoadorParaProcessar

bs2.pJ.pix.apis.commands.compartilhados.DoadorParaProcessar

Nome Tipo Descrição Tamanho Requerido
reivindicacoes [ string (uuid) ]   - Não

ReivindicacoesParaProcessar

bs2.pJ.pix.apis.commands.compartilhados.ReivindicacoesParaProcessar

Nome Tipo Descrição Tamanho Requerido
reivindicador bs2.pJ.pix.apis.commands.compartilhados.ReivindicadorParaProcessar   - Não
doador bs2.pJ.pix.apis.commands.compartilhados.DoadorParaProcessar   - Não

SolicitacaoReivindicacaoProcessada

bs2.pJ.pix.apis.commands.compartilhados.SolicitacaoReivindicacaoProcessada

Nome Tipo Descrição Tamanho Requerido
solicitacaoId string (uuid)   - Não
aprovada boolean   - Não
mensagem string   - Não

ReivindicadorProcessado

bs2.pJ.pix.apis.commands.compartilhados.ReivindicadorProcessado

Nome Tipo Descrição Tamanho Requerido
reivindicacoes [ bs2.pJ.pix.apis.commands.compartilhados.SolicitacaoReivindicacaoProcessada ]   - Não

DoadorProcessado

bs2.pJ.pix.apis.commands.compartilhados.DoadorProcessado

Nome Tipo Descrição Tamanho Requerido
reivindicacoes [ bs2.pJ.pix.apis.commands.compartilhados.SolicitacaoReivindicacaoProcessada ]   - Não

ReivindicacoesProcessadas

bs2.pJ.pix.apis.commands.compartilhados.ReivindicacoesProcessadas

Nome Tipo Descrição Tamanho Requerido
reivindicador bs2.pJ.pix.apis.commands.compartilhados.ReivindicadorProcessado   - Não
doador bs2.pJ.pix.apis.commands.compartilhados.DoadorProcessado   - Não

StatusReivindicacao

bs2.pJ.pix.domain.models.reivindicacaoAggregate.StatusReivindicacao

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.domain.models.reivindicacaoAggregate.StatusReivindicacao string   -  

ReivindicadorDoador

bs2.pJ.pix.compartilhados.models.ReivindicadorDoador

Nome Tipo Descrição Tamanho Requerido
conta bs2.pJ.pix.compartilhados.models.Conta   - Não
pessoa bs2.pJ.pix.compartilhados.models.Pessoa   - Não

Chave

bs2.pJ.pix.compartilhados.models.Chave

Nome Tipo Descrição Tamanho Requerido
id string (uuid)   - Não
valor string   - Não
tipo enum CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA - Não
apelido string   - Não

ReivindicacaoReivindicadorEncontrada

bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.dict.reivindicacao.obterReivindicacoesReivindicador.ReivindicacaoReivindicadorEncontrada

Nome Tipo Descrição Tamanho Requerido
reivindicacaoId string (uuid)   - Não
tipo enum posse, portabilidade - Não
status enum ABERTO, AGUARDANDO_RESOLUCAO, CONFIRMADO, CANCELADO, COMPLETO - Não
dataFinalResolucao dateTime   - Não
dataFinalEncerramento dateTime   - Não
dataUltimaAtualizacao dateTime   - Não
reivindicador bs2.pJ.pix.compartilhados.models.ReivindicadorDoador   - Não
chave bs2.pJ.pix.compartilhados.models.Chave   - Não

PaginaReivindicacoesReivindicadorEncontradas

bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.dict.reivindicacao.obterReivindicacoesReivindicador.PaginaReivindicacoesReivindicadorEncontradas

Nome Tipo Descrição Tamanho Requerido
items [ bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.dict.reivindicacao.obterReivindicacoesReivindicador.ReivindicacaoReivindicadorEncontrada ]   - Não
pagina bs2.pJ.pix.compartilhados.models.PaginaResponseAux   - Não

ReivindicacaoDoadorEncontrada

bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.dict.reivindicacao.obterReivindicacoesDoador.ReivindicacaoDoadorEncontrada

Nome Tipo Descrição Tamanho Requerido
reivindicacaoId string (uuid)   - Não
tipo enum posse, portabilidade - Não
status enum ABERTO, AGUARDANDO_RESOLUCAO, CONFIRMADO, CANCELADO, COMPLETO - Não
dataFinalResolucao dateTime   - Não
dataFinalEncerramento dateTime   - Não
dataUltimaAtualizacao dateTime   - Não
reivindicador bs2.pJ.pix.compartilhados.models.ReivindicadorDoador   - Não
doador bs2.pJ.pix.compartilhados.models.ReivindicadorDoador   - Não
chave bs2.pJ.pix.compartilhados.models.Chave   - Não

PaginaReivindicacoesDoadorEncontradas

bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.dict.reivindicacao.obterReivindicacoesDoador.PaginaReivindicacoesDoadorEncontradas

Nome Tipo Descrição Tamanho Requerido
items [ bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.dict.reivindicacao.obterReivindicacoesDoador.ReivindicacaoDoadorEncontrada ]   - Não
pagina bs2.pJ.pix.compartilhados.models.PaginaResponseAux   - Não

ContaBancaria

bs2.pJ.pix.apis.queries.compartilhados.ContaBancaria

Nome Tipo Descrição Tamanho Requerido
id string (uuid)   - Não
agencia integer   - Não
numero long   - Não
tipo integer   - Não

Chave

bs2.pJ.pix.apis.queries.compartilhados.Chave

Nome Tipo Descrição Tamanho Requerido
id string (uuid)   - Não
valor string   - Não
tipo enum CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA - Não
dataCriacao dateTime   - Não
contaBancaria bs2.pJ.pix.apis.queries.compartilhados.ContaBancaria   - Não
apelido string   - Não
solicitante string   - Não
sistemaOrigem string   - Não

ChavesEncontradas

bs2.pJ.pix.apis.queries.compartilhados.ChavesEncontradas

Nome Tipo Descrição Tamanho Requerido
items [ bs2.pJ.pix.apis.queries.compartilhados.Chave ]   - Não

ChaveParaCriar

bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.dict.criarChave.ChaveParaCriar

Nome Tipo Descrição Tamanho Requerido
valor string   - Não
tipo enum CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA - Não
apelido string   - Não

ChaveCriada

bs2.pj.dict.criarChave.ChaveCriada

Nome Tipo Descrição Tamanho Requerido
chaveId string (uuid)   - Não

TipoOperacao

bs2.pJ.pix.compartilhados.enums.TipoOperacao

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.enums.TipoOperacao string   -  

Reivindicacao

bs2.pj.dict.criarChave.Reivindicacao

Nome Tipo Descrição Tamanho Requerido
tipoOperacao enum posse, portabilidade, alteracaodeconta - Não

ApelidoParaAlterar

bs2.pJ.pix.apis.commands.forIntegration.direto.dict.alterarApelido.ApelidoParaAlterar

Nome Tipo Descrição Tamanho Requerido
apelido string   - Não

EmpresaEnderecoEncontrado

bs2.pJ.pix.apis.queries.forIntegration.direto.empresas.obterEmpresaPorId.EmpresaEnderecoEncontrado

Nome Tipo Descrição Tamanho Requerido
logradouro string   - Não
numero string   - Não
complemento string   - Não
cep string   - Não
bairro string   - Não
cidade string   - Não
estado string   - Não

EmpresaEncontrada

bs2.pJ.pix.apis.queries.forIntegration.direto.empresas.obterEmpresaPorId.EmpresaEncontrada

Nome Tipo Descrição Tamanho Requerido
id string (uuid)   - Não
ispb string   - Não
nome string   - Não
nomeFantasia string   - Não
documento string   - Não
endereco bs2.pJ.pix.apis.queries.forIntegration.direto.empresas.obterEmpresaPorId.EmpresaEnderecoEncontrado   - Não

NotFoundResult

microsoft.aspNetCore.mvc.NotFoundResult

Nome Tipo Descrição Tamanho Requerido
statusCode integer   - Não

EmpresaEnderecoParaCriar

bs2.pj.empresas.criarEmpresa.EmpresaEnderecoParaCriar

Nome Tipo Descrição Tamanho Requerido
logradouro string   - Não
numero string   - Não
complemento string   - Não
cep string   - Não
bairro string   - Não
cidade string   - Sim
estado string   - Não

EmpresaParaAlterar

bs2.pj.empresas.alterarEmpresa.EmpresaParaAlterar

Nome Tipo Descrição Tamanho Requerido
nome string   - Sim
endereco bs2.pj.empresas.criarEmpresa.EmpresaEnderecoParaCriar   - Não

EmpresaParaCriar

bs2.pj.empresas.criarEmpresa.EmpresaParaCriar

Nome Tipo Descrição Tamanho Requerido
empresaId string (uuid)   - Sim
nome string   - Sim
nomeFantasia string   - Sim
documento string   - Sim
endereco bs2.pj.empresas.criarEmpresa.EmpresaEnderecoParaCriar   - Não

ContasBancariasEncontradas

bs2.pJ.pix.apis.queries.compartilhados.ContasBancariasEncontradas

Nome Tipo Descrição Tamanho Requerido
contasBancarias [ bs2.pJ.pix.apis.queries.compartilhados.ContaBancaria ]   - Não

ContaBancaria

bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.contaBancaria.criar.ContaBancaria

Nome Tipo Descrição Tamanho Requerido
agencia integer   - Não
numero long   - Não
numeroContaLastro long   - Não
dataAbertura dateTime   - Não

ContaBancariaCriada

bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.contaBancaria.criar.ContaBancariaCriada

Nome Tipo Descrição Tamanho Requerido
id string (uuid)   - Não

ObterParticipantesResponse

bs2.pJ.pix.compartilhados.integrations.bs2Core.gerenciamentoPSP.ObterParticipantesResponse

Nome Tipo Descrição Tamanho Requerido
ispb string   - Não
bancoCodigo string   - Não
nome string   - Não
parceiro boolean   - Não

PaginaParticipantesEncontrados

bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.participantes.obterParticipantes.PaginaParticipantesEncontrados

Nome Tipo Descrição Tamanho Requerido
items [ bs2.pJ.pix.compartilhados.integrations.bs2Core.gerenciamentoPSP.ObterParticipantesResponse ]   - Não
pagina bs2.pJ.pix.compartilhados.models.PaginaResponseAux   - Não

StatusPagamento

bs2.pJ.pix.compartilhados.enums.StatusPagamento

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.enums.StatusPagamento string   -  

TipoPagamento

bs2.pJ.pix.compartilhados.enums.TipoPagamento

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.enums.TipoPagamento string   -  

PagamentoEncontrado

bs2.pJ.pix.apis.queries.forIntegration.direto.pagamentos.obterPagamentos.PagamentoEncontrado

Nome Tipo Descrição Tamanho Requerido
pagamentoId string (uuid)   - Não
endToEndId string   - Não
dataHoraCriacao dateTime   - Não
pagador bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
recebedor bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
informacoesEntreUsuarios string   - Não
status enum INICIADO, CONFIRMADO, EFETIVADO, REJEITADO, ERRO, EXPIRADO - Não
valor double   - Não

PaginaPagamentoEncontrado

bs2.pJ.pix.apis.queries.forIntegration.direto.pagamentos.obterPagamentos.PaginaPagamentoEncontrado

Nome Tipo Descrição Tamanho Requerido
items [ bs2.pJ.pix.apis.queries.forIntegration.direto.pagamentos.obterPagamentos.PagamentoEncontrado ]   - Não
pagina bs2.pJ.pix.compartilhados.models.PaginaResponseAux   - Não

QrCodeDetalhe

bs2.pJ.pix.compartilhados.models.QrCodeDetalhe

Nome Tipo Descrição Tamanho Requerido
categoria integer   - Não
moeda integer   - Não
pais string   - Não
cidade string   - Não
txId string   - Não

CobrancaCalendario

bs2.pJ.pix.compartilhados.models.pagamentos.CobrancaCalendario

Nome Tipo Descrição Tamanho Requerido
criacao dateTime   - Não
apresentacao dateTime   - Não
expiracao integer   - Não
vencimento dateTime   - Não
recebivelAposVencimento boolean   - Não

CobrancaDocumento

bs2.pJ.pix.compartilhados.models.pagamentos.CobrancaDocumento

Nome Tipo Descrição Tamanho Requerido
revisao integer   - Não
versao integer   - Não

CobrancaPagador

bs2.pJ.pix.compartilhados.models.pagamentos.CobrancaPagador

Nome Tipo Descrição Tamanho Requerido
nome string   - Não
cpf string   - Não
cnpj string   - Não

CobrancaValor

bs2.pJ.pix.compartilhados.models.pagamentos.CobrancaValor

Nome Tipo Descrição Tamanho Requerido
original double   - Não
final double   - Não
juros double   - Não
multa double   - Não
desconto double   - Não
permiteAlteracao boolean   - Não

CobrancaChave

bs2.pJ.pix.compartilhados.models.pagamentos.CobrancaChave

Nome Tipo Descrição Tamanho Requerido
valor string   - Não
tipo enum CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA - Não

DetalheInformacaoAdicional

bs2.pJ.pix.compartilhados.models.pagamentos.DetalheInformacaoAdicional

Nome Tipo Descrição Tamanho Requerido
nome string   - Não
valor string   - Não

Cobranca

bs2.pJ.pix.compartilhados.models.pagamentos.formatoBacen.Cobranca

Nome Tipo Descrição Tamanho Requerido
id string   - Não
calendario bs2.pJ.pix.compartilhados.models.pagamentos.CobrancaCalendario   - Não
documento bs2.pJ.pix.compartilhados.models.pagamentos.CobrancaDocumento   - Não
pagador bs2.pJ.pix.compartilhados.models.pagamentos.CobrancaPagador   - Não
valor bs2.pJ.pix.compartilhados.models.pagamentos.CobrancaValor   - Não
chave bs2.pJ.pix.compartilhados.models.pagamentos.CobrancaChave   - Não
solicitacao string   - Não
infoAdicionais [ bs2.pJ.pix.compartilhados.models.pagamentos.DetalheInformacaoAdicional ]   - Não

PagamentoEncontrado

bs2.pJ.pix.apis.queries.forIntegration.direto.pagamentos.obterPagamentoPorId.PagamentoEncontrado

Nome Tipo Descrição Tamanho Requerido
endToEndId string   - Não
qrCode bs2.pJ.pix.compartilhados.models.QrCodeDetalhe   - Não
cobranca bs2.pJ.pix.compartilhados.models.pagamentos.formatoBacen.Cobranca   - Não
recebedor bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não

PagamentoParaIniciar

bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.iniciarPagamentoPorQrCode.PagamentoParaIniciar

Nome Tipo Descrição Tamanho Requerido
qrCode string   - Sim

TipoQrCode

bs2.pJ.pix.compartilhados.enums.TipoQrCode

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.enums.TipoQrCode string   -  

PagamentoIniciado

bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.iniciarPagamentoPorQrCode.PagamentoIniciado

Nome Tipo Descrição Tamanho Requerido
pagamentoId string (uuid)   - Não
endToEndId string   - Não
pagador bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
recebedor bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
valor double   - Não
tipo enum estatico, dinamico - Não
campoLivre string   - Não
cobranca bs2.pJ.pix.compartilhados.models.pagamentos.formatoBacen.Cobranca   - Não
txId string   - Não

PagamentoParaIniciar

bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.iniciarPagamentoPorChave.PagamentoParaIniciar

Nome Tipo Descrição Tamanho Requerido
chave bs2.pJ.pix.compartilhados.models.Chave   - Sim

PagamentoIniciado

bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.iniciarPagamentoPorChave.PagamentoIniciado

Nome Tipo Descrição Tamanho Requerido
pagamentoId string (uuid)   - Não
endToEndId string   - Não
recebedor bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
pagador bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não

Conta

bs2.pJ.pix.compartilhados.models.pagamentos.Conta

Nome Tipo Descrição Tamanho Requerido
agencia integer   - Não
numero long   - Não
tipo enum ContaCorrente, ContaSalario, Poupanca - Não

PagadorRecebedor

bs2.pJ.pix.compartilhados.models.pagamentos.PagadorRecebedor

Nome Tipo Descrição Tamanho Requerido
ispb string   - Não
conta bs2.pJ.pix.compartilhados.models.pagamentos.Conta   - Não
pessoa bs2.pJ.pix.compartilhados.models.Pessoa   - Não

PagamentoParaIniciar

bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.iniciarPagamentoManual.PagamentoParaIniciar

Nome Tipo Descrição Tamanho Requerido
recebedor bs2.pJ.pix.compartilhados.models.pagamentos.PagadorRecebedor   - Sim

PagamentoIniciado

bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.iniciarPagamentoManual.PagamentoIniciado

Nome Tipo Descrição Tamanho Requerido
pagamentoId string (uuid)   - Não
endToEndId string   - Não
recebedor bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
pagador bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não

PagamentoParaConfirmar

bs2.pJ.pix.apis.commands.forIntegration.direto.pagamentos.confirmarPagamento.PagamentoParaConfirmar

Nome Tipo Descrição Tamanho Requerido
recebedor bs2.pJ.pix.compartilhados.models.pagamentos.PagadorRecebedor   - Sim
valor double   - Sim
campoLivre string   - Não

PagamentoEncontrado

bs2.pJ.pix.compartilhados.integrations.bs2Core.pagamentos.PagamentoEncontrado

Nome Tipo Descrição Tamanho Requerido
pagamentoId string (uuid)   - Não
loteId string   - Não
identificadorRemessa string   - Não
identificadorTransacao string   - Não
endToEndId string   - Não
dataHoraCriacao dateTime   - Não
dataHoraConfirmacao dateTime   - Não
dataHoraEfetivacao dateTime   - Não
dataHoraExpiracao integer   - Não
pagador bs2.pJ.pix.compartilhados.models.Pessoa   - Não
recebedor bs2.pJ.pix.compartilhados.models.Pessoa   - Não
informacoesEntreUsuarios string   - Não
sistemaOrigem string   - Não
status string   - Não
statusDescricao string   - Não
tipo string   - Não
tipoDescricao string   - Não
valor double   - Não
erroCodigo string   - Não
erroDescricao string   - Não
contaCorrenteBloqueioProtocolo string   - Não
contaCorrenteDesbloqueioProtocolo string   - Não
contaCorrenteDebitoProtocolo string   - Não
contaCorrenteDebitoEstornoProtocolo string   - Não
contaCorrenteCreditoProtocolo string   - Não
contaCorrenteProtocolo string   - Não
contaCorrenteProtocoloEstorno string   - Não
icomMessageId string   - Não

InformacoesAdicionais

bs2.pJ.pix.compartilhados.models.InformacoesAdicionais

Nome Tipo Descrição Tamanho Requerido
pagamentoId string (uuid)   - Não
nome string   - Não
valor string   - Não

Documento

bs2.pJ.pix.compartilhados.models.Documento

Nome Tipo Descrição Tamanho Requerido
id string   - Não
revisao string   - Não
versao string   - Não
identificador string   - Não

Calendario

bs2.pJ.pix.compartilhados.models.Calendario

Nome Tipo Descrição Tamanho Requerido
criacao dateTime   - Não
apresentacao dateTime   - Não
expiracao integer   - Não
vencimento dateTime   - Não
recebivelAposVencimento boolean   - Não

Valores

bs2.pJ.pix.compartilhados.models.Valores

Nome Tipo Descrição Tamanho Requerido
original double   - Não
final double   - Não
juros double   - Não
multa double   - Não
desconto double   - Não
permiteAlterarValor boolean   - Não

Cobranca

bs2.pJ.pix.compartilhados.models.pagamentos.Cobranca

Nome Tipo Descrição Tamanho Requerido
chaveDict string   - Não
chaveTipo enum CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA - Não
solicitacaoPagador string   - Não
informacoesAdicionais [ bs2.pJ.pix.compartilhados.models.InformacoesAdicionais ]   - Não
assinatura string   - Não
documento bs2.pJ.pix.compartilhados.models.Documento   - Não
calendario bs2.pJ.pix.compartilhados.models.Calendario   - Não
valores bs2.pJ.pix.compartilhados.models.Valores   - Não

DetalharPagamentoEndToEnd

bs2.pJ.pix.apis.queries.forIntegration.direto.pagamentos.detalharPagamentoEndToEnd.DetalharPagamentoEndToEnd

Nome Tipo Descrição Tamanho Requerido
pagamento bs2.pJ.pix.compartilhados.integrations.bs2Core.pagamentos.PagamentoEncontrado   - Não
qrCode bs2.pJ.pix.compartilhados.models.QrCodeDetalhe   - Não
cobranca bs2.pJ.pix.compartilhados.models.pagamentos.Cobranca   - Não

StatusDevolucaoPix

bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.StatusDevolucaoPix

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.StatusDevolucaoPix string   -  

Devolucao

bs2.pJ.pix.compartilhados.models.recebimentos.Devolucao

Nome Tipo Descrição Tamanho Requerido
id string   - Não
rtrId string   - Não
valor double   - Não
horario bs2.pJ.pix.compartilhados.models.pixRecebidos.Horario   - Não
status enum EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO - Não
motivo string   - Não

ObterRecebimentosResponse

bs2.pJ.pix.apis.queries.forIntegration.direto.recebimentos.obterRecebimentos.ObterRecebimentosResponse

Nome Tipo Descrição Tamanho Requerido
endToEndId string   - Não
recebimentoId integer   - Não
txId string   - Não
data dateTime   - Não
valor double   - Não
status enum Efetivado, Rejeitado, Validade, Unknow - Não
pagador bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
recebedor bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
chaveDict string   - Não
campoLivre string   - Não
situacao enum ACCC, ACSC, ACSP, RJCT - Não
devolucoes [ bs2.pJ.pix.compartilhados.models.recebimentos.Devolucao ]   - Não

PaginaRecebimentoEncontrados

bs2.pj.recebimentos.obterRecebimentos.PaginaRecebimentoEncontrados

Nome Tipo Descrição Tamanho Requerido
items [ bs2.pJ.pix.apis.queries.forIntegration.direto.recebimentos.obterRecebimentos.ObterRecebimentosResponse ]   - Não
pagina bs2.pJ.pix.compartilhados.models.PaginaResponseAux   - Não

RecebimentoEncontrados

bs2.pj.recebimentos.obterRecebimentos.RecebimentoEncontrados

Nome Tipo Descrição Tamanho Requerido
endToEndId string   - Não
recebimentoId integer   - Não
txId string   - Não
data dateTime   - Não
valor double   - Não
status enum Efetivado, Rejeitado, Validade, Unknow - Não
pagador bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
recebedor bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
chaveDict string   - Não
campoLivre string   - Não
situacao enum ACCC, ACSC, ACSP, RJCT - Não
devolucoes [ bs2.pJ.pix.compartilhados.models.recebimentos.Devolucao ]   - Não
pagina bs2.pJ.pix.compartilhados.models.PaginaResponseAux   - Não

RecebimentoEncontrado

bs2.pj.recebimentos.obterRecebimentos.RecebimentoEncontrado

Nome Tipo Descrição Tamanho Requerido
recebimentoId integer   - Não
txId string   - Não
endToEndId string   - Não
data dateTime   - Não
valor double   - Não
status enum Efetivado, Rejeitado, Validade, Unknow - Não
pagador bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
recebedor bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
chaveDict string   - Não
campoLivre string   - Não
situacao enum ACCC, ACSC, ACSP, RJCT - Não
devolucoes [ bs2.pJ.pix.compartilhados.models.recebimentos.Devolucao ]   - Não

RecebimentoStatus

bs2.pJ.pix.compartilhados.integrations.bs2Core.recebimentos.RecebimentoStatus

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.integrations.bs2Core.recebimentos.RecebimentoStatus string   -  

ContaBancariaDevolucao

bs2.pJ.pix.compartilhados.models.recebimentos.ContaBancariaDevolucao

Nome Tipo Descrição Tamanho Requerido
id string (uuid)   - Não
agencia string   - Não
ispb string   - Não
numero string   - Não
banco string   - Não
bancoNome string   - Não
tipo enum CC, SL, PP, UNKNOWN - Não

PessoaRecebedor

bs2.pJ.pix.compartilhados.integrations.bs2Core.pagamentos.PessoaRecebedor

Nome Tipo Descrição Tamanho Requerido
documento string   - Não
tipoDocumento string   - Não
nome string   - Não
nomeFantasia string   - Não

RecebimentosQrCodeIdResponse

bs2.pJ.pix.apis.queries.forIntegration.direto.recebimentos.obterRecebimentoQrCodeId.RecebimentosQrCodeIdResponse

Nome Tipo Descrição Tamanho Requerido
id integer   - Não
identificadorTransacao string   - Não
data dateTime   - Não
valor long   - Não
status enum ATIVO, ERRO, VALIDO, UNKNOWN - Não
pagadorConta bs2.pJ.pix.compartilhados.models.recebimentos.ContaBancariaDevolucao   - Não
pagadorDocumento bs2.pJ.pix.compartilhados.integrations.bs2Core.pagamentos.PessoaRecebedor   - Não
recebedorConta bs2.pJ.pix.compartilhados.models.recebimentos.ContaBancariaDevolucao   - Não
recebedorDocumento bs2.pJ.pix.compartilhados.integrations.bs2Core.pagamentos.PessoaRecebedor   - Não
chaveDict string   - Não
msgId object   - Não
endToEndId string   - Não
campoLivre object   - Não
msgId2 object   - Não
originalId string   - Não
endToEndId2 object   - Não
situacao enum ACCC, ACSC, ACSP, RJCT - Não
devolucoes [ bs2.pJ.pix.compartilhados.models.recebimentos.Devolucao ]   - Não

PaginaRecebimentoEncontrados

bs2.pj.recebimentos.obterRecebimentoQrCodeId.PaginaRecebimentoEncontrados

Nome Tipo Descrição Tamanho Requerido
recebimentos [ bs2.pJ.pix.apis.queries.forIntegration.direto.recebimentos.obterRecebimentoQrCodeId.RecebimentosQrCodeIdResponse ]   - Não

QRCodeTodosResponse

bs2.pJ.pix.compartilhados.models.recebimentos.QRCodeTodosResponse

Nome Tipo Descrição Tamanho Requerido
qrCodeId long   - Não
tipo enum estatico, dinamico - Não
txId string   - Não
dataCriacao dateTime   - Não
dataValidade dateTime   - Não
valor double   - Não
status enum ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP - Não
campoLivre string   - Não
chave bs2.pJ.pix.compartilhados.models.Chave   - Não
link string   - Não
recebedor bs2.pJ.pix.compartilhados.models.PagadorRecebedor   - Não
qrCode string   - Não
valorRecebimento double   - Não
quantidadePagamento integer   - Não

PaginaObterQrCodeResponse

bs2.pj.recebimentos.obterQrCode.PaginaObterQrCodeResponse

Nome Tipo Descrição Tamanho Requerido
items [ bs2.pJ.pix.compartilhados.models.recebimentos.QRCodeTodosResponse ]   - Não
pagina bs2.pJ.pix.compartilhados.models.PaginaResponseAux   - Não

RecebimentoParaCriar

bs2.pj.recebimentos.criarRecebimentoPorQrCodeEstatico.RecebimentoParaCriar

Nome Tipo Descrição Tamanho Requerido
chave string   - Não
valor double   - Não
campoLivre string   - Não
txId string   - Não

RecebimentoCriado

bs2.pj.recebimentos.criarRecebimentoPorQrCodeEstatico.RecebimentoCriado

Nome Tipo Descrição Tamanho Requerido
txId string   - Não
qrCode string   - Não
dataCriacao dateTime   - Não

CalendarioCobranca

bs2.pj.compartilhados.CalendarioCobranca

Nome Tipo Descrição Tamanho Requerido
expiracao integer   - Não

DevedorCobranca

bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.DevedorCobranca

Nome Tipo Descrição Tamanho Requerido
cnpj string   - Não
cpf string   - Não
nome string   - Não

Valor

bs2.pj.compartilhados.Valor

Nome Tipo Descrição Tamanho Requerido
original double   - Sim
juros double   - Não
multa double   - Não
desconto double   - Não
final double   - Não
permiteAlteracao boolean   - Não

DetalheInformacaoAdicional

bs2.pJ.pix.compartilhados.models.recebimentos.DetalheInformacaoAdicional

Nome Tipo Descrição Tamanho Requerido
nome string   - Não
valor string   - Não

Cobranca

bs2.pj.recebimentos.criarRecebimentoPorQrCodeDinamico.Cobranca

Nome Tipo Descrição Tamanho Requerido
calendario bs2.pj.compartilhados.CalendarioCobranca   - Não
devedor bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.DevedorCobranca   - Sim
valor bs2.pj.compartilhados.Valor   - Sim
chave string   - Sim
solicitacaoPagador string   - Não
infoAdicionais [ bs2.pJ.pix.compartilhados.models.recebimentos.DetalheInformacaoAdicional ]   - Não

RecebimentoParaCriar

bs2.pj.recebimentos.criarRecebimentoPorQrCodeDinamico.RecebimentoParaCriar

Nome Tipo Descrição Tamanho Requerido
txId string   - Sim
cobranca bs2.pj.recebimentos.criarRecebimentoPorQrCodeDinamico.Cobranca   - Não
aceitaMaisDeUmPagamento boolean   - Não
recebivelAposVencimento boolean   - Não

CalendarioCobranca

bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.CalendarioCobranca

Nome Tipo Descrição Tamanho Requerido
expiracao integer   - Não
criacao dateTime   - Não

InfoAdicionais

bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.InfoAdicionais

Nome Tipo Descrição Tamanho Requerido
nome string   - Não
valor string   - Não

RecebimentoCriadoDinamico

bs2.pj.recebimentos.criarRecebimentoPorQrCodeDinamico.RecebimentoCriadoDinamico

Nome Tipo Descrição Tamanho Requerido
calendario bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.CalendarioCobranca   - Não
status enum ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP - Não
txId string   - Não
revisao integer   - Não
location string   - Não
qrCode string   - Não
devedor bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.DevedorCobranca   - Não
valor bs2.pj.compartilhados.Valor   - Não
chave string   - Não
solicitacaoPagador string   - Não
infoAdicionais [ bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.InfoAdicionais ]   - Não

RevisarRequest

bs2.pj.gerenciarCobrancas.revisarCobranca.RevisarRequest

Nome Tipo Descrição Tamanho Requerido
calendario bs2.pj.compartilhados.CalendarioCobranca   - Não
status enum ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP - Não
devedor bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.DevedorCobranca   - Sim
valor bs2.pj.compartilhados.Valor   - Sim
chave string   - Não
solicitacaoPagador string   - Não
informacoesAdicionais [ bs2.pJ.pix.compartilhados.models.recebimentos.DetalheInformacaoAdicional ]   - Não

RevisarResponse

bs2.pj.gerenciarCobrancas.revisarCobranca.RevisarResponse

Nome Tipo Descrição Tamanho Requerido
calendario bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.CalendarioCobranca   - Não
status enum ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP - Não
txId string   - Não
revisao integer   - Não
location string   - Não
devedor bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.DevedorCobranca   - Não
valor bs2.pj.compartilhados.Valor   - Não
chave string   - Não
solicitacaoPagador string   - Não
infoAdicionais [ bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.InfoAdicionais ]   - Não

Valor

bs2.pj.gerenciarCobrancas.criarCobranca.Valor

Nome Tipo Descrição Tamanho Requerido
original double   - Sim

CobrancaRequest

bs2.pj.gerenciarCobrancas.criarCobranca.CobrancaRequest

Nome Tipo Descrição Tamanho Requerido
calendario bs2.pj.compartilhados.CalendarioCobranca   - Não
devedor bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.DevedorCobranca   - Sim
valor bs2.pj.gerenciarCobrancas.criarCobranca.Valor   - Sim
chave string   - Sim
solicitacaoPagador string   - Não
infoAdicionais [ bs2.pJ.pix.compartilhados.models.recebimentos.DetalheInformacaoAdicional ]   - Não

CobrancaResponse

bs2.pj.gerenciarCobrancas.criarCobranca.CobrancaResponse

Nome Tipo Descrição Tamanho Requerido
calendario bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.CalendarioCobranca   - Não
status enum ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP - Não
txId string   - Não
revisao integer   - Não
location string   - Não
devedor bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.DevedorCobranca   - Não
valor bs2.pj.compartilhados.Valor   - Não
chave string   - Não
solicitacaoPagador string   - Não
infoAdicionais [ bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.InfoAdicionais ]   - Não

DevolucaoPixResultado

bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.DevolucaoPixResultado

Nome Tipo Descrição Tamanho Requerido
id string   - Não
rtrId string   - Não
valor double   - Não
horario bs2.pJ.pix.compartilhados.models.pixRecebidos.Horario   - Não
status enum EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO - Não

PixResultado

bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.PixResultado

Nome Tipo Descrição Tamanho Requerido
endToEndId string   - Não
txId string   - Não
valor double   - Não
horario dateTime   - Não
pagador bs2.pJ.pix.compartilhados.models.pixRecebidos.PagadorPix   - Não
infoPagador string   - Não
devolucoes [ bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.DevolucaoPixResultado ]   - Não

ConsultarResponse

bs2.pj.gerenciarCobrancas.consultarCobranca.ConsultarResponse

Nome Tipo Descrição Tamanho Requerido
calendario bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.CalendarioCobranca   - Não
status enum ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP - Não
txId string O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API PIX. - Não
revisao integer Revisão da cobrança. Sempre começa em zero. Sempre varia em acréscimos de 1. - Não
location string Localização do Payload a ser informada na criação da cobrança. - Não
devedor bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.DevedorCobranca   - Não
valor bs2.pj.gerenciarCobrancas.criarCobranca.Valor   - Não
chave string O campo chave, obrigatório, determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança. - Não
solicitacaoPagador string O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres. - Não
infoAdicionais [ bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.InfoAdicionais ] Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador. - Não
pix [ bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.PixResultado ]   - Não

ValorResponse

bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.ValorResponse

Nome Tipo Descrição Tamanho Requerido
original double   - Não

ListaCobrancaCobs

bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.ListaCobrancaCobs

Nome Tipo Descrição Tamanho Requerido
calendario bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.CalendarioCobranca   - Não
status enum ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP - Não
txId string   - Não
revisao string   - Não
location string   - Não
devedor bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.DevedorCobranca   - Não
valor bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.ValorResponse   - Não
chave string   - Não
solicitacaoPagador string   - Não
infoAdicionais [ bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.InfoAdicionais ]   - Não
pix [ bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.PixResultado ]   - Não

ListaCobrancaResponse

bs2.pj.gerenciarCobrancas.consultarListaCobranca.ListaCobrancaResponse

Nome Tipo Descrição Tamanho Requerido
parametros bs2.pJ.pix.compartilhados.models.pixRecebidos.ParametrosConsultaPixRecebidos   - Não
cobs [ bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.ListaCobrancaCobs ]   - Não

InscricaoEncontrada

bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.empresas.webhook.inscricao.obterInscricao.InscricaoEncontrada

Nome Tipo Descrição Tamanho Requerido
webhookUrl string   - Não

TipoCredencial

bs2.pJ.pix.domain.models.empresaAggregate.TipoCredencial

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.domain.models.empresaAggregate.TipoCredencial string   -  

WebhookAutorizacao

bs2.pJ.pix.apis.commands.compartilhados.WebhookAutorizacao

Nome Tipo Descrição Tamanho Requerido
valor string   - Não
tipo enum none, basic, bearer - Não

TipoEventoWebhook

bs2.pJ.pix.compartilhados.enums.TipoEventoWebhook

Nome Tipo Descrição Tamanho Requerido
bs2.pJ.pix.compartilhados.enums.TipoEventoWebhook string   -  

InscricaoParaConfigurar

bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.empresas.webhook.inscricao.configurar.InscricaoParaConfigurar

Nome Tipo Descrição Tamanho Requerido
webhookUrl string   - 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