Skip to content

Sacado Api (v1.0.0)

API Sacado

A API Sacado foi desenvolvida para oferecer um controle abrangente e eficiente sobre os dados de sacados no sistema. Com ela, é possível gerenciar todas as informações relacionadas aos sacados, incluindo cadastro, alteração, consulta e exclusão, além de funcionalidades específicas para consultas por políticas associadas.

Simplificando a gestão de dados de sacados com o poder e a flexibilidade de uma API de alta performance!

A seguir, detalhamos as principais funcionalidades oferecidas pelos endpoints.

Download OpenAPI description
api_sacados_extend.json
api_sacados_extend.yaml
Overview
rgbtec
support@rgbtec.com.br
Languages
Servers
Mock server
https://apidocs.ger26.com.br/_mock/api_sacados_extend
http://rgbsys.dyndns.info/ger2025-sacado-api-desenvolvimento

Sacados

Este conjunto de recursos permite a manipulação e consulta de dados de sacados no sistema:

  • Cadastrar Sacado:
    • Cria um novo sacado no sistema.
  • Alterar Sacado:
    • Atualiza os dados de um sacado existente pelo seu identificador.
  • Excluir Sacado:
    • Remove um sacado do sistema pelo seu identificador.
  • Listar Sacados:
    • Recupera todos os sacados com opções de filtragem por nome, tipo de pessoa, CPF/CNPJ, status ativo, datas de cadastro, políticas associadas e paginação.
  • Consultar Sacado por ID:
    • Busca um sacado específico pelo seu identificador único.
  • Listar Sacados Ativos:
    • Recupera somente os sacados que estão ativos no sistema com opções de filtragem por nome e paginação.
  • Listar Sacados por Política de Limites:
    • Recupera sacados associados a uma política de limites específica.
  • Listar Sacados por Política de Taxas:
    • Recupera sacados associados a uma política de taxas específica.
  • Listar Sacados por Política de Checagens:
    • Recupera sacados associados a uma política de checagens específica.
Operations

Listar sacados

Request

Lista todos os sacados de um tenant específico

Query
nomestring

Nome ou parte do nome ou apelido do sacado

Default null
tipoPessoastring

Tipo de pessoa

Default null
cpfCnpjstring

Cpf ou cnpj ou raiz do cnpj do sacado

Default null
ativoboolean

Indica se o sacado está ativo ou não

Default null
cadastroInicialstring(date-time)

Data da criação do sacado

Default null
cadastroFinalstring(date-time)

Data da criação do sacado

Default null
grupoEmpresarialIdstring

Id do grupo empresarial

Default null
politicaLimiteIdstring

Id da politica de limites

Default null
politicaTaxaIdstring

Id da politica de taxas

Default null
politicaChecagemIdstring

Id da politica de checagem

Default null
paginainteger(int32)

Número da páginação

Default 1
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
ordemboolean

Indica se a ordenação da coluna nome será ascendete ou nao

Default true
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_sacados_extend/api/v1/sacados?pagina=1&quantidade=10&ordem=true'

Responses

OK

Bodyapplication/jsonArray [
tipointeger(TipoPessoaEnum)required

Indica o tipo de pessoa

cpfCnpjstring or nullrequired

Cpf ou Cnpj do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

dataCadastrostring(date-time)required

Data da criação do sacado

idstring or nullrequired

Id do sacado

nomestring or nullrequired

Nome do sacado

apelidostring or nullrequired

Apelido do sacado

]
Response
application/json
[
  {
    "tipo": 0,
    "cpfCnpj": "string",
    "ativo": true,
    "dataCadastro": "2019-08-24T14:15:22Z",
    "id": "string",
    "nome": "string",
    "apelido": "string"
  }
]

Cadastrar sacado

Request

Cadastrar um sacado no sistema

Body
required
tipoPessoainteger(TipoPessoaEnum)required

Indica o tipo de pessoa

pessoaFisicaobject or null(PessoaFisicaCadastrarRequest)required

Dados da pessoa fisica

pessoaFisica.​cpfstring or nullrequired

Cpf da pessoa física

pessoaFisica.​nomestring or nullrequired

Nome da pessoa física

pessoaFisica.​identidadestring or nullrequired

Identidade da pessoa física

