Consumidores
O conteúdo desta sessão exemplifica como realizar novo cadastramento, listagem, atualização e exclusão de seus consumidores.

Overview

Os consumidores são os usuários dos serviços ou os compradores dos seus produtos. A API da Preme Pay permite o cadastro e a consulta de um determinado consumidor. Você deve adicionar e manter seus consumidores na API da Preme Pay para ter acesso as suas trasações e todos os detalhes que envolvem suas compras.
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.
post
https://api.premepay.com
/v1/stores/{storeId}/customers
Adicionar consumidor

Exemplo de Requisição para Adicionar Consumidor

Este é um exemplo de como a sua requisição para adicionar um consumidor deve parecer. É assim que você pode salvar os dados de um cliente no nosso banco de dados.
{
"firstName": "Felipe Gabriel",
"surname": "Souza",
"identificationNumber": "71891797808",
"birthdate": "1968-08-08",
"email": "[email protected]",
"phone": "(17) 2765-2965",
"address": {
"street": "Rua Capitão Alcides Leôncio Junqueira Franco",
"number": "780",
"zipcode": "14711304",
"reference": null,
"district": "Distrito Industrial II",
"city": "Bebedouro",
"state": 24,
"country": 0
}
}

Listar Consumidores

https://api.premepay.com/v1/stores/{storeId}/customers
Através da rota citada acima você receberá uma lista de todos os seus consumidores cadastrados. Esta é uma lista para visualização e ela está ordenada por data de criação, com os clientes mais recentes aparecendo primeiro.
Veja abaixo as respostas possíveis da API da Preme Pay para essa requisição.

Respostas

200: OK

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
[
{
"id": 10123,
"firstName": "Felipe Gabriel",
"surname": "Souza",
"cpf": "83858921505",
"birthdate": "1968-08-08",
"email": "[email protected]",
"phone": "(17) 2765-2965",
"address": {
"street": "Rua Capitão Alcides Leôncio Junqueira Franco",
"number": "780",
"zipcode": "14711304",
"reference": null,
"district": "Distrito Industrial II",
"city": "Bebedouro",
"state": 24
},
"card": {
"brandName": "Mastercard",
"holderName": "Felipe Gabriel Souza",
"expirationMonth": 10,
"expirationYear": 2020,
"firstDigits": "1234",
"lastDigits": "4321"
}
}
]

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"error": {
"message": "Unauthorized"
}
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"error": {
"message": "Forbidden"
}
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"error": {
"message": "Internal server error"
}
}

Detalhes do Consumidor

https://api.premepay.com/v1/stores/{storeId}/customers/{customerId}
Você também pode visualizar todos os detalhes de um consumidor específico. Para isso basta utilizar a rota citada acima. Veja abaixo as respostas possíveis da API da Preme Pay para essa requisição.

Respostas

200: OK

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"id": 10123,
"firstName": "Felipe Gabriel",
"surname": "Souza",
"cpf": "83858921505",
"birthdate": "1968-08-08",
"email": "[email protected]",
"phone": "(17) 2765-2965",
"address": {
"street": "Rua Capitão Alcides Leôncio Junqueira Franco",
"number": "780",
"zipcode": "14711304",
"reference": null,
"district": "Distrito Industrial II",
"city": "Bebedouro",
"state": 24
},
"card": {
"brandName": "master",
"holderName": "Felipe Gabriel Souza",
"expirationMonth": 10,
"expirationYear": 2020,
"firstDigits": "1234",
"lastDigits": "4321"
}
}

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"error": {
"message": "Unauthorized"
}
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"error": {
"message": "Forbidden"
}
}

404: Not Found

Esta é a resposta para os casos em que seu usuário não foi encontrado. Este é um código de resposta HTTP que indica que houve comunicação entre a requisição e o servidor, entretanto o servidor não conseguiu encontrar o que foi requerido.
{
"error": {
"message": "Customer not found"
}
}

422: Unprocessable Entity

Esta é a resposta para os casos em que a sintaxe da requisição está correta e o servidor entende o tipo de conteúdo requerido, mas não consegue processar as instruções. Provavelmente necessita de ajustes antes de ser submetido novamente.
{
"errors": [
{
"message": "Error description"
}
]
}

500: Internal Server Error

Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"error": {
"message": "Internal server error"
}
}
put
https://api.premepay.com
/v1/stores/{storeId}/customers/{customerId}
Atualizar consumidor

Exemplo de Requisição bem sucedida para Atualizar Consumidor

Este é um exemplo de como a sua requisição para atualizar um consumidor deve parecer. É assim que você pode atualizar todos os dados de um cliente no nosso banco de dados.
{
"firstName": "Felipe Gabriel",
"surname": "Souza",
"identificationNumber": "71891797808",
"birthdate": "1968-08-08",
"email": "[email protected]",
"phone": "(17) 2765-2965",
"address": {
"street": "Rua Capitão Alcides Leôncio Junqueira Franco",
"number": "780",
"zipcode": "14711304",
"reference": null,
"district": "Distrito Industrial II",
"city": "Bebedouro",
"state": 24,
"country": 0
}
}

Excluir Consumidor

https://api.premepay.com/v1/stores/{storeId}/customers/{customerId}
Você tem a possibilidade de excluir permanentemente as informações de um consumidor. Tenha atenção ao realizar essa requisição já que esta ação não pode ser revertida.
Ao solicitar a exclusão de um consumidor, imediatamente ele será também excluído de qualquer subscrição ou assinatura a que esteja associado.
A ação de excluir um consumidor é permanente e não pode ser revertida.

Respostas

200: Ok
Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"message": "Customer deleted"
}
401: Unauthorized
Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"error": {
"message": "Unauthorized"
}
}
403: Forbidden
Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"error": {
"message": "Forbidden"
}
}
404: Not Found
Esta é a resposta para os casos em que seu usuário não foi encontrado. Este é um código de resposta HTTP que indica que houve comunicação entre a requisição e o servidor, entretanto o servidor não conseguiu encontrar o que foi requerido.
{
"error": {
"message": "Customer not found"
}
}
422: Unprocessable Entity
Esta é a resposta para os casos em que a sintaxe da requisição está correta e o servidor entende o tipo de conteúdo requerido, mas não consegue processar as instruções.
{
"errors": [
{
"message": "Error description"
}
]
}
500: Internal Server Error
Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"error": {
"message": "Internal server error"
}
}
Copy link
Outline
Overview
post
Adicionar consumidor
Listar Consumidores
Detalhes do Consumidor
put
Atualizar consumidor
Excluir Consumidor