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": "São Paulo",
    "country": "BR",
    "line1": "Av Paulista",
    "line2": "Sala 404",
    "number": "123",
    "postalCode": "12123123",
    "neighborhood": "Bela Vista"
  },
  "settings": {
    "payments": {
      "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": "São Paulo",
    "country": "BR",
    "line1": "Av Paulista",
    "line2": "Sala 404",
    "number": "123",
    "postalCode": "12123123",
    "neighborhood": "Bela Vista"
  },
  "settings": {
    "payments": {
      "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
}

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.

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[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Body

application/json

Criar um fundo

Response

201 - application/json

Retorna o objeto Fund se a atualização for bem-sucedida. Retorna um erro se os parâmetros de criação forem inválidos (por exemplo, especificar um documento inválido).

Este objeto representa um fundo.