Contexto
Neste artigo, explicamos o processo necessário para abertura de contas de pagamento na plataforma. Atualmente, a Flagship trabalha exclusivamente com contas transacionais (contas de pagamento), não sendo possível a criação de outros tipos de contas como corrente ou poupança.
A abertura de conta é realizada por meio de integração via API, utilizando o endpoint apropriado e fornecendo os dados obrigatórios conforme o tipo de cliente (Pessoa Jurídica ou Pessoa Física).
Pré-requisitos
Antes de iniciar o processo de abertura de conta, certifique-se de que:
- A empresa ou pessoa física está devidamente registrada e possui documentação válida;
- Os dados de contato (telefone e e-mail) estão atualizados;
- A requisição siga o formato JSON exigido pela API;
- Os documentos estejam corretamente convertidos em base64.
1. Como Abrir uma Conta
A solicitação de abertura de conta deve ser realizada via API, utilizando o seguinte endpoint.
▶️ Endpoint
POST /{{url}}/v1/accounts
Abaixo estão os exemplos de payload conforme o tipo de cliente, com destaque para os principais parâmetros exigidos.
Pessoa Jurídica (PJ)
Para contas empresariais, os principais parâmetros incluem:
- externalIdentifier: identificador único externo;
- clientType: deve ser "CORPORATE";
- accountType: tipo da conta, geralmente "UNLIMITED_ORDINARY";
- client: dados cadastrais da empresa (nome, CNPJ, telefone, e-mail);
- billingAddress: endereço completo da empresa;
- documents: documentação codificada em base64;
- additionalDetailsCorporate: dados da empresa e representantes legais, incluindo documentos pessoais dos representantes.
▶️ Exemplo de payload:
{
"externalIdentifier": "{{UUID}}",
"clientType": "CORPORATE",
"accountType": "UNLIMITED_ORDINARY",
"documents": [
{
"content": "{{BASE64}}",
"type": "UNKNOWN"
}
],
"client": {
"name": "Pessoa Juridica",
"taxIdentifier": {
"taxId": "{{CNPJ}}",
"country": "BRA"
},
"mobilePhone": {
"country": "BRA",
"phoneNumber": "129{{seq_telefone}}"
},
"email": "pessoajuridica.{{CNPJ}}@mp.com.br"
},
"billingAddress": {
"logradouro": "Rua Sacramento",
"numero": "15",
"complemento": "Casa",
"bairro": "Centro",
"cidade": "São José do Rio Pardo",
"estado": "SP",
"cep": "13720000",
"pais": "BRA"
},
"additionalDetailsCorporate": {
"establishmentDate": "1990-05-29",
"companyName": "Nome da Empresa",
"businessLine": 47,
"establishmentForm": 1,
"representatives": [
{
"name": "Representante {{CPF}} da PJ {{CNPJ}}",
"mother": "Nome da mae",
"birthDate": "1990-05-29",
"taxIdentifier": {
"taxId": "{{CPF}}",
"country": "BRA"
},
"mobilePhone": {
"country": "BRA",
"phoneNumber": "129{{seq_telefone}}"
},
"email": "representante.pj.{{CNPJ}}@mp.com.br",
"mailAddress": {
"logradouro": "Rua Sacramento",
"numero": "15",
"complemento": "Casa",
"bairro": "Centro",
"cidade": "São Jose do Rio Pardo",
"estado": "SP",
"cep": "13720000",
"pais": "BRA"
},
"documents": [
{
"content": "{{BASE64}}",
"type": "PICTURE"
},
{
"content": "{{BASE64}}",
"type": "CNH"
}
]
}
]
}
}
Pessoa Física (PF)
Para contas individuais, os principais parâmetros incluem:
- externalIdentifier: identificador único externo;
- clientType: deve ser "PERSON";
- accountType: tipo da conta, geralmente "UNLIMITED_ORDINARY";
- client: dados pessoais (nome, CPF, telefone, e-mail);
- billingAddress: endereço completo;
- documents: imagens do rosto e documentos de identidade (frente e verso) em base64;
- additionalDetailsPerson: dados complementares como data de nascimento e nome da mãe.
▶️ Exemplo de payload:
{
"externalIdentifier": "{{UUID}}",
"clientType": "PERSON",
"accountType": "UNLIMITED_ORDINARY",
"documents": [
{
"content": "{{BASE64}}",
"type": "PICTURE"
},
{
"content": "{{BASE64}}",
"type": "IDENTITY_FRONT"
},
{
"content": "{{BASE64}}",
"type": "IDENTITY_BACK"
}
],
"client": {
"name": "Pessoa Fisica",
"taxIdentifier": {
"taxId": "{{CPF}}",
"country": "BRA"
},
"mobilePhone": {
"country": "BRA",
"phoneNumber": "119{{seq_telefone}}"
},
"email": "pessoa_fisica{{CPF}}@meiosdepagamento.com.br"
},
"billingAddress": {
"logradouro": "MATERA",
"numero": "100",
"complemento": "MATERA",
"bairro": "MATERA",
"cidade": "São Paulo",
"estado": "SP",
"cep": "99999999",
"pais": "BRA"
},
"additionalDetailsPerson": {
"birthDate": "1990-05-18",
"mother": "NOME DA MAE"
}
}
Exemplo de Response
{
"data": {
"accountHolderId": "7707BFF8-AF98-B2B4-034D-E59F5A3D797B",
"account": {
"accountId": "AC5BD70F-56D1-753E-FDD2-ACC96ED66B40"
},
"accountStatus": "CREATING"
}
}
Após o envio da requisição, a resposta da API trará os identificadores accountHolderId, accountId e o accountStatus, inicialmente com o valor CREATING, indicando que a conta está em processo de criação.
Suporte
Para dúvidas ou acompanhamento de chamados, acesse: Portal de Suporte