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

Para adicionar um consumidor na API é necessário criar uma requisição com o método POST contendo campos específicos, como os descritos no exemplo da requisição abaixo. Ressaltamos que para requisição ser bem sucedida os tipos de dados de entrada devem estar de acordo com a descrição dos campos. Você pode visualizar nossa Lista de Descrição de Campos abaixo.

POST Criar consumidor

https://api.premepay.com/v1/stores/:id/customers

Lista de Parâmetros

Parâmetro Tipo Descrição Obrigatório
firstName string Primeiro nome ou Razão Social Sim
surname string Sobrenome Não
identificationNumber string CPF ou CNPJ Não
birthdate date Data de nascimento Não
email string Email Sim
phone string Telefone Não
address object Endereço Não
street string Rua Não
number string Número Não
reference string Referência Não
district string Bairro Não
city string Cidade Não
state int Estado Não
country int País Não
zipcode string CEP Não

Exemplo de requisição

Este é um exemplo de como a sua requisição para cadastrar um novo consumidor deve parecer.

Respostas

Caso a sua requisição seja bem sucedida, você irá receber o retorno do objeto do consumidor.

Conteúdo Relacionado

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/bfe6a9ef-6d9a-405e-9fbe-484666d3fb5e/PUT.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/bfe6a9ef-6d9a-405e-9fbe-484666d3fb5e/PUT.png" width="40px" /> PUT - Editar Consumidor

</aside>

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" width="40px" /> GET - Listar Consumidores

</aside>