pessoaFisica.​emissaoIdentidadestring or null(date-time)required

Data da emissão da identidade da pessoa física

pessoaFisica.​nascimentostring or null(date-time)required

Data de nascimento da pessoa física

pessoaFisica.​sitestring or nullrequired

Site da pessa física

cnpjstring or nullrequired

Dados da pessoa jurídica

dadosBancariosArray of objects or null(PessoaInformacaoBancariaCadastrarRequest)required

Dados bancários do agente

dadosBancarios[].​tipoContainteger(TipoContaBancariaEnum)required

Tipo da conta bancária

dadosBancarios[].​bancoIdinteger(int16)required

Código do banco

dadosBancarios[].​agenciaobject or null(AgenciaCadastrarRequest)required

Informações da Agência

dadosBancarios[].​agencia.​numerostring or nullrequired

Código da agência

dadosBancarios[].​agencia.​digitostring or nullrequired

Dígito da agência

dadosBancarios[].​contaobject or null(ContaCadastrarRequest)required

Informações da Conta

dadosBancarios[].​conta.​numerostring or nullrequired

Código da conta

dadosBancarios[].​conta.​digitostring or nullrequired

Dígito da conta

dadosBancarios[].​principalbooleanrequired

Indica se é a conta principal

dadosBancarios[].​chavesPixArray of objects or null(ChavesPixCadastrarRequest)required

Array de chaves Pix

dadosBancarios[].​chavesPix[].​tipointeger(TipoChavePixEnum)required

Tipo da chave Pix

dadosBancarios[].​chavesPix[].​chavestring or nullrequired

Chave Pix

emailsArray of objects or null(PessoaEmailCadastrarRequest)required

Emails da empresa

emails[].​emailstring or nullrequired

Endereço de email

emails[].​principalbooleanrequired

Indica se é o email principal

telefonesArray of objects or null(PessoaTelefoneCadastrarRequest)required

Telefones da empresa

telefones[].​numerostring or nullrequired

Número do telefone

telefones[].​tipointeger(TipoTelefoneEnum)required

Tipo de telefone

telefones[].​principalbooleanrequired

Indica se o telefone é o principal ou não

telefones[].​whatsappbooleanrequired

Indica se o telefone recebe whatsapp ou não

telefones[].​smsbooleanrequired

Indica se o telefone recebe sms ou não

enderecosArray of objects or null(PessoaEnderecoCadastrarRequest)required

Endereços da empresa

enderecos[].​logradourostring or nullrequired

Logradouro do endereço

enderecos[].​numerostring or nullrequired

Número do endereço

enderecos[].​semNumerobooleanrequired

Indica se o endereço possui número ou não

enderecos[].​complementostring or nullrequired

Complemento do endereço

enderecos[].​cepstring or nullrequired

Cep do endereço

enderecos[].​bairrostring or nullrequired

Bairro do endereço

enderecos[].​municipiostring or nullrequired

Município do endereço

enderecos[].​ufstring or nullrequired

Uf do endereço

enderecos[].​principalbooleanrequired

Indica se é o endereço principal

politicasobject or null(PoliticasRequest)required

Políticas associadas à empresa

politicas.​limiteArray of strings or nullrequired

Array com os ids das políticas de limite

politicas.​taxaArray of strings or nullrequired

Array com os ids das políticas de taxa

politicas.​checagemArray of strings or nullrequired

Array com os ids das políticas de checagem

apelidostring or nullrequired

Apelido do sacado

observacaostring or nullrequired

Observação do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

