Documentação
Start typing to search…

PaymentSplit

Quando é utilizado?

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

❗️

Atenção!

Se houver Antifraude no fluxo, utilizar o payload AuthorizeSplit.

Estrutura da chamada

{urlbase}/paymentSplit

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

Modelo de Requisição da PaymentSplit

Estrutura do objeto enviado e seus dados:

[
  {
    "id": 0,
    "idTransacaoGateway": 64559983,
    "loja": "pagamentos",
    "chave": "fe31c0e6-b625-4772-8890-dd7a89053d05",
    "pedido": 108658,
    "carrinhoId": "d1e3bf62-795b-4b77-82ac-c81867ad9c1a",
    "frete": 0,
    "desconto": 0,
    "total": 300,
    "trocaPagamento": false,
    "multiplosPagamentos": false,
    "primeiroPedidoAssinatura": false,
    "assinatura": null,
    "usuario": {
      "idUsuario": 12345,
      "nome": "Teste Teste",
      "cpf": "79299082081",
      "dataNascimento": "2024-04-20",
      "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,
        "quantidade": 1,
        "personalizacao": []
      }
    ],
    "pagamento": {
      "parcelas": 1,
      "valor": 300,
      "valorCC": 0,
      "ajuste": 0,
      "total": 300,
      "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"
      }
    }
  },
  {
    "id": 0,
    "idTransacaoGateway": 64559983,
    "loja": "pagamentos",
    "chave": "fe31c0e6-b625-4772-8890-dd7a89053d05",
    "pedido": 108648,
    "carrinhoId": "d1e3bf62-795b-4b77-82ac-c81867ad9c1a",
    "frete": 0,
    "desconto": 0,
    "total": 300,
    "trocaPagamento": false,
    "multiplosPagamentos": false,
    "primeiroPedidoAssinatura": false,
    "assinatura": null,
    "usuario": {
      "idUsuario": 12345,
      "nome": "Teste Teste",
      "cpf": "79299082081",
      "dataNascimento": "2024-04-20",
      "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": 1033,
        "valor": 300,
        "quantidade": 1,
        "personalizacao": []
      }
    ],
    "pagamento": {
      "parcelas": 1,
      "valor": 300,
      "valorCC": 0,
      "ajuste": 0,
      "total": 300,
      "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 PaymentSplit

Campo

Tipo

Descrição

Tamanho

id

inteiro

Código identificador único do pagamento

idTransacaoGateway

inteiro

Código gerado pela plataforma do gateway de 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.

carrinhoId

guid

Código identificador do carrinho

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

trocaPagamento

boolean

Campo destinado para identificar se o pedido teve uma troca de pagamento. Deve ser "true" ou "false".

multiplosPagamentos

boolean

Campo destinado para identificar se o pedido teve duas formas de pagamento. Deve ser "true" ou "false".

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, Nullou 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 / idUsuario

Int

Id do usuário

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 / dataNascimento

string

Data de nascimento do usuário

10 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

[
	{
		"pedido":108648,
		"chave":"fe31c0e6-b625-4772-8890-dd7a89053d05",
		"idTransacaoGateway": 64559983,
		"id": 3005871,
        "statusId": 1,
        "message": "Minha mensagem",
        "informacoesAdicionais": [{
                "Nome": "Teste1",
                "Valor": "Valor1"
            }, {
                "Nome": "Teste2",
                "Valor": "Valor2"
            }
        ],
        "boleto": {
            "linhadigitavel": "12345656029000471149635005393703774970000001111",
            "linkPagamento": "https://wake.com/boleto/1b4f1fb6-38db-4e90-9582-f3908570b12a"
        },
        "pix": {
            "pixQrCodeUrl": "https://wake.tech/imagem/qrcode.svg",
            "pixQrCode": "00020101021226950014br.gov.bcb.pix21081234567822041234230912344567824200123456789012345678952040000530398656074043.985802BR5915FABRICA DE BITS6008Curitiba62180514T0I18424023I0T80760014br.gov.bcb.pix2546bx.com.br/pix/0A0104AB02011D439F327DBD6C1186AD6304C7DD",
            "dataExpiracaoQrCode": "04/11/2024 12:16:20",
        }
    }, 
	{
		"pedido":108649,
		"chave":"fe31c0e6-b625-4772-8890-dd7a89053d06",
		"idTransacaoGateway": 64559984,
		"id": 3005872,
        "statusId": 4,
        "message": "Minha mensagem",
        "informacoesAdicionais": [{
                "Nome": "Teste1",
                "Valor": "Valor1"
            }, {
                "Nome": "Teste2",
                "Valor": "Valor2"
            }
        ],
        "boleto": {
            "linhadigitavel": "12345656029000471149635005393703774970000001111",
            "linkPagamento": "https://wake.com/boleto/1b4f1fb6-38db-4e90-9582-f3908570b12a"
        },
        "pix": {
            "pixQrCodeUrl": "https://wake.tech/imagem/qrcode.svg",
            "pixQrCode": "00020101021226950014br.gov.bcb.pix21081234567822041234230912344567824200123456789012345678952040000530398656074043.985802BR5915FABRICA DE BITS6008Curitiba62180514T0I18424023I0T80760014br.gov.bcb.pix2546bx.com.br/pix/0A0104AB02011D439F327DBD6C1186AD6304C7DD",
            "dataExpiracaoQrCode": "04/11/2024 12:16:20",
        }
    }
]

Campos do response

CampoTipoDescrição
statusIdinteiroInforma o status da transação em tempo real. (Tabela de status informada abaixo)
messagestringRetorna a mensagem do status da transação.
informacoesAdicionais / nomestringRetorna o nome da informação
informacoesAdicionais / valorstringRetorna o dado da informação
boleto / linhadigitavelstringRetorna o código para pagamento
boleto / linkpagamentostringRetorna o link do boleto
pix / pixQrCodeUrlstringRetorna a imagem do QR Code
pix / pixQrCodestringRetorna o código do QR Code
pix / dataExpiracaoQrCodestringRetorna a data de expiração do QR Code

Status esperados

StatusIdNome statusAção
1Aguardando PagamentoMantém o pedido como aguardando pagamento na plataforma.
2Não autorizadoNega a transação. O Pop-up do checkout online é exibido na tela do usuário e a compra é bloqueada.
3PagoAtualiza o status do pedido para Pago na plataforma.
4AutorizadoAtualiza 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 paymentSplit e authorizeSplit, 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.

Updated about 2 hours ago

What’s Next