Atualizar fundo

POST 
/v1/funds/:fund

Atualiza o fundo com os parâmetros fornecidos; os não fornecidos permanecem inalterados. Aceita quase os mesmos argumentos da criação do fundo.

Request

Path Parameters

fund stringrequired
ID do fundo
Example: fund_5f92f01728e009f403d8502e

Query Parameters

expand string
Expande as referências.
Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.
Example: data.loan
fields string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Examples:

inclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

Header Parameters

Idempotency-Key string
Chave única de idempotência para evitar duplicação de requisições.
Example: 5f92f01728e009f403d8502e
base39-external-client-id string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

application/json

Body

statusstring
Status do fundo
Possible values: [active, inactive]
Example: active
namestring
Nome do fundo. Pode ser exibido na CCB e nos itens relacionados a cobrança e pagamento. No Brasil, use a razão social.
Example: FIDIC 01
documentstring

Documento do fundo. No Brasil, use o CNPJ.

address

object

A especificação de um endereço

citystringrequired

Cidade ou distrito.

Example: São Paulo

statestringrequired

Estado, município, província ou região.

Example: SP

countrystringrequired

Código de país de duas letras (ISO 3166-1 alpha-2).

Example: BR

line1stringrequired

Linha de endereço 1 (por exemplo, rua, caixa postal).

Example: Av Paulista

line2string

Linha de endereço 2 (por exemplo, apartamento, suíte, unidade ou prédio).

Example: Sala 404

numberstringrequired

Número do endereço.

Example: 123

postalCodestringrequired

CEP ou Código postal.

Example: 12123123

neighborhoodstringrequired

Bairro.

Example: Bela Vista

settings

payments

object

Configurações de pagamento

bankAccount

object

typestringrequired

Tipo da conta bancária

Possible values: [checking, savings, salary, payment]

Example: checking

bankCodestringrequired

Código do banco

Example: 001

bankNamestring

Nome do banco

Example: Banco do Brasil

branchstringrequired

Agência

Example: 1234

numberstringrequired

Número da conta

Example: 1234567

digitstring

Dígito da conta

Example: 8

boleto

object

providerstringrequired

Provedor utilizado para os boletos

Possible values: [kobana, default, test_only]

Example: kobana

config

object

nullable

Objeto para definir a configuração para utilização do provedor de boletos

anyOf

kobana

Configuração para o provedor Kobana

tokenstringrequired

Token para realizar requisições ao provedor

hoststringrequired

Nome do host ou endereço IP ao qual se conectar

accountstringrequired

ID da carteira de cobrança

default

Configuração para o provedor padrão da Base39

object

test_only

Configuração para o provedor padrão da Base39 em ambiente SANDBOX. Apenas para testes, os boletos gerados não são oficiais.

object

flags

object

Configurações das flags do fundo.

allowRefinancingboolean

Permitir refinanciamento.

Example: true

allowAcquittanceboolean

Permitir quitação.

Example: true
metadataobject

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

Responses

201

Retorna o objeto Fund se a atualização for bem-sucedida; retorna erro se os parâmetros forem inválidos, como um documento incorreto.

application/json

Schema

Schema

idstring
Identificador exclusivo para o objeto.
Example: fund_5f92f01728e009f403d8502e
statusstring
Status do fundo
Possible values: [active, inactive]
Example: active
namestring
Nome do fundo. Pode ser exibido na CCB e nos itens relacionados a cobrança e pagamento. No Brasil, use a razão social.
Example: FIDIC 01
documentstring

Documento do fundo. No Brasil, use o CNPJ.

address

object

A especificação de um endereço

citystringrequired

Cidade ou distrito.

Example: São Paulo

statestringrequired

Estado, município, província ou região.

Example: SP

countrystringrequired

Código de país de duas letras (ISO 3166-1 alpha-2).

Example: BR

line1stringrequired

Linha de endereço 1 (por exemplo, rua, caixa postal).

Example: Av Paulista

line2string

Linha de endereço 2 (por exemplo, apartamento, suíte, unidade ou prédio).

Example: Sala 404

numberstringrequired

Número do endereço.

Example: 123

postalCodestringrequired

CEP ou Código postal.

Example: 12123123

neighborhoodstringrequired

Bairro.

Example: Bela Vista

settings

payments

object

Configurações de pagamento

bankAccount

object

typestringrequired

Tipo da conta bancária

Possible values: [checking, savings, salary, payment]

Example: checking

bankCodestringrequired

Código do banco

Example: 001

bankNamestring

Nome do banco

Example: Banco do Brasil

branchstringrequired

Agência

Example: 1234

numberstringrequired

Número da conta

Example: 1234567

digitstring

Dígito da conta

Example: 8

boleto

object

providerstringrequired

Provedor utilizado para os boletos

Possible values: [kobana, default, test_only]

Example: kobana

config

object

nullable

Objeto para definir a configuração para utilização do provedor de boletos

anyOf

kobana

Configuração para o provedor Kobana

tokenstringrequired

Token para realizar requisições ao provedor

hoststringrequired

Nome do host ou endereço IP ao qual se conectar

accountstringrequired

ID da carteira de cobrança

default

Configuração para o provedor padrão da Base39

object

test_only

Configuração para o provedor padrão da Base39 em ambiente SANDBOX. Apenas para testes, os boletos gerados não são oficiais.

object

flags

object

Configurações das flags do fundo.

allowRefinancingboolean

Permitir refinanciamento.

Example: true

allowAcquittanceboolean

Permitir quitação.

Example: true
metadataobject

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

createdAtdate-time
Data de criação do objeto
Example: 2023-08-25T22:38:41.134Z
updatedAtdate-time
Data de alteração do objeto
Example: 2023-08-25T22:38:41.134Z
deletedboolean
Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.
Default value: false
Example: false

createdBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

Example (from schema)

{
  "id": "fund_5f92f01728e009f403d8502e",
  "status": "active",
  "name": "FIDIC 01",
  "document": "string",
  "address": {
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "line1": "Av Paulista",
    "line2": "Sala 404",
    "number": "123",
    "postalCode": "12123123",
    "neighborhood": "Bela Vista"
  },
  "settings": {
    "payments": {
      "bankAccount": {
        "type": "checking",
        "bankCode": "001",
        "bankName": "Banco do Brasil",
        "branch": "1234",
        "number": "1234567",
        "digit": "8"
      },
      "boleto": {
        "provider": "kobana"
      }
    },
    "flags": {
      "allowRefinancing": true,
      "allowAcquittance": true
    }
  },
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  }
}