curl -i -X POST \
  https://apidocs.ger26.com.br/_mock/api_sacados_extend/api/v1/sacados \
  -H 'Content-Type: application/json' \
  -d '{
    "tipoPessoa": 0,
    "pessoaFisica": {
      "cpf": "string",
      "nome": "string",
      "identidade": "string",
      "emissaoIdentidade": "2019-08-24T14:15:22Z",
      "nascimento": "2019-08-24T14:15:22Z",
      "site": "string"
    },
    "cnpj": "string",
    "dadosBancarios": [
      {
        "tipoConta": 0,
        "bancoId": 0,
        "agencia": {
          "numero": "string",
          "digito": "string"
        },
        "conta": {
          "numero": "string",
          "digito": "string"
        },
        "principal": true,
        "chavesPix": [
          {
            "tipo": 0,
            "chave": "string"
          }
        ]
      }
    ],
    "emails": [
      {
        "email": "string",
        "principal": true
      }
    ],
    "telefones": [
      {
        "numero": "string",
        "tipo": 0,
        "principal": true,
        "whatsapp": true,
        "sms": true
      }
    ],
    "enderecos": [
      {
        "logradouro": "string",
        "numero": "string",
        "semNumero": true,
        "complemento": "string",
        "cep": "string",
        "bairro": "string",
        "municipio": "string",
        "uf": "string",
        "principal": true
      }
    ],
    "politicas": {
      "limite": [
        "string"
      ],
      "taxa": [
        "string"
      ],
      "checagem": [
        "string"
      ]
    },
    "apelido": "string",
    "observacao": "string",
    "ativo": true
  }'

Responses

OK

Bodyapplication/json
idstring or nullrequired
Response
application/json
{
  "id": "string"
}

Listar sacados pela politica de limites

Request

Lista todos os sacados de um tenant específico pela politica de limites

Path
idstringrequired

Id da politica de limites

Default null
Query
paginainteger(int32)

Número da páginação

Default null
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
ordemboolean

Indica se a ordenação da coluna nome será ascendete ou nao

Default true
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_sacados_extend/api/v1/gerencial/politicas/limites/{id}/sacados?quantidade=10&ordem=true'

Responses

OK

Bodyapplication/jsonArray [
tipointeger(TipoPessoaEnum)required

Indica o tipo de pessoa

cpfCnpjstring or nullrequired

Cpf ou Cnpj do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

dataCadastrostring(date-time)required

Data da criação do sacado

idstring or nullrequired

Id do sacado

nomestring or nullrequired

Nome do sacado

apelidostring or nullrequired

Apelido do sacado

]
Response
application/json
[
  {
    "tipo": 0,
    "cpfCnpj": "string",
    "ativo": true,
    "dataCadastro": "2019-08-24T14:15:22Z",
    "id": "string",
    "nome": "string",
    "apelido": "string"
  }
]

Listar sacados pela politica de taxas

Request

Lista todos os sacados de um tenant específico pela politica de taxas

Path
idstringrequired

Id da politica de taxas

Default null
Query
paginainteger(int32)

Número da páginação

Default null
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
ordemboolean

Indica se a ordenação da coluna nome será ascendete ou nao

Default true
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_sacados_extend/api/v1/gerencial/politicas/taxas/{id}/sacados?quantidade=10&ordem=true'

Responses

OK

Bodyapplication/jsonArray [
tipointeger(TipoPessoaEnum)required

Indica o tipo de pessoa

cpfCnpjstring or nullrequired

Cpf ou Cnpj do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

dataCadastrostring(date-time)required

Data da criação do sacado

idstring or nullrequired

Id do sacado

nomestring or nullrequired

Nome do sacado

apelidostring or nullrequired

Apelido do sacado

]
Response
application/json
[
  {
    "tipo": 0,
    "cpfCnpj": "string",
    "ativo": true,
    "dataCadastro": "2019-08-24T14:15:22Z",
    "id": "string",
    "nome": "string",
    "apelido": "string"
  }
]

Listar sacados pela politica de checagens

Request

Lista todos os sacados de um tenant específico pela politica de checagens

Path
idstringrequired

Id da politica de checagens

Default null
Query
paginainteger(int32)

Número da páginação

Default null
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
ordemboolean

Indica se a ordenação da coluna nome será ascendete ou nao

Default true
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_sacados_extend/api/v1/gerencial/politicas/checagens/{id}/sacados?quantidade=10&ordem=true'

Responses

OK

Bodyapplication/jsonArray [
tipointeger(TipoPessoaEnum)required

Indica o tipo de pessoa

cpfCnpjstring or nullrequired

Cpf ou Cnpj do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

dataCadastrostring(date-time)required

Data da criação do sacado

idstring or nullrequired

Id do sacado

nomestring or nullrequired

Nome do sacado

apelidostring or nullrequired

Apelido do sacado

]
Response
application/json
[
  {
    "tipo": 0,
    "cpfCnpj": "string",
    "ativo": true,
    "dataCadastro": "2019-08-24T14:15:22Z",
    "id": "string",
    "nome": "string",
    "apelido": "string"
  }
]

