Criar fundo

Cria um novo fundo.

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

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

Show child attributes

address.city

string

required

Cidade ou distrito.

Example:

"São Paulo"

address.state

string

required

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

Example:

"São Paulo"

address.country

string

required

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

Example:

"BR"

address.line1

string

required

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

Example:

"Av Paulista"

address.number

string

required

Número do endereço.

Example:

"123"

address.postalCode

string

required

CEP ou Código postal.

Example:

"12123123"

address.neighborhood

string

required

Bairro.

Example:

"Bela Vista"

address.line2

string

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

Example:

"Sala 404"

settings

object

Show child attributes

settings.payments

object

Configurações de pagamento

Show child attributes

settings.payments.boleto

object

Show child attributes

settings.payments.boleto.provider

string

required

Provedor utilizado para os boletos

Example:

"kobana"

settings.payments.boleto.config

object

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

Show child attributes

settings.payments.boleto.config.token

string

required

Token para realizar requisições ao provedor

settings.payments.boleto.config.host

string

required

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

settings.payments.boleto.config.account

string

required

ID da carteira de cobrança

settings.flags

object

Configurações das flags do fundo.

Show child attributes

settings.flags.allowRefinancing

boolean

Permitir refinanciamento.

Example:

true

settings.flags.allowAcquittance

boolean

Permitir quitação.

Example:

true

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 um erro se os parâmetros de criação forem inválidos (por exemplo, especificar um documento inválido).

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

Show child attributes

address.city

string

required

Cidade ou distrito.

Example:

"São Paulo"

address.state

string

required

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

Example:

"São Paulo"

address.country

string

required

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

Example:

"BR"

address.line1

string

required

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

Example:

"Av Paulista"

address.number

string

required

Número do endereço.

Example:

"123"

address.postalCode

string

required

CEP ou Código postal.

Example:

"12123123"

address.neighborhood

string

required

Bairro.

Example:

"Bela Vista"

address.line2

string

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

Example:

"Sala 404"

settings

object

Show child attributes

settings.payments

object

Configurações de pagamento

Show child attributes

settings.payments.boleto

object

Show child attributes

settings.payments.boleto.provider

string

required

Provedor utilizado para os boletos

Example:

"kobana"

settings.payments.boleto.config

object

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

Show child attributes

settings.payments.boleto.config.token

string

required

Token para realizar requisições ao provedor

settings.payments.boleto.config.host

string

required

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

settings.payments.boleto.config.account

string

required

ID da carteira de cobrança

settings.flags

object

Configurações das flags do fundo.

Show child attributes

settings.flags.allowRefinancing

boolean

Permitir refinanciamento.

Example:

true

settings.flags.allowAcquittance

boolean

Permitir quitação.

Example:

true

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