Pular para o conteúdo principal

Abertura de conta escrow PJ

Request

ENDPOINT
/escrow
MÉTODO
POST
Request 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

CampoTipoDescriçãoCaracteres
account_manager *objectObjeto que possui pessoa responsável pelas movimentações da conta.Objeto adress
account_owner *objectObjeto Dono da conta.Objeto account_owner
allowed_user *objectObjeto que possui pessoa que terá acesso à conta para consultas.Objeto allowed_user
destination_list *objectLista de contas de destino, que são aquelas para onde é permitida a transferência de recursos.Objeto destination_list

Objeto account_manager

CampoTipoDescriçãoCaracteres
addressobjectEndereço do cliente.Objeto address
cnae_code *stringCNPJ (em texto, apenas números).14
company_representativesobjectLista de representantes legais da empresa.Objeto company_representatives
company_statute *stringDOCUMENT_KEY do PDF do estatuto da empresa (enviado previamente).chave uuid
email *stringEmail institucional da empresa.
foundation_date *dateData de abertura da empresa (formato "AAAA-MM-DD").
name *stringRazão social.
person_type *stringIdentificador de que o objeto enviado é uma pessoa jurídica. Deve conter SEMPRE o valor "legal" para Objeto PJ.
phonestringObjeto com dados do telefoneObjeto phone

Objeto company_representatives

CampoTipoDescriçãoCaracteres
person_type *stringIdentificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural" para Objeto PF.11
name *stringRazã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 *stringNome da mãe da pessoa.11
birth_date *stringData de nascimento da pessoa (formato "AAAA-MM-DD")11
nationality *stringNacionalidade do cliente. Limitado a 50 caracteres.11
is_pep *stringDeclaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep).11
individual_document_numberstringCPF da pessoa (apenas números).11
document_identification *stringDOCUMENT_KEY do PDF do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente)11
email *stringEmail da pessoa.11
addressstringObjeto 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.

CampoDescriçãoExemploMáx. Caracteres
street *stringRua do endereço10
state *stringEstado do endereço (com dois caracteres maiúsculos)2
city *stringCidade do endereço10
neighborhood *stringBairro do endereço10
number *stringNúmero da rua10
postal_code *stringCEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) (apenas números)8
complement *stringComplemento do endereço (texto livre)100

Objeto account_owner

CampoDescriçãoExemploMáx. Caracteres
address *stringEndereço do cliente.Objeto address
cnae_code *stringCNPJ (em texto, apenas números, deve conter 14 caracteres).10
company_representativesstringLista de representantes legais da empresa.10
company_statute *stringDOCUMENT_KEY do PDF do estatuto da empresa (enviado previamente).10
email *stringEmail institucional da empresa.10
foundation_date *stringData de abertura da empresa (formato "AAAA-MM-DD").10
name *stringRazão social.10
person_type *stringIdentificador de que o objeto enviado é uma pessoa jurídica. Deve conter SEMPRE o valor "legal" para Objeto PJ.10
phone *stringTelefone do cliente.10

Objeto allowed_user

CampoDescriçãoExemploMáx. Caracteres
email *stringEmail do usuário da conta.10
individual_document_number *stringCPF do usuário da conta (apenas números).10
name *stringNome do usuário da conta.10
person_type *stringIdentificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural".10
phonestringObjeto telefone do usuário.Objeto phone

Objeto destination_list

CampoDescriçãoExemploMáx. Caracteres
account_branch *stringNúmero da agência.3
account_digit *stringDígito verificador da conta (obrigatório caso haja).3
account_number *stringNúmero da conta.3
document_number *stringCPF ou CNPJ da pessoa (apenas números).3
financial_institutions_code_number *stringCódigo COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf)3
name *stringNome da pessoa física ou razão social da pessoa jurídica.
ted_account_type *enumTipo da conta de destino.Enumeradores

Objeto phone

CampoDescriçãoExemploMáx. Caracteres
country_code *stringCódigo DDI do telefone (https://ddi.guiamais.com.br/)3
area_code *stringCódigo DDD do telefone (https://ddd.guiamais.com.br/)2
number *stringNúmero de telefone (apenas números)10

Response

STATUS
200
Response 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
400
Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}