POST
/
v1
/
funds
curl --request POST \
  --url https://api.base39.io/v1/funds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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",
        "config": {
          "token": "<string>",
          "host": "<string>",
          "account": "<string>"
        }
      }
    },
    "flags": {
      "allowRefinancing": true,
      "allowAcquittance": true
    }
  },
  "metadata": {}
}'
{
  "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",
        "config": {
          "token": "<string>",
          "host": "<string>",
          "account": "<string>"
        }
      }
    },
    "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"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

​
base39-external-client-id
string

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

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.

​
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.

Body

application/json

Criar um fundo

​
name
string
required

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"

​
document
string
required

Documento do fundo. No Brasil, use o CNPJ.

​
status
enum<string>

Status do fundo

Available options:
active,
inactive
Example:

"active"

​
address
object

A especificação de um endereço

​
settings
object
​
metadata
object

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.

Response

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

Este objeto representa um fundo.

​
id
string

Identificador exclusivo para o objeto.

Example:

"fund_5f92f01728e009f403d8502e"

​
status
enum<string>

Status do fundo

Available options:
active,
inactive
Example:

"active"

​
name
string

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"

​
document
string

Documento do fundo. No Brasil, use o CNPJ.

​
address
object

A especificação de um endereço

​
settings
object
​
metadata
object

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.

​
createdAt
string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
updatedAt
string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
deleted
boolean
default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

​
createdBy
object
​
updatedBy
object