Pular para o conteúdo principal

Cadastro de Conta Bancária do Investidor

Este endpoint permite o cadastro de conta bancária associada a um investidor previamente cadastrado.


Request

ENDPOINT
/investor_management/investor/INVESTOR-KEY/bank_account
MÉTODO
POST

Path Params

CampoTipoDescriçãoCaracteres
INVESTOR-KEYstringChave única do investidor (UUID v4).36

Request Body

Response Body
{
"account_number": "12345678",
"account_digit": "1",
"account_branch": "1234",
"financial_institution_code_number": "001",
"financial_institution_ispb": "00000000",
"account_type": "checking"
}

Request Body Params

CampoTipoDescriçãoMáximo de Caracteres
account_number *stringNúmero da conta bancária. Deve conter apenas dígitos.20
account_digit *stringDígito verificador da conta. Deve conter um único dígito.1
account_branch *stringNúmero da agência bancária. Deve conter apenas dígitos.6
financial_institution_code_numberstringCódigo da instituição financeira (3 dígitos).3
financial_institution_ispb *stringCódigo ISPB da instituição financeira (8 dígitos).8
account_type *stringTipo da conta bancária.Enumeradores account_type

Enumeradores account_type

EnumDescription
checkingConta corrente
savingsConta Poupança
salaryConta Salário
paymentConta de Pagamento

Response

STATUS
201
Response Body
{
"bank_account_key": "123e4567-e89b-12d3-a456-426614174000",
"account_number": "12345678",
"account_digit": "1",
"account_branch": "1234",
"financial_institution_code_number": "001",
"financial_institution_ispb": "00000000",
"account_type": "checking"
}

Response Body Params

CampoTipoDescriçãoMáximo de Caracteres
bank_account_keystringIdentificador único da conta bancária cadastrada (UUID v4).36
account_numberstringNúmero da conta bancária.20
account_digitstringDígito verificador da conta bancária.1
account_branchstringNúmero da agência bancária.6
financial_institution_code_numberstringCódigo da instituição financeira.3
financial_institution_ispbstringCódigo ISPB da instituição financeira.8
account_typestringTipo da conta bancária.Enumeradores account_type