Introduction

Authentication

Test cards

Establishments

Users

Customers

Cards

Payment links

Error codes

Payment Split

Products

Discount Coupons

Sales

Signatures

Webhooks

Financial

On this page:

Registering a Commercial Establishment - Legal Entity

For a Legal Entity to use Primefy as a partner for payment processing and more, some information is required, as follows:

<aside> 💡 If you want to register an Individual seller establishment, follow this documentation.

</aside>

<aside> 💡 The Plans are associated with commercial rates and must be applied during the establishment registration. The Plan's name will be provided by the Primefy sales team.

</aside>

<aside> 💡 The fields that expect Base64 values must be correctly converted and have a valid Base64 value. You can use online converters for this purpose.

</aside>

<aside> ℹ️ Learn more about baseUrl and other important information here.

</aside>

Step 1: Creating the user/establishment

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

<aside> 💡 To create an establishment within the same business, the 'businessId' property, containing the Business number, must be provided in the following body:

</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> 💡 From this point on, all endpoints are protected and require the POST to be authenticated. Check here how to generate the token for the user.

</aside>

Step 2: Establishment Details

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

<aside> 💡 The MCC can be obtained from the Primefy sales team.

</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>"
}

Step 3: Address

{{**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"
}

Step 4: Owner

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

<aside> 💡 To register the owner, the identificationNumber field needs to be the 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"
}

Step 5: Bank Account

The bank account is required for the establishment to be approved to start its sales. Check this link on how to create the bank account.

Step 6: Documents

{{**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>"
            }
        ]
    }
]

Related Content

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/e1f1a43c-9175-480e-a96f-85cd302da592/PUT.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/e1f1a43c-9175-480e-a96f-85cd302da592/PUT.png" width="40px" /> PUT - Edit establishment

</aside>

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/7931da98-51f4-4f89-a6e3-51292efbfb87/POST.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/7931da98-51f4-4f89-a6e3-51292efbfb87/POST.png" width="40px" /> POST - Add a new establishment - Individual (Individual seller)

</aside>