Payment

Quando é utilizado?

Quando o usuário fecha o pedido utilizando o pagamento customizado no checkout.

❗️

Atenção!

Se houver Antifraude no fluxo, utilizar o payload Authorize.

Estrutura da chamada

{urlbase}/payment
utiliza método POST enviando os dados do carrinho + headers + pagamento para realizar a cobrança do pedido.

Modelo de Requisição da Payment

Estrutura do objeto enviado e seus dados:

JSON

{
   "id":0,
   "loja":"pagamentos",
   "chave":"fe31c0e6-b625-4772-8890-dd7a89053d05",
   "pedido":108648,
   "carrinhoId":"d1e3bf62-795b-4b77-82ac-c81867ad9c1a",
   "frete":0.00,
   "desconto":0,
   "total":300.00,
   "primeiroPedidoAssinatura":false,
   "assinatura":null,
   "usuario":{
      "nome":"Daniel Teste",
      "cpf":"79299082081",
      "cnpj":"",
      "email":"[email protected]",
      "endereco":{
         "logradouro":"Rua Encantado 860",
         "numero":"123",
         "complemento":"",
         "bairro":"Centro",
         "cep":85920970,
         "cidade":"Dez de Maio",
         "estado":"PR"
      },
      "telefone":"1194444-4444"
   },
   "produtos":[
      {
         "codigo":336661,
         "nome":"Camiseta Branca Unissex",
         "sku":"",
         "cd":1032,
         "valor":300.00,
         "quantidade":1,
         "personalizacao":[
            
         ]
      }
   ],
   "pagamento":{
      "parcelas":1,
      "valor":300.00,
      "valorCC":0.00,
      "ajuste":0.00,
      "total":300.00,
      "ip":"",
      "endereco":{
         "logradouro":"Rua Encantado 860",
         "numero":"123",
         "complemento":"",
         "bairro":"Centro",
         "cep":85920970,
         "cidade":"Dez de Maio",
         "estado":"PR"
      },
      "form":{
         "paymentMethod":"1",
         "number":"5555550000005554",
         "name":"TESTE TESTE TESTE",
         "month":"03",
         "year":"2030",
         "expiry":"03/2030",
         "cvc":"000",
         "saveCard":"false"
      }
   }
}

Campos da requisição de Payment

Campo	Tipo	Descrição	Tamanho
id	inteiro	Código identificador único do pagamento
loja	string	Nome da loja cadastrado no admin da Wake Commerce.	50 caracteres
chave	guid	Chave de identificação da transação. Essa chave é dinâmica, alterada a cada pedido.
pedido	inteiro	Código identificador do Pedido.
frete	decimal	Valor de frete do pedido. O campo pode ser zerado.	2 casas decimais
desconto	decimal	Valor de desconto do pedido. O campo pode ser zerado.	2 casas decimais
total	decimal	Valor total cobrado no pedido considerando todos os ajustes.	2 casas decimais
primeiroPedidoAssinatura	boolean	Campo destinado para primeiro pedido de uma assinatura. Deve ser "true" ou "false".
assinatura / id	inteiro	Código identificador da Assinatura cadastrada no admin da Wake Commerce.
assinatura / tipo	string	Texto que identifica o tipo de assinatura. Podem ser retornados os valores Admin, Null ou Recorrência, conforme o tipo do pedido: - Admin: para pedidos gerados a partir do admin na tela de assinaturas; - Null: para o primeiro pedido em que a assinatura será originada, o objeto assinatura será Null. Isso ocorre, pois a assinatura só é criada depois do request para API Custom; - Recorrência: pedido de assinatura.	50 caracteres
usuario / nome	string	Nome do usuário.	100 caracteres
usuario / cpf	string	CPF do usuário. Obrigatório para usuários Pessoa Física. Pode vir vazio caso o usuário seja Pessoa Jurídica.	50 caracteres
usuario / cnpj	string	CNPJ do usuário. Obrigatório para usuários Pessoa Jurídica. Pode vir vazio caso o usuário seja Pessoa Física.	50 caracteres
usuario /email	string	E-mail do usuário.	100 caracteres
usuario / endereco / logradouro	string	Logradouro / Rua / Avenida / Estrada do endereço do usuário.	500 caracteres
usuario / endereco / numero	string	Número do endereço do usuário.	50 caracteres
usuario / endereco / complemento	string	Complemento do endereço do usuário. Pode vir vazio.	250 caracteres
usuario / endereco / bairro	string	Barrio do endereço do usuário.	100 caracteres
usuario / endereco / cep	Int	CEP do endereço do usuário.
usuario / endereco / cidade	string	Cidade do endereço do usuário.	100 caracteres
usuario / endereco / estado	string	Estado do endereço do usuário.	100 caracteres
usuario / telefone	string	Telefone do usuário.	50 caracteres
produtos / codigo	inteiro	Código identificador do produto cadastrado na plataforma.	50 caracteres
produtos / nome	string	Nome do produto cadastrado na plataforma.	300 caracteres
produtos / cd	inteiro	Centro de Distribuição de origem do produto.
produtos / sku	string	SKU do produto cadastrado na plataforma.
produtos / valor	decimal	Valor do produto cadastrado na plataforma.	2 casas decimais
produtos / quantidade	inteiro	Quantidade do produtos no pedido.
produtos / personalizacao / nome	string	Nome da personalização do produto, quando o produto permitir algum tipo de personalização. Pode vir vazio.	128 caracteres
produtos / personalizacao / valor	string	Valor da personalização do produto, quando o produto permitir algum tipo de personalização. Pode vir vazio.	1024 caracteres
produtos / personalizacao / custo	decimal	Custo da personalização do produto, quando o produto permitir algum tipo de personalização. Pode vir vazio.	2 casas decimais
pagamento / parcelas	inteiro	Quantidade de parcelas do pedido em cima do valor total do pedido.
pagamento / valor	decimal	Valor total cobrado no pedido sem os descontos/ajustes de pagamentos aplicados.
pagamento / ajuste	decimal	Ajustes do pedido considerando descontos. Pode vir vazio.
pagamento / total	decimal	Valor total cobrado no pedido considerando todos os ajustes.
pagamento / ip	string	IP do dispositivo que o usuário utilizou para finalizar o pedido.
pagamento / endereco / logradouro	string	Logradouro / Rua / Avenida / Estrada do endereço de pagamento do pedido.	500 caracteres
pagamento / endereco / numero	string	Número do endereço de pagamento do pedido.	50 caracteres
pagamento / endereco / complemento	string	Complemento do endereço de pagamento do pedido. Pode vir vazio.	250 caracteres
pagamento / endereco / bairro	string	Bairro do endereço de pagamento do pedido.	100 caracteres
pagamento / endereco / cep	Int	CEP do endereço de pagamento do pedido.
pagamento / endereco / cidade	string	Cidade do endereço de pagamento do pedido.	100 caracteres
pagamento / endereco / estado	string	Estado do endereço de pagamento do pedido.	100 caracteres
pagamento / form / cpf	string	CPF utilizado no pagamento do pedido.	50 caracteres
pagamento / form / saveCard	boolean	Campo responsável por informar se o cartão utilizado no pagamento do pedido deve ser salvo para compras futuras. Deve ser "true" ou "false". Obs: Este campo só é utilizado quando utilizada a versão Completa.