Listar sacados ativos

Request

Lista todos os sacados ativos de um tenant específico

Query
nomestring

Nome ou parte do nome ou apelido do sacado

Default null
paginainteger(int32)

Número da páginação

Default null
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_sacados_extend/api/v1/sacados/ativos?quantidade=10'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do sacado

nomestring or nullrequired

Nome do sacado

apelidostring or nullrequired

Apelido do sacado

]
Response
application/json
[
  {
    "id": "string",
    "nome": "string",
    "apelido": "string"
  }
]

Recuperar sacado por ID

Request

Recuperar sacado do sistema por id

Path
idstringrequired
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_sacados_extend/api/v1/sacados/{id}'

Responses

OK

Bodyapplication/json
apelidostring or nullrequired

Apelido do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

observacaostring or nullrequired

Observação do sacado

pessoaFisicaobject or null(PessoaFisicaCompletoResponse)required

Dados da pessoa física

pessoaFisica.​identidadestring or nullrequired

Identidade da pessoa

pessoaFisica.​emissaoIdentidadestring or null(date-time)required

Data de emissão da identidade

pessoaFisica.​nascimentostring or null(date-time)required

Data de nascimento da pessoa

pessoaFisica.​idstring or nullrequired

Id da pessoa

pessoaFisica.​cpfstring or nullrequired

CPF da pessoa

pessoaFisica.​nomestring or nullrequired

Nome da pessoa

pessoaFisica.​sitestring or nullrequired

Site da pessoa

pessoaJuridicaobject or null(PessoaJuridicaResponse)required

Dados da pessoa jurídica

pessoaJuridica.​pessoaIdstring or nullrequired

Id único da pessoa

pessoaJuridica.​cnpjstring or nullrequired

CNPJ da pessoa jurídica

pessoaJuridica.​aberturastring or null(date-time)required

Data de abertura da pessoa jurídica

pessoaJuridica.​nomeEmpresarialstring or nullrequired

Nome empresarial da pessoa jurídica

pessoaJuridica.​nomeFantasiastring or nullrequired

Nome fantasia da pessoa jurídica

pessoaJuridica.​naturezaJuridicastring or nullrequired

Natureza jurídica da pessoa jurídica

pessoaJuridica.​situacaoCadastralobject or null(SituacaoCadastralResponse)required

Situação cadastral da pessoa jurídica

pessoaJuridica.​situacaoCadastral.​descricaostring or nullrequired

Descrição da situação cadastral

pessoaJuridica.​situacaoCadastral.​datastring or null(date-time)required

Data da situação cadastral

pessoaJuridica.​situacaoCadastral.​motivostring or nullrequired

Motivo da situação cadastral

pessoaJuridica.​inscricaoEstadualstring or nullrequired

Inscrição estadual da pessoa jurídica

pessoaJuridica.​inscricaoMunicipalstring or nullrequired

Inscrição municipal da pessoa jurídica

pessoaJuridica.​enderecoReceitaFederalobject or null(PessoaEnderecoReceitaFederalResponse)required

Endereço da Receita Federal da pessoa jurídica

pessoaJuridica.​enderecoReceitaFederal.​logradourostring or nullrequired

Endereço da pessoa

pessoaJuridica.​enderecoReceitaFederal.​numerostring or nullrequired

Número do endereço da pessoa

pessoaJuridica.​enderecoReceitaFederal.​semNumeroboolean or nullrequired

Indica se o endereço não possui número

pessoaJuridica.​enderecoReceitaFederal.​complementostring or nullrequired

Complemento do endereço da pessoa

pessoaJuridica.​enderecoReceitaFederal.​cepstring or nullrequired

CEP do endereço da pessoa

pessoaJuridica.​enderecoReceitaFederal.​bairrostring or nullrequired

Bairro do endereço da pessoa

pessoaJuridica.​enderecoReceitaFederal.​municipiostring or nullrequired

Município do endereço da pessoa

pessoaJuridica.​enderecoReceitaFederal.​ufstring or nullrequired

UF do endereço da pessoa

pessoaJuridica.​matrizboolean or nullrequired

