Geral -
bs2.pj.pix.forintegration.indireto -
Versão: 1
Geral
Autenticação
Antes de ter acesso ao ambiente de produção da API do Banco BS2 é necessário efetuar o processo de homologação em nosso ambiente de sandbox.
Para ter acesso ao ambiente de sandbox, por favor entre em contato conosco através do e-mail empresas@bs2.com
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
O token de autenticação é necessário para todas as requisições em nossas APIs. Fique atento ao tempo de expiração (em segundos) informado no retorno de sua requisição. Gerencie sua aplicação para que atualize o token antes de sua expiração conforme o fluxo a seguir.
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
O fluxo de atualização de token elimina a necessidade de informar clientId e clientSecret na obtenção de um novo token de autenticação.
Webhook - Participante Indireto
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
PUT /pix/indireto/forintegration/v1/webhook
{
"webhookUrl" : "string"
}
Parâmetros
Resposta
Webhook - Excluir
Webhook - Excluir
DELETE /pix/indireto/forintegration/v1/webhook
--curl
"DELETE" : "/pix/indireto/forintegration/v1/webhook"
Parâmetros
Não existe parâmetros!
Resposta
Webhook - Consultar
Webhook - Consultar
GET /pix/indireto/forintegration/v1/webhook
--curl
"GET" : "/pix/indireto/forintegration/v1/webhook"
{
"webhookUrl" : "string"
}
Parâmetros
Não existe parâmetros!
Resposta
DICT - Participante Indireto
Cliente - Criar
Cliente - criar
POST /pix/indireto/forintegration/v1/clientes
{
"nome" : "string" ,
"nomeFantasia" : "string" ,
"documento" : "string" ,
"tipoDocumento" : [ CPF , CNPJ ],
"ativo" : false ,
"endereco" : {
"logradouro" : "string" ,
"numero" : "string" ,
"complemento" : "string" ,
"cep" : "string" ,
"bairro" : "string" ,
"cidade" : "string" ,
"estado" : "string"
}
}
Parâmetros
Resposta
Cliente - Alterar
Cliente - alterar
PUT /pix/indireto/forintegration/v1/clientes/{clienteId}
{
"nome" : "string" ,
"nomeFantasia" : "string" ,
"documento" : "string" ,
"ativo" : false ,
"tipoDocumento" : [ CPF , CNPJ ]
}
Parâmetros
Resposta
Cliente - Remover
Cliente - remover
DELETE /pix/indireto/forintegration/v1/clientes/{clienteId}
--curl
"DELETE" : "/pix/indireto/forintegration/v1/clientes/{clienteId}"
Parâmetros
Nome
Localizado em
Descrição
Requerido
Schema
clienteId
path
Dados para geração do cliente.
Sim
string (uuid)
Resposta
Cliente - Consultar
Cliente - consultar
GET /pix/indireto/forintegration/v1/clientes
--curl
"GET" : "/pix/indireto/forintegration/v1/clientes"
{
"items" : [
{
"id" : "string" ,
"nome" : "string" ,
"nomeFantasia" : "string" ,
"documento" : "string" ,
"tipoDocumento" : [ CPF, CNPJ]
}
] ,
"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
Cliente - Consultar por id
Cliente - consultar por id
GET /pix/indireto/forintegration/v1/clientes/{clienteId}
--curl
"GET" : "/pix/indireto/forintegration/v1/clientes/{clienteId}"
{
"id" : "string" ,
"nome" : "string" ,
"nomeFantasia" : "string" ,
"dataAbertura" : "2021-2-2T22:11:58.951Z" ,
"documento" : "string" ,
"tipoDocumento" : [ CPF, CNPJ],
"ativo" : false ,
"endereco" : {
"logradouro" : "string" ,
"numero" : "string" ,
"complemento" : "string" ,
"cep" : "string" ,
"bairro" : "string" ,
"cidade" : "string" ,
"estado" : "string"
}
}
Parâmetros
Nome
Localizado em
Descrição
Requerido
Schema
clienteId
path
Identificador do cliente.
Sim
string (uuid)
Resposta
Conta bancária - Criar
Conta bancária - criar
POST /pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias
{
"agencia" : 0 ,
"numero" : 0 ,
"numeroContaLastro" : 0 ,
"dataAbertura" : "2021-2-2T22:11:58.951Z"
}
Parâmetros
Resposta
Conta bancária - Alterar
Conta bancária - alterar
PUT /pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contaBancariaId}
{
"agencia" : 0 ,
"numero" : 0 ,
"dataAbertura" : "2021-2-2T22:11:58.952Z" ,
"ativa" : false
}
Parâmetros
Resposta
Código
Descrição
200
Conta bancária alterada com sucesso.
400
Ocorreu um erro ao tentar alterar a conta bancária.
Conta bancária - Remover
Conta bancária - remover
DELETE /pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contaBancariaId}
--curl
"DELETE" : "/pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contaBancariaId}"
Parâmetros
Nome
Localizado em
Descrição
Requerido
Schema
clienteId
path
Identificador do cliente.
Sim
string (uuid)
contaBancariaId
path
Identificador da conta bancária.
Sim
string (uuid)
Resposta
Conta bancária - Consultar
Conta bancária - consultar
GET /pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias
--curl
"GET" : "/pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias"
{
"items" : [
{
"id" : "string" ,
"agencia" : 0,
"numero" : 0,
"dataAbertura" : "2021-2-2T22:11:58.952Z" ,
"tipo" : [ ContaCorrente, ContaSalario, Poupanca],
"ativa" : false
}
] ,
"pagina" : {
"qtd" : 0,
"paginaAtual" : 0,
"itensPorPagina" : 0
}
}
Parâmetros
Nome
Localizado em
Descrição
Requerido
Schema
clienteId
path
Identificador do cliente.
Sim
string (uuid)
PaginaAtual
query
Não
integer
ItensPorPagina
query
Não
integer
Resposta
Conta bancária - Consultar por id
Conta bancária - consultar por id
GET /pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contaBancariaId}
--curl
"GET" : "/pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contaBancariaId}"
{
"id" : "string" ,
"agencia" : 0,
"numero" : 0,
"dataAbertura" : "2021-2-2T22:11:58.952Z" ,
"tipo" : [ ContaCorrente, ContaSalario, Poupanca],
"ativa" : false
}
Parâmetros
Nome
Localizado em
Descrição
Requerido
Schema
clienteId
path
Identificador do cliente.
Sim
string (uuid)
contaBancariaId
path
Identificador da conta bancária.
Sim
string (uuid)
Resposta
Chave - Criar
Chave - criar
POST /pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contaBancariaId}/solicitacoes/chaves
{
"chave" : {
"apelido" : "string" ,
"valor" : "string" ,
"tipo" : [ CPF , CNPJ , PHONE , EMAIL , EVP , CHAVE_ALEATORIA ]
}
}
{
"solicitacaoId" : "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
Resposta
Chave - Remover
Chave - remover
DELETE /pix/indireto/forintegration/v1/clientes/{clienteId}/solicitacoes/chaves/{chaveId}
--curl
"DELETE" : "/pix/indireto/forintegration/v1/clientes/{clienteId}/solicitacoes/chaves/{chaveId}"
{
"solicitacaoId" : "string"
}
Parâmetros
Nome
Localizado em
Descrição
Requerido
Schema
clienteId
path
Identificador de cliente.
Sim
string (uuid)
chaveId
path
Identificador da chave.
Sim
string (uuid)
Resposta
Chave - Aprovar solicitações
Chave - aprovar solicitações
PATCH /pix/indireto/forintegration/v1/clientes/{clienteId}/solicitacoes/aprovar
{
"criacoesChaves" : "array" ,
"exclusoesChaves" : "array"
}
{
"criacoesChave" : [
{
"solicitacaoId" : "string" ,
"chaveId" : "string" ,
"aprovada" : false ,
"mensagem" : "string"
}
] ,
"exclusoesChave" : [
{
"solicitacaoId" : "string" ,
"chaveId" : "string" ,
"aprovada" : false ,
"mensagem" : "string"
}
]
}
Parâmetros
Resposta
Chave - Reprovar solicitações
Chave - reprovar solicitações
PATCH /pix/indireto/forintegration/v1/clientes/{clienteId}/solicitacoes/reprovar
{
"criacoesChaves" : "array" ,
"exclusoesChaves" : "array"
}
{
"criacoesChave" : [
{
"solicitacaoId" : "string" ,
"chaveId" : "string" ,
"aprovada" : false ,
"mensagem" : "string"
}
] ,
"exclusoesChave" : [
{
"solicitacaoId" : "string" ,
"chaveId" : "string" ,
"aprovada" : false ,
"mensagem" : "string"
}
]
}
Parâmetros
Resposta
Chave - Consultar solicitações
Chave - consultar solicitações
GET /pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contaBancariaId}/solicitacoes
--curl
"GET" : "/pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contaBancariaId}/solicitacoes"
{
"items" : [
{
"id" : "string" ,
"criacao" : "2021-2-2T22:11:58.952Z" ,
"aprovacaoEm" : "2021-2-2T22:11:58.952Z" ,
"reprovadoEm" : "2021-2-2T22:11:58.952Z" ,
"tipoChave" : "string" ,
"valorChave" : "string" ,
"tipoSolicitacao" : "string"
}
]
}
Parâmetros
Resposta
Chave - Consultar
Chave - consultar
GET /pix/indireto/forintegration/v1/clientes/{clienteId}/chaves
--curl
"GET" : "/pix/indireto/forintegration/v1/clientes/{clienteId}/chaves"
{
"items" : [
{
"id" : "string" ,
"valor" : "string" ,
"tipo" : [ CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA],
"dataCriacao" : "2021-2-2T22:11:58.952Z" ,
"contaBancaria" : {
"id" : "string" ,
"agencia" : 0,
"numero" : 0,
"tipo" : 0
} ,
"apelido" : "string" ,
"solicitante" : "string" ,
"sistemaOrigem" : "string"
}
]
}
Parâmetros
Nome
Localizado em
Descrição
Requerido
Schema
clienteId
path
Identificador do cliente.
Sim
string (uuid)
Resposta
Chave - Consultar por id
Chave - consultar por id
GET /pix/indireto/forintegration/v1/clientes/{clienteId}/chaves/{chaveId}
--curl
"GET" : "/pix/indireto/forintegration/v1/clientes/{clienteId}/chaves/{chaveId}"
{
"id" : "string" ,
"valor" : "string" ,
"tipo" : [ CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA],
"dataCriacao" : "2021-2-2T22:11:58.952Z" ,
"contaBancaria" : {
"id" : "string" ,
"agencia" : 0,
"numero" : 0,
"tipo" : 0
} ,
"apelido" : "string" ,
"solicitante" : "string" ,
"sistemaOrigem" : "string"
}
Parâmetros
Nome
Localizado em
Descrição
Requerido
Schema
clienteId
path
Identificador do cliente.
Sim
string (uuid)
chaveId
path
Identificador da chave.
Sim
string (uuid)
Resposta
Reivindicação - Iniciar
Reivindicação - iniciar
POST /pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contabancariaId}/chaves/reivindicacoes
{
"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
Resposta
Reivindicação - Consultar
Reivindicação - consultar
GET /pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contabancariaId}/chaves/reivindicacoes/reivindicador
--curl
"GET" : "/pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contabancariaId}/chaves/reivindicacoes/reivindicador"
{
"items" : [
{
"reivindicacaoId" : "string" ,
"tipo" : [ posse, portabilidade],
"status" : [ ABERTO, AGUARDANDO_RESOLUCAO, CONFIRMADO, CANCELADO, COMPLETO],
"dataFinalResolucao" : "2021-2-2T22:11:58.952Z" ,
"dataFinalEncerramento" : "2021-2-2T22:11:58.952Z" ,
"dataUltimaAtualizacao" : "2021-2-2T22:11:58.952Z" ,
"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
clienteId
path
Identificador do cliente.
Sim
string (uuid)
contaBancariaId
path
Identificador da conta bancária.
Sim
string (uuid)
PaginaAtual
query
Não
integer
ItensPorPagina
query
Não
integer
Resposta
Reivindicação - Consultar doações
Reivindicação - consultar doações
GET /pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contabancariaId}/chaves/reivindicacoes/doador
--curl
"GET" : "/pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contabancariaId}/chaves/reivindicacoes/doador"
{
"items" : [
{
"reivindicacaoId" : "string" ,
"tipo" : [ posse, portabilidade],
"status" : [ ABERTO, AGUARDANDO_RESOLUCAO, CONFIRMADO, CANCELADO, COMPLETO],
"dataFinalResolucao" : "2021-2-2T22:11:58.952Z" ,
"dataFinalEncerramento" : "2021-2-2T22:11:58.953Z" ,
"dataUltimaAtualizacao" : "2021-2-2T22:11:58.953Z" ,
"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
clienteId
path
Identificador do cliente.
Sim
string (uuid)
contaBancariaId
path
Identificador da conta bancária.
Sim
string (uuid)
PaginaAtual
query
Não
integer
ItensPorPagina
query
Não
integer
Resposta
Reivindicação - Confirmar
Reivindicação - confirmar
PATCH /pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contabancariaId}/chaves/reivindicacoes/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
Resposta
Reivindicação - Cancelar
Reivindicação - cancelar
PATCH /pix/indireto/forintegration/v1/clientes/{clienteId}/contasbancarias/{contabancariaId}/chaves/reivindicacoes/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
Resposta
Pagamentos - Participante Indireto
Pagamento - Iniciar pagamento por QR Code
Pagamento - Iniciar pagamento por QR Code
POST /pix/indireto/forintegration/v1/pagamentos/qrcodes
{
"pagador" : {
"contaBancariaId" : "string"
},
"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.963Z" ,
"apresentacao" : "2021-2-2T22:11:58.963Z" ,
"expiracao" : 0,
"vencimento" : "2021-2-2T22:11:58.963Z" ,
"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
Resposta
Pagamento - Iniciar pagamento por chave
Pagamento - Iniciar pagamento por chave
POST /pix/indireto/forintegration/v1/pagamentos/chave
{
"pagador" : {
"contaBancariaId" : "string"
},
"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
Resposta
Pagamento - Iniciar pagamento por manual
Pagamento - Iniciar pagamento por manual
POST /pix/indireto/forintegration/v1/pagamentos/manual
{
"pagador" : {
"contaBancariaId" : "string"
},
"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
Resposta
Pagamento - Confirmar
Pagamento - Confirmar
POST /pix/indireto/forintegration/v1/pagamentos/{pagamentoId}/confirmacao
{
"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
Resposta
Pagamento - Consultar
Pagamento - Consultar
GET /pix/indireto/forintegration/v1/pagamentos
--curl
"GET" : "/pix/indireto/forintegration/v1/pagamentos"
{
"items" : [
{
"pagamentoId" : "string" ,
"endToEndId" : "string" ,
"dataHoraCriacao" : "2021-2-2T22:11:58.964Z" ,
"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],
"tipo" : [ CHAVE_DICT, MANUAL, QR_CODE, LOCATION],
"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
Pagamento - Consultar por PagamentoId
Pagamento - Consultar por PagamentoId
GET /pix/indireto/forintegration/v1/pagamentos/{pagamentoId}
--curl
"GET" : "/pix/indireto/forintegration/v1/pagamentos/{pagamentoId}"
{
"qrCode" : {
"categoria" : 0,
"moeda" : 0,
"pais" : "string" ,
"cidade" : "string" ,
"txId" : "string"
} ,
"cobranca" : {
"id" : "string" ,
"calendario" : {
"criacao" : "2021-2-2T22:11:58.964Z" ,
"apresentacao" : "2021-2-2T22:11:58.964Z" ,
"expiracao" : 0,
"vencimento" : "2021-2-2T22:11:58.964Z" ,
"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"
}
} ,
"endToEndId" : "string"
}
Parâmetros
Nome
Localizado em
Descrição
Requerido
Schema
pagamentoId
path
Identificador do pagamento.
Sim
string (uuid)
Resposta
Participantes - Consultar
Participante - consultar
GET /pix/indireto/forintegration/v1/participantes
--curl
"GET" : "/pix/indireto/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
Recebimentos - Participante Indireto
Cobrança estática - Criar
Cobrança Estático - Criar
POST /pix/indireto/forintegration/v1/qrcodes/estatico
{
"chave" : "string" ,
"valor" : 0 ,
"campoLivre" : "string" ,
"txId" : "string"
}
{
"qrCodeId" : "string" ,
"qrCode" : "string" ,
"dataCriacao" : "2021-2-2T22:11:58.977Z"
}
Parâmetros
Resposta
Cobrança dinâmica - Criar
Cobrança dinâmica - Criar
PUT /pix/indireto/forintegration/v1/cob/{txId}
{
"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.977Z"
} ,
"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
Resposta
Cobrança - Revisar
Cobrança - Revisar
PATCH /pix/indireto/forintegration/v1/cob/{txId}
{
"calendario" : {
"expiracao" : 0
},
"status" : [ ATIVA , CONCLUIDA , REMOVIDA_PELO_USUARIO_RECEBEDOR , REMOVIDA_PELO_PSP ],
"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.978Z"
} ,
"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
Resposta
Cobrança - Consultar por TxId
Cobrança - Consultar por TxId
GET /pix/indireto/forintegration/v1/cob/{txId}
--curl
"GET" : "/pix/indireto/forintegration/v1/cob/{txId}"
{
"calendario" : {
"expiracao" : 0,
"criacao" : "2021-2-2T22:11:58.978Z"
} ,
"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.978Z" ,
"pagador" : {
"cpf" : "string" ,
"cnpj" : "string" ,
"nome" : "string"
} ,
"infoPagador" : "string" ,
"devolucoes" : [
{
"id" : "string" ,
"rtrId" : "string" ,
"valor" : 0,
"horario" : {
"solicitacao" : "2021-2-2T22:11:58.978Z" ,
"liquidacao" : "2021-2-2T22:11:58.978Z"
} ,
"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
x-contaBancariaId
header
Identificador da conta bancaria do recebedor.
Sim
string($uuid)
Resposta
Cobrança - Consultar
Cobrança - Consultar
GET /pix/indireto/forintegration/v1/cob
--curl
"GET" : "/pix/indireto/forintegration/v1/cob"
{
"parametros" : {
"inicio" : "2021-2-2T22:11:58.978Z" ,
"fim" : "2021-2-2T22:11:58.978Z" ,
"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.978Z"
} ,
"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.978Z" ,
"pagador" : {
"cpf" : "string" ,
"cnpj" : "string" ,
"nome" : "string"
} ,
"infoPagador" : "string" ,
"devolucoes" : [
{
"id" : "string" ,
"rtrId" : "string" ,
"valor" : 0,
"horario" : {
"solicitacao" : "2021-2-2T22:11:58.978Z" ,
"liquidacao" : "2021-2-2T22:11:58.978Z"
} ,
"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
x-contaBancariaId
header
Identificador da conta bancaria do recebedor.
Sim
string($uuid)
Resposta
Recebimento - Consultar
Recebimento - Consultar
GET /pix/indireto/forintegration/v1/recebimentos
--curl
"GET" : "/pix/indireto/forintegration/v1/recebimentos"
{
"items" : [
{
"endToEndId" : "string" ,
"recebimentoId" : 0,
"identificadorTransacao" : "string" ,
"data" : "2021-2-2T22:11:58.978Z" ,
"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.978Z" ,
"liquidacao" : "2021-2-2T22:11:58.978Z"
} ,
"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
x-contaBancariaId
header
Identificador da conta bancaria do recebedor.
Sim
string($uuid)
Resposta
Recebimento - Consultar por RecebimentoId
Recebimento - Consultar por RecebimentoId
GET /pix/indireto/forintegration/v1/recebimentos/{recebimentoId}
--curl
"GET" : "/pix/indireto/forintegration/v1/recebimentos/{recebimentoId}"
{
"recebimentoId" : 0,
"identificadorTransacao" : "string" ,
"data" : "2021-2-2T22:11:58.978Z" ,
"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.978Z" ,
"liquidacao" : "2021-2-2T22:11:58.978Z"
} ,
"status" : [ EM_PROCESSAMENTO, DEVOLVIDO, NAO_REALIZADO],
"motivo" : "string"
}
]
}
Parâmetros
Nome
Localizado em
Descrição
Requerido
Schema
recebimentoId
path
Identificador de Recebimento.
Sim
long
x-contaBancariaId
header
Identificador da conta bancaria do recebedor.
Sim
string($uuid)
Resposta
Devoluções - Participante Indireto
Devolução - Solicitar por e2eid e idExterno
Devolução - Solicitar por e2eid e idExterno
PUT /pix/indireto/forintegration/v1/pix/{e2eid}/devolucao/{idExterno}
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
x-contaBancariaId
header
Identificador da conta bancaria do recebedor.
Sim
string($uuid)
Resposta
Devolução - Consultar por e2eid e idExterno
Devolução - Consultar por e2eid e idExterno
GET /pix/indireto/forintegration/v1/pix/{e2eid}/devolucao/{idExterno}
--curl
"GET" : "/pix/indireto/forintegration/v1/pix/{e2eid}/devolucao/{idExterno}"
{
"id" : "string" ,
"rtrId" : "string" ,
"valor" : 0,
"horario" : {
"solicitacao" : "2021-2-2T22:11:58.996Z" ,
"liquidacao" : "2021-2-2T22:11:58.996Z"
} ,
"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
x-contaBancariaId
header
Identificador da conta bancaria do recebedor.
Sim
string($uuid)
Resposta
Recebimento - Consultar por e2eid
Recebimento - Consultar por e2eid
GET /pix/indireto/forintegration/v1/pix/{e2eid}
--curl
"GET" : "/pix/indireto/forintegration/v1/pix/{e2eid}"
{
"endToEndId" : "string" ,
"txid" : "string" ,
"valor" : "string" ,
"horario" : "2021-2-2T22:11:58.996Z" ,
"pagador" : {
"cpf" : "string" ,
"cnpj" : "string" ,
"nome" : "string"
} ,
"infoPagador" : "string" ,
"devolucoes" : [
{
"id" : "string" ,
"rtrId" : "string" ,
"valor" : "string" ,
"horario" : {
"solicitacao" : "2021-2-2T22:11:58.996Z" ,
"liquidacao" : "2021-2-2T22:11:58.996Z"
} ,
"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
x-contaBancariaId
header
Identificador da conta bancaria do recebedor.
Sim
string($uuid)
Resposta
Recebimento - Consultar
Recebimento - Consultar
GET /pix/indireto/forintegration/v1/pix
--curl
"GET" : "/pix/indireto/forintegration/v1/pix"
{
"parametros" : {
"inicio" : "2021-2-2T22:11:58.997Z" ,
"fim" : "2021-2-2T22:11:58.997Z" ,
"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.997Z" ,
"data" : "2021-2-2T22:11:58.997Z" ,
"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.997Z" ,
"liquidacao" : "2021-2-2T22:11:58.997Z"
} ,
"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
x-contaBancariaId
header
Identificador da conta bancaria do recebedor.
Sim
string($uuid)
Resposta
Models
RetiradaParaRealizar
bs2.pJ.pix.apis.commands.forIntegration.indireto.empresas.contaLastro.realizarRetirada.RetiradaParaRealizar
Nome
Tipo
Descrição
Tamanho
Requerido
valor
double
-
Não
identificacaoExtrato
string
-
Não
OperacaoRealizada
bs2.pJ.pix.apis.commands.compartilhados.OperacaoRealizada
Nome
Tipo
Descrição
Tamanho
Requerido
protocolo
string
-
Não
referencia
string
-
Não
DetalheBadRequest
bs2.pJ.pix.compartilhados.responseResult.DetalheBadRequest
Nome
Tipo
Descrição
Tamanho
Requerido
tag
string
-
Não
descricao
string
-
Não
AporteParaRealizar
bs2.pJ.pix.apis.commands.forIntegration.indireto.empresas.contaLastro.realizarAporte.AporteParaRealizar
Nome
Tipo
Descrição
Tamanho
Requerido
valor
double
-
Não
identificacaoExtrato
string
-
Não
SaldoObtido
bs2.pJ.pix.apis.queries.forIntegration.indireto.empresas.contaLastro.obterSaldo.SaldoObtido
Nome
Tipo
Descrição
Tamanho
Requerido
disponivel
double
-
Não
bloqueado24Horas
double
-
Não
bloqueado48Horas
double
-
Não
bloqueadoAcima
double
-
Não
TipoMovimentacao
bs2.pJ.pix.compartilhados.enums.TipoMovimentacao
Nome
Tipo
Descrição
Tamanho
Requerido
bs2.pJ.pix.compartilhados.enums.TipoMovimentacao
string
-
Saldo
bs2.pJ.pix.compartilhados.models.contaLastro.Saldo
Nome
Tipo
Descrição
Tamanho
Requerido
dataReferencia
dateTime
-
Não
disponivel
double
-
Não
bloqueado
double
-
Não
TipoOperacao
bs2.pJ.pix.compartilhados.models.contaLastro.TipoOperacao
Nome
Tipo
Descrição
Tamanho
Requerido
bs2.pJ.pix.compartilhados.models.contaLastro.TipoOperacao
string
-
Conta
bs2.pJ.pix.compartilhados.models.contaLastro.Conta
Nome
Tipo
Descrição
Tamanho
Requerido
ispb
string
-
Não
agencia
string
-
Não
conta
string
-
Não
nome
string
-
Não
documento
string
-
Não
bs2.pJ.pix.compartilhados.models.contaLastro.HistoricoExtrato
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
bs2.pJ.pix.apis.queries.forIntegration.indireto.empresas.contaLastro.obterExtrato.ExtratoObtido
DevolucaoRequest
bs2.pj.pixRecebidos.solicitarDevolucao.DevolucaoRequest
Nome
Tipo
Descrição
Tamanho
Requerido
valor
double
-
Não
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
ConsultarDevolucaoResponse
bs2.pj.pixRecebidos.consultarDevolucao.ConsultarDevolucaoResponse
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
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
ConsultaPixRecebidosPix
bs2.pJ.pix.compartilhados.models.pixRecebidos.ConsultaPixRecebidosPix
ConsultarPixRecebidosResponse
bs2.pj.pixRecebidos.consultarPixRecebidos.ConsultarPixRecebidosResponse
ConsultarPixResponse
bs2.pj.pixRecebidos.consultarPix.ConsultarPixResponse
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
SolicitacaoCriada
bs2.pj.compartilhados.SolicitacaoCriada
Nome
Tipo
Descrição
Tamanho
Requerido
solicitacaoId
string (uuid)
-
Não
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.indireto.dict.solicitacoes.solicitarCriacaoChave.Chave
Nome
Tipo
Descrição
Tamanho
Requerido
apelido
string
-
Não
valor
string
-
Não
tipo
enum
CPF, CNPJ, PHONE, EMAIL, EVP, CHAVE_ALEATORIA
-
Não
SolicitacaoParaCriar
bs2.pJ.pix.apis.commands.forIntegration.indireto.dict.solicitacoes.solicitarCriacaoChave.SolicitacaoParaCriar
SolicitacoesParaReprovar
bs2.pJ.pix.apis.commands.forIntegration.indireto.dict.solicitacoes.reprovarSolicitacoes.SolicitacoesParaReprovar
Nome
Tipo
Descrição
Tamanho
Requerido
criacoesChaves
[ string (uuid) ]
-
Não
exclusoesChaves
[ string (uuid) ]
-
Não
SolicitacaoProcessada
bs2.pJ.pix.apis.commands.compartilhados.SolicitacaoProcessada
Nome
Tipo
Descrição
Tamanho
Requerido
solicitacaoId
string (uuid)
-
Não
chaveId
string (uuid)
-
Não
aprovada
boolean
-
Não
mensagem
string
-
Não
SolicitacoesProcessadas
bs2.pj.compartilhados.SolicitacoesProcessadas
StatusSolicitacao
bs2.pJ.pix.apis.queries.forIntegration.indireto.dict.solicitacoes.obterSolicitacoes.StatusSolicitacao
Nome
Tipo
Descrição
Tamanho
Requerido
bs2.pJ.pix.apis.queries.forIntegration.indireto.dict.solicitacoes.obterSolicitacoes.StatusSolicitacao
string
-
Solicitacao
bs2.pJ.pix.apis.queries.forIntegration.indireto.dict.solicitacoes.obterSolicitacoes.Solicitacao
Nome
Tipo
Descrição
Tamanho
Requerido
id
string (uuid)
-
Não
criacao
dateTime
-
Não
aprovacaoEm
dateTime
-
Não
reprovadoEm
dateTime
-
Não
tipoChave
string
-
Não
valorChave
string
-
Não
tipoSolicitacao
string
-
Não
SolicitacoesEncontradas
bs2.pj.dICT.solicitacoes.obterSolicitacoes.SolicitacoesEncontradas
SolicitacoesParaAprovar
bs2.pJ.pix.apis.commands.forIntegration.indireto.dict.solicitacoes.aprovarSolicitacoes.SolicitacoesParaAprovar
Nome
Tipo
Descrição
Tamanho
Requerido
criacoesChaves
[ string (uuid) ]
-
Não
exclusoesChaves
[ string (uuid) ]
-
Não
TipoReivindicacao
bs2.pJ.pix.domain.models.reivindicacaoAggregate.TipoReivindicacao
Nome
Tipo
Descrição
Tamanho
Requerido
bs2.pJ.pix.domain.models.reivindicacaoAggregate.TipoReivindicacao
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
ReivindicacaoCriada
bs2.pJ.pix.apis.commands.forIntegration.diretoAndIndireto.dict.reivindicacoes.solicitar.ReivindicacaoCriada
Nome
Tipo
Descrição
Tamanho
Requerido
reivindicacaoId
string (uuid)
-
Não
StatusReivindicacao
bs2.pJ.pix.domain.models.reivindicacaoAggregate.StatusReivindicacao
Nome
Tipo
Descrição
Tamanho
Requerido
bs2.pJ.pix.domain.models.reivindicacaoAggregate.StatusReivindicacao
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
ReivindicadorDoador
bs2.pJ.pix.compartilhados.models.ReivindicadorDoador
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
PaginaReivindicacoesReivindicadorEncontradas
bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.dict.reivindicacao.obterReivindicacoesReivindicador.PaginaReivindicacoesReivindicadorEncontradas
ReivindicacaoDoadorEncontrada
bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.dict.reivindicacao.obterReivindicacoesDoador.ReivindicacaoDoadorEncontrada
PaginaReivindicacoesDoadorEncontradas
bs2.pJ.pix.apis.queries.forIntegration.diretoAndIndireto.dict.reivindicacao.obterReivindicacoesDoador.PaginaReivindicacoesDoadorEncontradas
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
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
DoadorProcessado
bs2.pJ.pix.apis.commands.compartilhados.DoadorProcessado
ReivindicacoesProcessadas
bs2.pJ.pix.apis.commands.compartilhados.ReivindicacoesProcessadas
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
Endereco
bs2.pJ.pix.apis.queries.compartilhados.Endereco
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
Cliente
bs2.pJ.pix.apis.queries.forIntegration.indireto.clientes.obterClientePorId.Cliente
Nome
Tipo
Descrição
Tamanho
Requerido
id
string (uuid)
-
Não
nome
string
-
Não
nomeFantasia
string
-
Não
dataAbertura
dateTime
-
Não
documento
string
-
Não
tipoDocumento
enum
CPF, CNPJ
-
Não
ativo
boolean
-
Não
endereco
bs2.pJ.pix.apis.queries.compartilhados.Endereco
-
Não
ClienteParaAlterar
bs2.pJ.pix.apis.commands.forIntegration.indireto.clientes.alterar.ClienteParaAlterar
Nome
Tipo
Descrição
Tamanho
Requerido
nome
string
-
Não
nomeFantasia
string
-
Não
documento
string
-
Não
ativo
boolean
-
Não
tipoDocumento
enum
CPF, CNPJ
-
Não
ClienteAlterado
bs2.pJ.pix.apis.commands.forIntegration.indireto.clientes.alterar.ClienteAlterado
Nome
Tipo
Descrição
Tamanho
Requerido
id
string (uuid)
-
Não
Cliente
bs2.pJ.pix.apis.queries.forIntegration.indireto.clientes.obterClientes.Cliente
Nome
Tipo
Descrição
Tamanho
Requerido
id
string (uuid)
-
Não
nome
string
-
Não
nomeFantasia
string
-
Não
documento
string
-
Não
tipoDocumento
enum
CPF, CNPJ
-
Não
ClientesEncontrados
bs2.pJ.pix.apis.queries.forIntegration.indireto.clientes.obterClientes.ClientesEncontrados
ClienteEndereco
bs2.pJ.pix.apis.commands.forIntegration.indireto.clientes.criar.ClienteEndereco
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
ClienteParaCriar
bs2.pJ.pix.apis.commands.forIntegration.indireto.clientes.criar.ClienteParaCriar
ClienteCriado
bs2.pJ.pix.apis.commands.forIntegration.indireto.clientes.criar.ClienteCriado
Nome
Tipo
Descrição
Tamanho
Requerido
id
string (uuid)
-
Não
ClienteEndereco
bs2.pJ.pix.apis.queries.forIntegration.indireto.clientes.endereco.obter.ClienteEndereco
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
EnderecoParaAtualizar
bs2.pJ.pix.apis.commands.forIntegration.indireto.clientes.endereco.atualizar.EnderecoParaAtualizar
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
ContaBancaria
bs2.pJ.pix.apis.queries.forIntegration.indireto.clientes.contasBancarias.obterPorId.ContaBancaria
Nome
Tipo
Descrição
Tamanho
Requerido
id
string (uuid)
-
Não
agencia
integer
-
Não
numero
long
-
Não
dataAbertura
dateTime
-
Não
tipo
enum
ContaCorrente, ContaSalario, Poupanca
-
Não
ativa
boolean
-
Não
ContaBancariaClienteParaAlterar
bs2.pJ.pix.apis.commands.forIntegration.indireto.clientes.contasBancarias.alterar.ContaBancariaClienteParaAlterar
Nome
Tipo
Descrição
Tamanho
Requerido
agencia
integer
-
Não
numero
long
-
Não
dataAbertura
dateTime
-
Não
ativa
boolean
-
Não
ContaBancaria
bs2.pJ.pix.apis.queries.forIntegration.indireto.clientes.contasBancarias.obterContas.ContaBancaria
Nome
Tipo
Descrição
Tamanho
Requerido
id
string (uuid)
-
Não
agencia
integer
-
Não
numero
long
-
Não
dataAbertura
dateTime
-
Não
tipo
enum
ContaCorrente, ContaSalario, Poupanca
-
Não
ativa
boolean
-
Não
ContasBancariasEncontradas
bs2.pJ.pix.apis.queries.forIntegration.indireto.clientes.contasBancarias.obterContas.ContasBancariasEncontradas
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
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
-
PagadorRecebedor
bs2.pJ.pix.compartilhados.models.PagadorRecebedor
PagamentoEncontrado
bs2.pJ.pix.apis.queries.forIntegration.indireto.pagamentos.obterPagamentos.PagamentoEncontrado
PaginaPagamentoEncontrado
bs2.pJ.pix.apis.queries.forIntegration.indireto.pagamentos.obterPagamentos.PaginaPagamentoEncontrado
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
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
PagamentoEncontrado
bs2.pJ.pix.apis.queries.forIntegration.indireto.pagamentos.obterPagamentoPorId.PagamentoEncontrado
Pagador
bs2.pJ.pix.apis.commands.forIntegration.indireto.pagamentos.compartilhados.Pagador
Nome
Tipo
Descrição
Tamanho
Requerido
contaBancariaId
string (uuid)
-
Não
PagamentoParaIniciar
bs2.pJ.pix.apis.commands.forIntegration.indireto.pagamentos.iniciarPagamentoPorQrCode.PagamentoParaIniciar
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.indireto.pagamentos.iniciarPagamentoPorQrCode.PagamentoIniciado
PagamentoParaIniciar
bs2.pJ.pix.apis.commands.forIntegration.indireto.pagamentos.iniciarPagamentoPorChave.PagamentoParaIniciar
PagamentoIniciado
bs2.pJ.pix.apis.commands.forIntegration.indireto.pagamentos.iniciarPagamentoPorChave.PagamentoIniciado
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
PagamentoParaIniciar
bs2.pJ.pix.apis.commands.forIntegration.indireto.pagamentos.iniciarPagamentoManual.PagamentoParaIniciar
PagamentoIniciado
bs2.pJ.pix.apis.commands.forIntegration.indireto.pagamentos.iniciarPagamentoManual.PagamentoIniciado
PagamentoParaConfirmar
bs2.pJ.pix.apis.commands.forIntegration.indireto.pagamentos.confirmarPagamento.PagamentoParaConfirmar
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
Situacao
bs2.pJ.pix.compartilhados.models.Situacao
Nome
Tipo
Descrição
Tamanho
Requerido
bs2.pJ.pix.compartilhados.models.Situacao
string
-
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
RecebimentosQrCodeIdResponse
bs2.pJ.pix.apis.queries.forIntegration.indireto.recebimentos.obterRecebimentoQrCodeId.RecebimentosQrCodeIdResponse
PaginaRecebimentoEncontrados
bs2.pj.recebimentos.obterRecebimentoQrCodeId.PaginaRecebimentoEncontrados
StatusRecebimento
bs2.pJ.pix.compartilhados.models.recebimentos.StatusRecebimento
Nome
Tipo
Descrição
Tamanho
Requerido
bs2.pJ.pix.compartilhados.models.recebimentos.StatusRecebimento
string
-
ObterRecebimentosResponse
bs2.pJ.pix.apis.queries.forIntegration.indireto.recebimentos.obterRecebimentos.ObterRecebimentosResponse
PaginaRecebimentoEncontrados
bs2.pj.recebimentos.obterRecebimentos.PaginaRecebimentoEncontrados
RecebimentoEncontrados
bs2.pj.recebimentos.obterRecebimentos.RecebimentoEncontrados
RecebimentoEncontrado
bs2.pj.recebimentos.obterRecebimentos.RecebimentoEncontrado
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
qrCodeId
string
-
Não
qrCode
string
-
Não
dataCriacao
dateTime
-
Não
CalendarioCobranca
bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.CalendarioCobranca
Nome
Tipo
Descrição
Tamanho
Requerido
expiracao
integer
-
Não
criacao
dateTime
-
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
-
Não
juros
double
-
Não
multa
double
-
Não
desconto
double
-
Não
final
double
-
Não
permiteAlteracao
boolean
-
Não
InfoAdicionais
bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.InfoAdicionais
Nome
Tipo
Descrição
Tamanho
Requerido
nome
string
-
Não
valor
string
-
Não
RecebimentoParaCriar
bs2.pj.recebimentos.criarRecebimentoPorQrCodeDinamico.RecebimentoParaCriar
RecebimentoCriado
bs2.pj.recebimentos.criarRecebimentoPorQrCodeDinamico.RecebimentoCriado
CalendarioCobranca
bs2.pj.compartilhados.CalendarioCobranca
Nome
Tipo
Descrição
Tamanho
Requerido
expiracao
integer
-
Não
Valor
bs2.pj.gerenciarCobrancas.criarCobranca.Valor
Nome
Tipo
Descrição
Tamanho
Requerido
original
double
-
Sim
bs2.pJ.pix.compartilhados.models.recebimentos.DetalheInformacaoAdicional
Nome
Tipo
Descrição
Tamanho
Requerido
nome
string
-
Não
valor
string
-
Não
RevisarRequest
bs2.pj.gerenciarCobrancas.revisarCobranca.RevisarRequest
RevisarResponse
bs2.pj.gerenciarCobrancas.revisarCobranca.RevisarResponse
CobrancaRequest
bs2.pj.gerenciarCobrancas.criarCobranca.CobrancaRequest
CobrancaResponse
bs2.pj.gerenciarCobrancas.criarCobranca.CobrancaResponse
DevolucaoPixResultado
bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.DevolucaoPixResultado
PixResultado
bs2.pJ.pix.compartilhados.models.gerenciarCobrancas.PixResultado
ConsultarResponse
bs2.pj.gerenciarCobrancas.consultarCobranca.ConsultarResponse
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
ListaCobrancaResponse
bs2.pj.gerenciarCobrancas.consultarListaCobranca.ListaCobrancaResponse
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