Modelo do response esperado da Payment

JSON

{
  "statusId":1,
  "message":"Minha mensagem",
  "informacoesAdicionais": [
    {
      "Nome": "Teste1",
      "Valor": "Valor1"
    },
    {
      "Nome": "Teste2",
      "Valor": "Valor2"
    }						
  ]
}
{
  "statusId":2,
  "message":"Minha mensagem",
  "informacoesAdicionais": [
    {
      "nome": "Teste1",
      "valor": "Valor1"
    },
    {
      "nome": "Teste2",
      "valor": "Valor2"
    }						
  ]
}
{
  "statusId":3,
  "message":"Minha mensagem",
  "informacoesAdicionais": [
    {
      "nome": "Teste1",
      "valor": "Valor1"
    },
    {
      "nome": "Teste2",
      "valor": "Valor2"
    }						
  ]
}
{
  "statusId":4,
  "message":"Minha mensagem",
  "informacoesAdicionais": [
    {
      "nome": "Teste1",
      "valor": "Valor1"
    },
    {
      "nome": "Teste2",
      "valor": "Valor2"
    }						
  ]
}

Campos do response

Campo	Tipo	Descrição
statusId	inteiro	Informa o status da transação em tempo real. (Tabela de status informada abaixo)
message	string	Retorna a mensagem do status da transação.
informacoesAdicionais / nome	string	Retorna o nome da informação
informacoesAdicionais / valor	string	Retorna o dado da informação

Status esperados

StatusId	Nome status	Ação
1	Aguardando Pagamento	Mantém o pedido como aguardando pagamento na plataforma.
2	Não autorizado	Nega a transação. O Pop-up do checkout online é exibido na tela do usuário e a compra é bloqueada.
3	Pago	Atualiza o status do pedido para Pago na plataforma.
4	Autorizado	Atualiza o status do pedido para Autorizado na plataforma. Usado em processamento Two-steps (Autorização separada da Captura).

❗️

Atenção

Quando no response for enviado "statusId":2, que se refere a um pagamento "Não Autorizado", será exibido o pop-up do checkout online para que o comprador corrija os dados do cartão e refaça o pagamento. O retorno exibido no pop-up é padrão e o texto não pode ser personalizado.

📘

Formulário de pagamento

O formulário de pagamento deve ser enviado nos payloads payment e authorize, acesse a documentação do Formulário de Pagamento clicando aqui

🚧

Identificação do pagamento

Sugerimos concatenar o número do pedido (prop. "pedido") e o Id (prop. "id") para que sejam utilizadas como identificador do pagamento realizado.

❗️

Atenção

As mensagens enviadas no campo "mensagem" serão exibidas na tela do pedido do lojista e ficarão disponíveis no box "Ver mais", permitindo que o lojista acesse essas informações facilmente.