Indica se a pessoa jurídica é matriz

pessoaJuridica.​nirestring or nullrequired

Número de Inscrição do Registro de Empresas (NIRE) da pessoa jurídica

pessoaJuridica.​sitestring or nullrequired

Site da pessoa jurídica

pessoaJuridica.​tipoRegimeTributariostring or nullrequired

Tipo de regime tributário da pessoa jurídica

pessoaJuridica.​tipoPessoaJuridicastring or nullrequired

Tipo de pessoa jurídica

pessoaJuridica.​registroJuntaComercialstring or nullrequired

Registro na Junta Comercial da pessoa jurídica

pessoaJuridica.​cnaesArray of objects or null(PessoaJuridicaCnaeResponse)required

CNAEs da pessoa jurídica

pessoaJuridica.​cnaes[].​subClassestring or nullrequired

Identificador do CNAE da pessoa jurídica

pessoaJuridica.​cnaes[].​descricaostring or nullrequired

Descrição do CNAE da pessoa jurídica

pessoaJuridica.​cnaes[].​principalbooleanrequired

Indica se o CNAE da pessoa jurídica é o principal ou não

pessoaJuridica.​ultimaAtualizacaoReceitaFederalstring or null(date-time)required

Data da última atualização na Receita Federal

pessoaJuridica.​statusSincronizacaointeger or null(NullableOfStatusAtuallizacaoPessoaJuridicaEnum)required

Status da última sincronização de dados

pessoaJuridica.​mensagemErroSincronizacaostring or nullrequired

Mensagem de erro da última sincronização de dados

informacoesBancariasArray of objects or null(PessoaInformacaoBancariaResponse)required
informacoesBancarias[].​idstring or nullrequired

Identificador único da informação bancária

informacoesBancarias[].​tipoContainteger(TipoContaBancariaEnum)required

Tipo da conta bancária

informacoesBancarias[].​bancoobject or null(BancoResponse)required

Informações do banco

informacoesBancarias[].​banco.​idinteger(int16)required

Identificador único do banco

informacoesBancarias[].​banco.​nomestring or nullrequired

Nome do banco

informacoesBancarias[].​agenciaobject or null(AgenciaResponse)required

Informações da agência

informacoesBancarias[].​agencia.​numerostring or nullrequired

Número da agência

informacoesBancarias[].​agencia.​digitostring or nullrequired

Dígito verificador da agência

informacoesBancarias[].​contaobject or null(ContaResponse)required

Informações da conta

informacoesBancarias[].​conta.​numerostring or nullrequired

Número da conta

informacoesBancarias[].​conta.​digitostring or nullrequired

Dígito verificador da conta

informacoesBancarias[].​principalbooleanrequired

Indica se esta é a conta bancária principal

informacoesBancarias[].​chavesPixArray of objects or null(ChavePix)required

Lista de chaves PIX associadas à conta

informacoesBancarias[].​chavesPix[].​idstring or nullrequired

Identificador único da chave pix

informacoesBancarias[].​chavesPix[].​tipointeger(TipoChavePixEnum2)required

Tipo da chave PIX (CPF, CNPJ, E-mail, Telefone, Aleatória)

informacoesBancarias[].​chavesPix[].​chavestring or nullrequired

Valor da chave PIX

emailsArray of objects or null(PessoaEmailResponse)required
emails[].​idstring or nullrequired

Id do email

emails[].​emailstring or nullrequired

Email

emails[].​principalbooleanrequired

Indica se é o email principal

telefonesArray of objects or null(PessoaTelefoneResponse)required
telefones[].​idstring or nullrequired

Id do telefone

telefones[].​tipointeger(TipoTelefoneEnum2)required

Tipo do telefone

telefones[].​numerostring or nullrequired

Número do telefone

telefones[].​principalbooleanrequired

Indica se é o telefone principal

telefones[].​whatsappbooleanrequired

Indica se o telefone tem WhatsApp

telefones[].​smsbooleanrequired

Indica se o telefone tem SMS

enderecosArray of objects or null(PessoaEnderecoResponse)required
enderecos[].​idstring or nullrequired

Id do endereço

enderecos[].​principalbooleanrequired

Indica se é o endereço principal

enderecos[].​logradourostring or nullrequired

