(Deprecated) Versão Simplificada - Modelo de Objeto e Response

Pagamento Customizado - Versão Simplificada - Modelos de Objetos e Responses

Versão Simplificada

A versão Simplificada da URL é utilizada para pagamentos customizados simples, onde temos apenas 1 requisição e 1 modelo de response no fechamento do pedido.

Abaixo apresentamos os modelos de Requisição, com o objeto enviado, e o modelo de Response, esperado pela plataforma:

Modelo de Requisição - v1

A requisição é o objeto enviado para a URL informada no campo URL contendo todas as informações do pedido e os headers cadastrados no conector Custom.
Segue abaixo um modelo de requisição enviada pela plataforma:

Modelo de requisição

{
    "id": 189539,
    "loja": "Nome da Loja",
    "chave": "2D39FE37-611E-4015-1AF6-F62A2223B8D7",
    "pedido": 41282742,
    "frete": 13.27,
    "desconto": 0,
    "total": 130.79,
    "primeiroPedidoAssinatura": false,
    "assinatura": {
        "id": 1,
        "tipo": "recorrencia"
    },
    "usuario": {
        "nome": "nome cliente",
        "cpf": "11111111111",
        "cnpj": "",
        "email": "[email protected]",
        "endereco": {
            "logradouro": "Nunes Machado",
            "numero": "68",
            "complemento": "902",
            "bairro": "Batel",
            "cep": "80420120",
            "cidade": "Curitiba",
            "estado": "PR"
        },
        "telefone": "41999999999"
    },
    "produtos": [
        {
            "codigo": 257442,
            "nome": "Kit de Cervejas em Lata - Compre 6 e Leve 10",
            "cd":123,
            "sku": "5784545",
            "valor": 119.9,
            "quantidade": 1,
            "personalizacao": [
                {
                    "nome": "Número",
                    "valor": "12",
                    "custo": 5.0
          },
        	{
            "codigo": 257440,
            "nome": "Kit de Cervejas em Lata 2",
            "cd":321,
            "sku": "",
            "valor": 0.0,
            "quantidade": 1,
            "personalizacao": [
                {
                    "nome": "Número",
                    "valor": "",
                    "custo":
                }
            ]
        }
    ],
    "pagamento": {
        "parcelas": 2,
        "valor": 130.79,
        "ajuste": 0.0,
        "total": 130.79,
        "ip": "",
        "endereco": {
            "logradouro": "Nunes Machado",
            "numero": "68",
            "complemento": "902",
            "bairro": "Batel",
            "cep": "80420120",
            "cidade": "Curitiba",
            "estado": "PR"
        },
        "form": {
            "cpf": "111.111.111-11",
            "number": "5555 5555 5555 5555",
            "name": "nome cliente",
            "month": "1",
            "year": "2222",
            "expiry": "10/2222",
            "cvc": "222"
       }
    }
}

🚧
Objeto "form" padrão
O objeto "form" padrão é composto somente pelo CPF de forma nativa.
As demais informações devem ser inseridas via script no checkout. No exemplo acima, a aplicação responsável pela integração necessita de todos esses dados para cartão de crédito.

Modelo de Objeto "form" para Boleto e Pix
No exemplo de requisição acima, temos um formulário com informações necessárias para cartão de crédito. Porém o formulário é flexível e pode ser alterado de acordo com o método de pagamento utilizado. Segue abaixo um exemplo de "form" para Boleto:

"form": {
		"cpf": "111.111.111-11",
		"Loja": "nome da loja",
    "paymentMethod": "3"
}

Tabela de detalhamento dos campos da requisição acima:

Campo	Tipo	Obrigatoriedade	Descrição
id	inteiro	obrigatório	Código identificador do conector na base de dados da plataforma.
loja	string	obrigatório	Nome da loja cadastrado no admin da Wake Commerce.
chave	guid	obrigatório	Chave de identificação da transação. Essa chave é dinâmica, alterada a cada pedido.
pedido	inteiro	obrigatório	Código identificador do Pedido.
frete	decimal	obrigatório	Valor de frete do pedido. O campo pode ser zerado.
desconto	decimal	obrigatório	Valor de desconto do pedido. O campo pode ser zerado.
total	decimal	obrigatório	Valor total cobrado no pedido considerando todos os ajustes.
primeiroPedidoAssinatura	boolean	obrigatório	Campo destinado para primeiro pedido de uma assinatura. Deve ser "true" ou "false".
assinatura / id	inteiro	obrigatório	Código identificador da Assinatura cadastrada no admin da Wake Commerce.
assinatura / tipo	string	obrigatório	Texto que identifica o tipo de assinatura.
usuario / nome	string	obrigatório	Nome do usuário.
usuario / cpf	string	obrigatório	CPF do usuário. Obrigatório para usuários Pessoa Física. Pode vir vazio caso o usuário seja Pessoa Jurídica.
usuario / cnpj	string	obrigatório	CNPJ do usuário. Obrigatório para usuários Pessoa Jurídica. Pode vir vazio caso o usuário seja Pessoa Física.
usuario /email	string	obrigatório	E-mail do usuário.
usuario / endereco / logradouro	string	obrigatório	Logradouro / Rua / Avenida / Estrada do endereço do usuário.
usuario / endereco / numero	string	obrigatório	Número do endereço do usuário.
usuario / endereco / complemento	string	opcional	Complemento do endereço do usuário. Pode vir vazio.
usuario / endereco / bairro	string	obrigatório	Barrio do endereço do usuário.
usuario / endereco / cep	string	obrigatório	CEP do endereço do usuário.
usuario / endereco / cidade	string	obrigatório	Cidade do endereço do usuário.
usuario / endereco / estado	string	obrigatório	Estado do endereço do usuário.
usuario / telefone	string	obrigatório	Telefone do usuário.
produtos / codigo	inteiro	obrigatório	Código identificador do produto cadastrado na plataforma.
produtos / nome	string	obrigatório	Nome do produto cadastrado na plataforma.
produtos / cd	inteiro	obrigatório	Centro de Distribuição de origem do produto.
produtos / sku	string	obrigatório	SKU do produto cadastrado na plataforma.
produtos / valor	decimal	obrigatório	Valor do produto cadastrado na plataforma.
produtos / quantidade	inteiro	obrigatório	Quantidade do produtos no pedido.
produtos / personalizacao / nome	string	opcional	Nome da personalização do produto, quando o produto permitir algum tipo de personalização. Pode vir vazio.
produtos / personalizacao / valor	string	opcional	Valor da personalização do produto, quando o produto permitir algum tipo de personalização. Pode vir vazio.
produtos / personalizacao / custo	decimal	opcional	Custo da personalização do produto, quando o produto permitir algum tipo de personalização. Pode vir vazio.
pagamento / parcelas	inteiro	obrigatório	Quantidade de parcelas do pedido em cima do valor total do pedido.
pagamento / valor	decimal	obrigatório	Valor total cobrado no pedido sem os descontos/ajustes aplicados.
pagamento / ajuste	decimal	obrigatório	Ajustes do pedido considerando descontos. Pode vir vazio.
pagamento / total	decimal	obrigatório	Valor total cobrado no pedido considerando todos os ajustes.
pagamento / ip	string	opcional	IP do dispositivo que está finalizando o pedido.
pagamento / endereco / logradouro	string	obrigatório	Logradouro / Rua / Avenida / Estrada do endereço de pagamento do pedido.
pagamento / endereco / numero	string	obrigatório	Número do endereço de pagamento do pedido.
pagamento / endereco / complemento	string	opcional	Complemento do endereço de pagamento do pedido. Pode vir vazio.
pagamento / endereco / bairro	string	obrigatório	Bairro do endereço de pagamento do pedido.
pagamento / endereco / cep	string	obrigatório	CEP do endereço de pagamento do pedido.
pagamento / endereco / cidade	string	obrigatório	Cidade do endereço de pagamento do pedido.
pagamento / endereco / estado	string	obrigatório	Estado do endereço de pagamento do pedido.
pagamento / form / cpf	string	obrigatório	CPF utilizado no pagamento do pedido.

Modelo de Response - v1

O response é o retorno que a plataforma espera receber como resposta da requisição descrita no tópico acima. Este response é esperado para atualização em tempo real de statusId e message.
Este modelo é esperado quando se é utilizada a versão Simplificada da URL.

Modelo do response esperado

{
  "statusId":1,
  "message":"Minha mensagem"
}
{
  "statusId":2,
  "message":"Minha mensagem"
}
{
  "statusId":3,
  "message":"Minha mensagem"
}

Tabela de detalhamento dos campos do response acima:

Campo	Tipo	Obrigatoriedade	Descrição
statusId	inteiro	obrigatório	Informa o status da transação em tempo real. (Tabela de status informada abaixo)
message	string	obrigatório	Retorna a mensagem do status da transação.

Tabela de Status:

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.

📘
Nesse modelo, 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.

📘
Lembrando que o retorno exibido no pop-up é padrão e o texto não pode ser personalizado.

👍
Agora vamos deixar a opção de Pagamento visível no Checkout!
Após o desenvolvimento da aplicação no Pagamento Customizado, é necessário realizar as configurações no Admin para que as opções de Pagamento Customizado sejam disponibilizadas no Checkout da loja.
Para isso, acesse nossas documentações funcionais clicando aqui.

Updated about 1 month ago

(Deprecated) Versão Simplificada - Modelo de Objeto e Response

Versão Simplificada

Modelo de Requisição - v1

🚧
Objeto "form" padrão

Modelo de Response - v1

📘

📘

👍
Agora vamos deixar a opção de Pagamento visível no Checkout!

Versão Simplificada

Modelo de Requisição - v1

🚧Objeto "form" padrão

Modelo de Response - v1

📘

📘

👍Agora vamos deixar a opção de Pagamento visível no Checkout!

🚧
Objeto "form" padrão

👍
Agora vamos deixar a opção de Pagamento visível no Checkout!