Abertura de conta escrow PJ
Request
ENDPOINT
/escrowMÉTODO
POSTRequest Body
{
"account_manager": {
"address": {
"street": "Av. Brigadeiro Faria Lima",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Jardim Paulistano",
"number": "2391",
"postal_code": "01452905",
"complement": "1º Andar"
},
"cnae_code": "30620610000159",
"company_statute": "ff26d5cb-b4e4-477f-9341-645d3e1d65de",
"email": "api@qitech.com.br",
"foundation_date": "2018-06-05",
"name": "Qi Tech Ltda.",
"person_type": "legal",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
}
},
"account_owner": {
"address": {
"street": "Av. Brigadeiro Faria Lima",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Jardim Paulistano",
"number": "2391",
"postal_code": "01452905",
"complement": "1º Andar"
},
"cnae_code": "30620610000159",
"company_statute": "ff26d5cb-b4e4-477f-9341-645d3e1d65de",
"email": "api@qitech.com.br",
"foundation_date": "2018-06-05",
"name": "Qi Tech Ltda.",
"person_type": "legal",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
}
},
"allowed_user": {
"email": "api@qitech.com.br",
"individual_document_number": "34651104630",
"name": "Patrícia Tereza Bernardes",
"person_type": "natural",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
}
}
}
BODY PARAMS
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
account_manager * | object | Objeto que possui pessoa responsável pelas movimentações da conta. | Objeto adress |
account_owner * | object | Objeto Dono da conta. | Objeto account_owner |
allowed_user * | object | Objeto que possui pessoa que terá acesso à conta para consultas. | Objeto allowed_user |
destination_list * | object | Lista de contas de destino, que são aquelas para onde é permitida a transferência de recursos. | Objeto destination_list |
Objeto account_manager
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
address | object | Endereço do cliente. | Objeto address |
cnae_code * | string | CNPJ (em texto, apenas números). | 14 |
company_representatives | object | Lista de representantes legais da empresa. | Objeto company_representatives |
company_statute * | string | DOCUMENT_KEY do PDF do estatuto da empresa (enviado previamente). | chave uuid |
email * | string | Email institucional da empresa. | |
foundation_date * | date | Data de abertura da empresa (formato "AAAA-MM-DD"). | |
name * | string | Razão social. | |
person_type * | string | Identificador de que o objeto enviado é uma pessoa jurídica. Deve conter SEMPRE o valor "legal" para Objeto PJ. | |
phone | string | Objeto com dados do telefone | Objeto phone |
Objeto company_representatives
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
person_type * | string | Identificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural" para Objeto PF. | 11 |
name * | string | Razão social em caso de operações PJ ou Nome da pessoa em caso de operações PF. Limitado a 100 caracteres. | 11 |
mother_name * | string | Nome da mãe da pessoa. | 11 |
birth_date * | string | Data de nascimento da pessoa (formato "AAAA-MM-DD") | 11 |
nationality * | string | Nacionalidade do cliente. Limitado a 50 caracteres. | 11 |
is_pep * | string | Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep). | 11 |
individual_document_number | string | CPF da pessoa (apenas números). | 11 |
document_identification * | string | DOCUMENT_KEY do PDF do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente) | 11 |
email * | string | Email da pessoa. | 11 |
address | string | Objeto endereço da pessoa. | 11 |
Objeto address
Este objeto, presente tanto no objeto PF quanto no objeto PJ, é um simples objeto para representar um endereço.
Campo | Descrição | Exemplo | Máx. Caracteres |
---|---|---|---|
street * | string | Rua do endereço | 10 |
state * | string | Estado do endereço (com dois caracteres maiúsculos) | 2 |
city * | string | Cidade do endereço | 10 |
neighborhood * | string | Bairro do endereço | 10 |
number * | string | Número da rua | 10 |
postal_code * | string | CEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) (apenas números) | 8 |
complement * | string | Complemento do endereço (texto livre) | 100 |
Objeto account_owner
Campo | Descrição | Exemplo | Máx. Caracteres |
---|---|---|---|
address * | string | Endereço do cliente. | Objeto address |
cnae_code * | string | CNPJ (em texto, apenas números, deve conter 14 caracteres). | 10 |
company_representatives | string | Lista de representantes legais da empresa. | 10 |
company_statute * | string | DOCUMENT_KEY do PDF do estatuto da empresa (enviado previamente). | 10 |
email * | string | Email institucional da empresa. | 10 |
foundation_date * | string | Data de abertura da empresa (formato "AAAA-MM-DD"). | 10 |
name * | string | Razão social. | 10 |
person_type * | string | Identificador de que o objeto enviado é uma pessoa jurídica. Deve conter SEMPRE o valor "legal" para Objeto PJ. | 10 |
phone * | string | Telefone do cliente. | 10 |
Objeto allowed_user
Campo | Descrição | Exemplo | Máx. Caracteres |
---|---|---|---|
email * | string | Email do usuário da conta. | 10 |
individual_document_number * | string | CPF do usuário da conta (apenas números). | 10 |
name * | string | Nome do usuário da conta. | 10 |
person_type * | string | Identificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural". | 10 |
phone | string | Objeto telefone do usuário. | Objeto phone |
Objeto destination_list
Campo | Descrição | Exemplo | Máx. Caracteres |
---|---|---|---|
account_branch * | string | Número da agência. | 3 |
account_digit * | string | Dígito verificador da conta (obrigatório caso haja). | 3 |
account_number * | string | Número da conta. | 3 |
document_number * | string | CPF ou CNPJ da pessoa (apenas números). | 3 |
financial_institutions_code_number * | string | Código COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) | 3 |
name * | string | Nome da pessoa física ou razão social da pessoa jurídica. | |
ted_account_type * | enum | Tipo da conta de destino. | Enumeradores |
Objeto phone
Campo | Descrição | Exemplo | Máx. Caracteres |
---|---|---|---|
country_code * | string | Código DDI do telefone (https://ddi.guiamais.com.br/) | 3 |
area_code * | string | Código DDD do telefone (https://ddd.guiamais.com.br/) | 2 |
number * | string | Número de telefone (apenas números) | 10 |
Response
STATUS
200Response Body
{
"data": {
"account_info": {
"account_branch": "0001",
"account_digit": "3",
"account_number": "66777",
"financial_institution_code": "329"
},
"account_manager": {
"company_representatives": [
{
"document_number": "08141163701",
"name": "Aurora Simone Catarina Nogueira"
}
],
"document_number": "09456933000162",
"name": "Kaique e Giovanna Contábil ME"
},
"account_owner": {
"company_representatives": [
{
"document_number": "38689533370",
"name": "Priscila Rayssa Barros"
},
{
"document_number": "85324558400",
"name": "Caio Bruno Dias"
}
],
"document_number": "98916615000167",
"name": "Alice e Isis Advocacia ME"
},
"allowed_transfer_account_list": [
{
"account_branch": "0001",
"account_digit": "2",
"account_number": "532312",
"document_number": "49067117153",
"financial_institution": {
"code": 341,
"ispb": 60701190,
"name": "Itaú Unibanco S.A."
},
"name": "Juan Anthony Farias"
},
{
"account_branch": "0002",
"account_digit": "9",
"account_number": "537612",
"document_number": "39063217000123",
"financial_institution": {
"code": 33,
"ispb": 90400888,
"name": "Banco Santander (Brasil) S. A."
},
"name": "Farias Advogados"
}
],
"allowed_user": {
"document_number": "13708610440",
"name": "Renato Noah Pinto"
}
},
"event_datetime": "2019-11-07 18:15:07",
"key": "61341599-790b-4236-b42f-060634eba88f",
"status": "waiting_administrator_approval",
"webhook_type": "escrow"
}
STATUS
400Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}