Introdução a API

Autenticação

Cartões para testes

Estabelecimentos

Usuários

Consumidores

Cartão

Links de pagamento

Códigos de Erro

Split de Pagamento

Produtos

Cupons de Desconto

Vendas

Assinaturas

Financeiro

Webhooks


Nesta página


Registrando um estabelecimento Comercial - Pessoa Jurídica

Para uma Pessoa Jurídica poder usar a Primefy como parceiro para processamento de pagamentos e muito mais, algumas informações sāo requeridas, conforme abaixo:

<aside> 💡 Se deseja cadastrar um estabelecimento Pessoa Física, siga esta documentaçāo.

</aside>

<aside> 💡 Os Planos estão associados à taxas comerciais e devem ser aplicados durante o cadastro do estabelecimento. O nome do Plano será informado pelo time comercial da Primefy.

</aside>

<aside> 💡 Os campos que esperam valores do tipo Base64 precisam estar corretamente convertidos e possuirem um valor de Base64 válido. É possível utilizar conversores online para esta finalidade.

</aside>

<aside> ℹ️ Saiba mais sobre baseUrl e outras informações importantes aqui.

</aside>

Passo 1: Criando o usuário/Estabelecimento

{{**baseUrl**}}/signup/

<aside> 💡 Para cadastrar um estabelecimento dentro do mesmo business, a propriedade businessId como o número do Business deve ser informada no body abaixo

</aside>

{
    "plan": "standard",
    "identificationNumber": "05356322000191",
    "name": "Enrico e Juliana Fotografias Ltda",
    "email": "[email protected]",
    "password": "P,8{j|56ip|H|Ehur8;fN32BB{O%n7|X"
}
{
    "id": 836,
    "name": "Enrico e Juliana Fotografias Ltda",
    "identificationNumber": "05356322000191",
    "email": "[email protected]",
    "status": "onboarding"
}

<aside> 💡 A partir deste ponto, todos os endpoints estão protegidos e requerem que o POST seja feito de forma autenticada. Veja aqui como gerar o token para o usuário.

</aside>

Passo 2: Detalhes sobre o estabelecimento

{{**baseUrl**}}/signup/stores/:store-id/business-details

<aside> 💡 O MCC pode ser obtido com o time comercial da Primefy

</aside>

{
		"mcc": "49",
    "companyName": "Enrico e Juliana Fotografias Ltda",
    "socialName": "Studio Bons Momentos Fotografia",    
		"encodedLogoImage": "base64EncondedFile"
}
{
    "id": 836,
    "companyName": "Enrico e Juliana Fotografias Ltda",
    "socialName": "Studio Bons Momentos Fotografia",
    "mcc": 49,
    "logoPath": "<https://preme.s3.us-east-2.amazonaws.com/logotipos/01a7afa6-a19e-4cb4-a870-0a94745fc514.png>"
}

Passo 3: Endereço

{{**baseUrl**}}/signup/stores/:store-id/address
{
    "street": "Rua da Borboleta",
    "number": "105",
    "reference": null,
    "district": "Anil",
    "zipCode": "79096819",
    "state": "MA",
    "city": "São Luís",
    "country": "BR"
}
{
    "id": 836,
    "businessId": 577,
    "identificationNumber": "05356322000191",
    "companyName": "Enrico e Juliana Fotografias Ltda",
    "socialName": "Studio Bons Momentos Fotografia",
    "name": "Studio Bons Momentos Fotografia",
    "logoPath": null,
    "email": "[email protected]",
    "phone": null,
    "address": {
        "street": "Rua da Borboleta",
        "number": "105",
        "reference": null,
        "district": "Anil",
        "city": "São Luís",
        "zipCode": "79096819",
        "state": "MA",
        "country": "BR"
    },
    "owner": null,
    "status": "onboarding",
    "createdOn": "2023-02-07T13:15:15",
    "updatedOn": "2023-02-07T13:22:43.7245768Z"
}

Passo 4: Proprietário

{{**baseUrl**}}/signup/stores/:store-id/owner-details/

<aside> 💡 Para cadastrar o proprietário, o campo identificationNumber precisa ser CPF

</aside>

{
    "fullName": "Vanessa Juliana Duarte",
    "identificationNumber": "99649185852",
    "birthdate": "1995-07-21",
    "phone": "(67) 99138-8954"
}
{
    "id": 219,
    "storeId": 836,
    "fullName": "Vanessa Juliana Duarte",
    "identificationNumber": "99649185852",
    "birthDate": "1995-07-21",
    "phone": "(67) 99138-8954"
}

Passo 5: Conta bancária

A conta bancária é requerida para que o estabelecimento seja aprovado para iniciar suas vendas. Veja neste link como criar a conta bancária.

Passo 6: Documentos

{{**baseUrl**}}/signup/stores/:store-id/documents
[
    {
        "type": "atividade",
        "encodedFile": "base64EncondedFile"
		},
    {
        "type": "residencia",
        "encodedFile": "base64EncondedFile"
		},
    {
        "type": "identificacao",
        "encodedFile": "base64EncondedFile"
		},
		{
        "type": "identificacao",
        "encodedFile": "base64EncondedFile"
		}
]
[
    {
        "storeId": 836,
        "documents": [
            {
                "type": "Atividade",
                "filePath": "<https://preme.s3.us-east-2.amazonaws.com/documentos/atividade/f4e83200-5dc6-48d8-b398-8d7e126cfbc5.png>"
            },
            {
                "type": "Residencia",
                "filePath": "<https://preme.s3.us-east-2.amazonaws.com/documentos/residencia/bf2d523d-6bdf-484c-b00a-66894033384e.png>"
            },
            {
                "type": "Identificacao",
                "filePath": "<https://preme.s3.us-east-2.amazonaws.com/documentos/identificacao/006d5cfe-6fcb-4037-8f74-7d203cdb5392.png>"
            },
						{
                "type": "Identificacao",
                "filePath": "<https://preme.s3.us-east-2.amazonaws.com/documentos/identificacao/127d5cfe-6fxb-9950-8f74-7d203rdo5392.png>"
            }
        ]
    }
]

Conteúdo Relacionado

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" width="40px" /> POST - Editar Estabelecimento

</aside>