跳到主要内容

发送投资者银行账户

简介​

本资源在注册分析中为投资者登记一个银行账户。每个账户必须通过单独的请求发送——如需登记多个账户，请多次调用该端点。

Input / Output​

作为输入，发送一个银行账户的数据。

作为输出，将返回所创建账户的密钥——bank_account_key 和 external_bank_account_key——及其 status。

适用范围
角色主机所需权限
顾问consultant-api由集成团队开通

各主机的 Base URL：环境（主机）。

Request​

ENDPOINT
/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/bank_account
MÉTODO
POST
STATUS
201

Request body​

示例：个人主账户
请求体
{
    "financial_institution_code": "341",
    "account_number": "12345678",
    "account_digit": "9",
    "account_branch": "0001",
    "main_account": true
}
示例：联名账户
请求体
{
    "financial_institution_code": "341",
    "account_number": "12345678",
    "account_digit": "9",
    "account_branch": "0001",
    "shared_account_owners": [
        {
            "name": "Maria Silva",
            "document_number": "969.698.790-03"
        }
    ]
}

Body params​

字段类型说明字符数必填
financial_institution_codestring金融机构代码（compe / 短 ISPB）1 - 4是
account_numberstring银行账号（仅数字）1 - 20是
account_digitstring账户校验位1是
account_branchstring支行编号（4 位数字）4是
main_accountboolean是否为投资者的主账户-否
shared_account_ownersarrayShared Account Owner 对象列表-否
信息

只能有一个账户标记为 main_account: true。如果没有账户被标记为主账户，则第一个登记的账户被视为主账户。

Shared Account Owners​

字段类型说明字符数必填
namestring账户共同持有人姓名-是
document_numberstring共同持有人的 CPF（XXX.XXX.XXX-XX）14是

Response​

响应体
{
    "bank_account_key": "UUID",
    "external_bank_account_key": "UUID",
    "status": "active"
}
字段类型说明
bank_account_keystring所创建银行账户的内部标识
external_bank_account_keystring在账户维护路由中使用的密钥：更新数据、更新状态和设置主账户
statusstring账户创建时的状态——始终为 active

错误​

状态代码发生情形
400IVR000018分析已不处于 pending_registry_data（已提交或已结束）
404IVR000078未知的银行代码
409IVR000077该账户已登记

认证、权限和主机相关错误：参见 API 错误。