Endereço da pessoa

enderecos[].​numerostring or nullrequired

Número do endereço da pessoa

enderecos[].​semNumeroboolean or nullrequired

Indica se o endereço não possui número

enderecos[].​complementostring or nullrequired

Complemento do endereço da pessoa

enderecos[].​cepstring or nullrequired

CEP do endereço da pessoa

enderecos[].​bairrostring or nullrequired

Bairro do endereço da pessoa

enderecos[].​municipiostring or nullrequired

Município do endereço da pessoa

enderecos[].​ufstring or nullrequired

UF do endereço da pessoa

Response
application/json
{
  "apelido": "string",
  "ativo": true,
  "observacao": "string",
  "pessoaFisica": {
    "identidade": "string",
    "emissaoIdentidade": "2019-08-24T14:15:22Z",
    "nascimento": "2019-08-24T14:15:22Z",
    "id": "string",
    "cpf": "string",
    "nome": "string",
    "site": "string"
  },
  "pessoaJuridica": {
    "pessoaId": "string",
    "cnpj": "string",
    "abertura": "2019-08-24T14:15:22Z",
    "nomeEmpresarial": "string",
    "nomeFantasia": "string",
    "naturezaJuridica": "string",
    "situacaoCadastral": { … },
    "inscricaoEstadual": "string",
    "inscricaoMunicipal": "string",
    "enderecoReceitaFederal": { … },
    "matriz": true,
    "nire": "string",
    "site": "string",
    "tipoRegimeTributario": "string",
    "tipoPessoaJuridica": "string",
    "registroJuntaComercial": "string",
    "cnaes": [ … ],
    "ultimaAtualizacaoReceitaFederal": "2019-08-24T14:15:22Z",
    "statusSincronizacao": 0,
    "mensagemErroSincronizacao": "string"
  },
  "informacoesBancarias": [
    { … }
  ],
  "emails": [
    { … }
  ],
  "telefones": [
    { … }
  ],
  "enderecos": [
    { … }
  ]
}

Alterar sacado

Request

Alterar um sacado no sistema

Path
idstringrequired

Id do sacado

Body
required
pessoaFisicaobject or null(PessoaFisicaAlterarRequest)required

Dados da pessoa fisica

pessoaFisica.​pessoaIdstring or nullrequired

Id da pessoa física

pessoaFisica.​nomestring or nullrequired

Nome da pessoa física

pessoaFisica.​identidadestring or nullrequired

Identidade da pessoa física

pessoaFisica.​emissaoIdentidadestring or null(date-time)required

Data da emissão da identidade da pessoa física

pessoaFisica.​nascimentostring or null(date-time)required

Data de nascimento da pessoa física

pessoaFisica.​sitestring or nullrequired

Site da pessa física

dadosBancariosArray of objects or null(PessoaInformacaoBancariaAlterarRequest)required

Dados bancários do agente

dadosBancarios[].​idstring or nullrequired

Id da entidade pessoa informação bancaria

dadosBancarios[].​tipoContainteger(TipoContaBancariaEnum)required

Tipo da conta bancária

dadosBancarios[].​bancoIdinteger(int16)required

Código do banco

dadosBancarios[].​agenciaobject or null(AgenciaAlterarRequest)required

Informações da Agência

dadosBancarios[].​agencia.​numerostring or nullrequired

Código da agência

dadosBancarios[].​agencia.​digitostring or nullrequired

Dígito da agência

dadosBancarios[].​contaobject or null(ContaAlterarRequest)required

Informações da Conta

dadosBancarios[].​conta.​numerostring or nullrequired

Código da conta

dadosBancarios[].​conta.​digitostring or nullrequired

Dígito da conta

dadosBancarios[].​principalbooleanrequired

Indica se é a conta principal

dadosBancarios[].​chavesPixArray of objects or null(ChavesPixAlterarRequest)required

Array de chaves Pix

dadosBancarios[].​chavesPix[].​idstring or nullrequired

Id da chave Pix

dadosBancarios[].​chavesPix[].​tipointeger(TipoChavePixEnum)required

Tipo da chave Pix

dadosBancarios[].​chavesPix[].​chavestring or nullrequired

Chave Pix

