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 como Individual - Pessoal Física

Para uma Pessoa Física 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 Jurídica, 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>

{
		"businessId": 1010, // use somente para cadastrar o novo estabelecimento dentro de um business já existente
    "plan": "standard",
    "identificationNumber": "74559147922",
    "name": "Sueli Esther Moura",
    "email": "[email protected]",
    "password": "y7Kwm6TqhZ"
}
{
    "id": 705,
    "name": "Sueli Esther Moura",
    "identificationNumber": "74559147922",
    "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: Proprietário

{{**baseUrl**}}/signup/stores/:store-id/owner-details/
{
    "fullName": "Sueli Esther Moura",
    "identificationNumber": "74559147922",
    "birthdate": "2010-12-13",
    "phone": "(11) 3531-1472"
}
{
    "id": 177,
    "storeId": 705,
    "fullName": "Sueli Esther Moura",
    "identificationNumber": "74559147922",
    "birthDate": "2010-12-13",
    "phone": "(11) 3531-1472"
}

Passo 3: 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": "107",
    "companyName": "Sueli Esther Moura 74559147922",
    "socialName": "Quick Wash Lava-Rapido",
    "encodedLogoImage": "base64EncondedFile"
}
{
    "id": 704,
    "companyName": "Sueli Esther Moura 74559147922",
    "socialName": "Quick Wash Lava-Rapido",
    "mcc": 107,
    "logoPath": "<https://preme.s3.us-east-2.amazonaws.com/logotipos/01a7afa6-a19e-4cb4-a870-0a94745fc514.png>"
}

Passo 4: Endereço

{{**baseUrl**}}/signup/stores/:store-id/address
{
    "street": "Alberto Santos Dummond",
    "number": 124,
    "reference": null,
    "district": "São José",
    "zipCode": "14800000",
    "state": "SP",
    "city": "São Paulo",
    "country": "BR"
}
{
    "id": 705,
    "businessId": 453,
    "identificationNumber": "74559147922",
    "companyName": "Sueli Esther Moura 74559147922",
    "socialName": "Quick Wash Lava-Rapido",
    "name": "Quick Wash Lava-Rapido",
    "logoPath": "<https://preme.s3.us-east-2.amazonaws.com/logotipos/a8675258-395d-4e3d-9f52-46f21c0d64b3.png>",
    "email": "[email protected]",
    "phone": "(11) 3531-1472",
    "address": {
        "street": "Alberto Santos Dummond",
        "number": "124",
        "reference": null,
        "district": "São José",
        "city": "São Paulo",
        "zipCode": "14800000",
        "state": "SP",
        "country": "BR"
    },
    "owner": {
        "id": 177,
        "storeId": 705,
        "fullName": "Sueli Esther Moura",
        "identificationNumber": "74559147922",
        "birthDate": "12/13/2010 00:00:00",
        "phone": "(11) 3531-1472",
        "address": {
            "street": "Alberto Santos Dummond",
            "number": "124",
            "reference": null,
            "district": "São José",
            "city": "São Paulo",
            "zipCode": "14800000",
            "state": "SP",
            "country": "BR"
        }
    },
    "status": "pending",
    "createdOn": "2022-09-26T15:37:44",
    "updatedOn": "2022-09-26T15:55:26.5924684Z"
}

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": 705,
        "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>