Cartão
Saiba mais sobre os procedimentos de adicionar um cartão para o seu consumidor, como visualizar detalhes do cartão e excluir um cartão de crédito do banco de dados.

Overview

Você pode cadastrar um cartão de crédito padrão para o seu consumidor para que você possa cobrá-lo quando ele realizar compras.
Não é possível cadastrar múltiplos cartões de crédito associados ao mesmo consumidor. Caso você esteja buscando cadastrar um novo cartão de crédito ou atualizá-lo, você deve excluir o cartão de crédito atual e adicionar o novo com os novos valores.

Adicionar Cartão

https://api.premepay.com/v1/stores/{storeId}/customers/{customerId}/cards
Siga a rota para fazer a requisição e adicionar um cartão para o seu consumidor. Você vai precisar enviar a requisição contendo alguns campos obrigatórios. Abaixo, você pode visualizar nossa Lista de Descrição de Campos para Adicionar um Cartão.
Lista de Descrição de Campos para Adicionar um Cartão
Parâmetro
Tipo
Descrição
Obrigatório
holderName
string
Nome do titular
Sim
expirationMonth
integer
Mês de expiração
Sim
expirationYear
integer
Ano de expiração
Sim
cardNumber
number
Número do cartão
Sim
securityCode
string
Código de segurança
Sim
IMPORTANTE! Apenas clientes da Preme Pay que possuem certificado PCI Compliance podem armazenar dados sensíveis de pagamento de consumidores.

Exemplo de Requisição

Este é um exemplo de como a sua requisição para adicionar um cartão de crédito para seu consumidor deve parecer. É assim que você pode salvar os dados do cartão de um consumidor no nosso banco de dados.
{
"holderName": "Felipe Souza",
"expirationMonth": 2,
"expirationYear": 2022,
"cardNumber": "5201561050024014",
"securityCode": "339"
}

Respostas

201: Ok

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"id": 28378,
"brandName": "Mastercard",
"holderName": "Felipe Souza",
"expirationMonth": 2,
"expirationYear": 2022,
"firstDigits": "5201",
"lastDigits": "4014"
}

400: Bad Request

Esta é a resposta para os casos em que o servidor não processa a requisição devido a um erro encontrado. Alguns exemplos que podem resultar neste erro são uma URL digitada incorretamente, sintaxe malformada ou requisição de roteamento inválida.
{
"errors": [
{
"message": "Error description"
}
]
}

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

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 Cartão

https://api.premepay.com/v1/stores/{storeId}/customers/{customerId}/cards/{cardId}
Você consegue visualizar os detalhes do Cartão de um consumidor ao utilizar a rota mencionada acima. Estará disponível para visualização apenas os 4 primeiros e 4 últimos digitos.
Você não poderá visualizar o número completo do cartão cadastrado.

Respostas

200: Ok

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"id": 28378,
"brandName": "Mastercard",
"holderName": "Felipe Souza",
"expirationMonth": 2,
"expirationYear": 2022,
"firstDigits": "5201",
"lastDigits": "4014"
}

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": "Card not found"
}
}
500: Internal Server Error
Esta é a resposta para os casos em que ocorre um erro interno no servidor.
{
"error": {
"message": "Internal server error"
}
}

Excluir Cartão

https://api.premepay.com/v1/stores/{storeId}/customers/{customerId}/cards/{cardId}
Você pode requisitar a exclusão de um cartão utilizando a rota acima. Lembre que esta ação é irrevesível.

Respostas

200: Ok

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"message": "Card deleted"
}
400: Bad Request
Esta é a resposta para os casos em que o servidor não processa a requisição devido a um erro encontrado. Alguns exemplos que podem resultar neste erro são uma URL digitada incorretamente, sintaxe malformada ou requisição de roteamento inválida.
{
"errors": [
{
"message": "Error description"
}
]
}

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

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
Adicionar Cartão
Detalhes do Cartão
Excluir Cartão