emailsArray of objects or null(PessoaEmailAlterarRequest)required

Emails da empresa

emails[].​idstring or nullrequired

Id da entidade PessoaEmail

emails[].​emailstring or nullrequired

Endereço de email

emails[].​principalbooleanrequired

Indica se é o email principal

telefonesArray of objects or null(PessoaTelefoneAlterarRequest)required

Telefones da empresa

telefones[].​idstring or nullrequired

Id da entidade PessoaTelefone

telefones[].​numerostring or nullrequired

Número do telefone

telefones[].​tipointeger(TipoTelefoneEnum)required

Tipo de telefone

telefones[].​principalbooleanrequired

Indica se o telefone é o principal ou não

telefones[].​whatsappbooleanrequired

Indica se o telefone recebe whatsapp ou não

telefones[].​smsbooleanrequired

Indica se o telefone recebe sms ou não

enderecosArray of objects or null(PessoaEnderecoAlterarRequest)required

Endereços da empresa

enderecos[].​idstring or nullrequired

Id da entidade PessoaEndereco

enderecos[].​logradourostring or nullrequired

Logradouro do endereço

enderecos[].​numerostring or nullrequired

Número do endereço

enderecos[].​semNumerobooleanrequired

Indica se o endereço possui número ou não

enderecos[].​complementostring or nullrequired

Complemento do endereço

enderecos[].​cepstring or nullrequired

Cep do endereço

enderecos[].​bairrostring or nullrequired

Bairro do endereço

enderecos[].​municipiostring or nullrequired

Município do endereço

enderecos[].​ufstring or nullrequired

Uf do endereço

enderecos[].​principalbooleanrequired

Indica se é o endereço principal

politicasobject or null(PoliticasRequest)required

Políticas associadas à empresa

politicas.​limiteArray of strings or nullrequired

Array com os ids das políticas de limite

politicas.​taxaArray of strings or nullrequired

Array com os ids das políticas de taxa

politicas.​checagemArray of strings or nullrequired

Array com os ids das políticas de checagem

apelidostring or nullrequired

Apelido do sacado

observacaostring or nullrequired

Observação do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

curl -i -X PUT \
  'https://apidocs.ger26.com.br/_mock/api_sacados_extend/api/v1/sacados/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "pessoaFisica": {
      "pessoaId": "string",
      "nome": "string",
      "identidade": "string",
      "emissaoIdentidade": "2019-08-24T14:15:22Z",
      "nascimento": "2019-08-24T14:15:22Z",
      "site": "string"
    },
    "dadosBancarios": [
      {
        "id": "string",
        "tipoConta": 0,
        "bancoId": 0,
        "agencia": {
          "numero": "string",
          "digito": "string"
        },
        "conta": {
          "numero": "string",
          "digito": "string"
        },
        "principal": true,
        "chavesPix": [
          {
            "id": "string",
            "tipo": 0,
            "chave": "string"
          }
        ]
      }
    ],
    "emails": [
      {
        "id": "string",
        "email": "string",
        "principal": true
      }
    ],
    "telefones": [
      {
        "id": "string",
        "numero": "string",
        "tipo": 0,
        "principal": true,
        "whatsapp": true,
        "sms": true
      }
    ],
    "enderecos": [
      {
        "id": "string",
        "logradouro": "string",
        "numero": "string",
        "semNumero": true,
        "complemento": "string",
        "cep": "string",
        "bairro": "string",
        "municipio": "string",
        "uf": "string",
        "principal": true
      }
    ],
    "politicas": {
      "limite": [
        "string"
      ],
      "taxa": [
        "string"
      ],
      "checagem": [
        "string"
      ]
    },
    "apelido": "string",
    "observacao": "string",
    "ativo": true
  }'

Responses

OK

Bodyapplication/json
idstring or nullrequired
Response
application/json
{
  "id": "string"
}

Excluir sacado

Request

Excluir um sacado no sistema

Path
idstringrequired

Id do sacado

Body
required
object(TenantSacadoExcluirRequest)
curl -i -X DELETE \
  'https://apidocs.ger26.com.br/_mock/api_sacados_extend/api/v1/sacados/{id}' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
Response
application/json
null

Politicas Checagens

Operations

Politicas Limites

Operations

Politicas Taxas

Operations