Criar uma nova conta

Esse endpoint permite ao operador enviar uma solicitação para a abertura de uma nova conta escrow.

Após o processamento da requisição do operador, a nova conta ficará no status de "aguardando analise" (WAITING_ANALYSIS), até sua posterior aprovação e liberação para uso.

Parâmetros da Requisição

  • personId (string/uuid v4, obrigatório): ID de cadastro da Pessoa.

  • parties (object, obrigatório): Objeto contendo os dados das partes envolvidas.

  • tenantType (string): Tipo da estrutura onde a conta será alocada. Possíveis valores: 'default', 'prime'.

  • accountType (string): Tipo da conta. Possíveis valores: 'ESCROW', 'PAYMENT'.

Objeto "parties"
  • person (object, obrigatório): Objeto contendo os dados da Pessoa.

  • person -> id (string, obrigatório): ID de cadastro da Pessoa.

  • person -> businessType (string, obrigatório): Tipo da pessoa participante na conta. Possíveis valores aceitos: 'FUND', 'MANAGER', 'SECURITIZER', 'CONSULTANT', 'CUSTODIAN', 'ADMINISTRATOR', 'OTHERS'.

  • signContract (boolean, obrigatório): Flag para indicar se terá assinatura de contrato.

  • permissions (array, obrigatório): Lista com as permissões a serem aplicadas na conta.

Objeto "permissions"

O objeto "permissions" pode receber uma lista com as permissões a serem liberadas na conta. Possíveis valores:

  • MANAGE_USER

  • VIEW_ACCOUNT

  • CREATE_POSTING

  • REVIEW_POSTING

  • POSTING_VIEW

  • CREATE_WALLET

  • VIEW_WALLET

  • UPDATE_WALLET

  • ARCHIVE_WALLET

  • CREATE_CHARGE

  • CANCEL_CHARGE

  • VIEW_CHARGE

  • UPDATE_CHARGE

  • CREATE_APPROVED

  • CREATE_BALANCE_RETENTION

  • REMOVE_BALANCE_RETENTION

  • VIEW_BALANCE_RETENTION

  • CREATE_ACCOUNT

  • CREATE_BENEFICIARY

  • CREATE_DEPOSIT_RETENTION

  • VIEW_DEPOSIT_RETENTION

  • DELETE_DEPOSIT_RETENTION

  • UPDATE_DEPOSIT_RETENTION

Resposta

Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato:

  • id (string): ID para identificação da solicitação cadastrada.
Exemplo de JSON:
{
  "id": "<string>"
}
Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!