Checkout

Gera o link para pagamento dos produtos no carrinho.

Realizar Checkout

POST https://api.lojasquare.net/v1/checkout

Gera o link referente ao pagamento dos produtos no carrinho.

Headers

Name	Type	Description
AUTHORIZATION	string	Token público (KEY-API) de autorização para acesso à informações e identificação de uma loja.

Request Body

Name	Type	Description
redirectURL	object	URLs de retorno ao site (quando aplicáveis)
player	string	Nick do player que receberá os produtos in-game.
gateway	string	Gateway para realizar o pagamento escolhido pelo player.
carrinho	object	Lista de produtos no carrinho no formato descrito abaixo.
cliente*	object	Informar propriedade clienteID do player logado, para identificar a conta do site que está fazendo a compra.

200 Retorna o link de pagamento gerado para os produtos indicados no carrinho.

{
  "urlPayment": "https://pagseguro.uol.com.br/v2/checkout/payment.html?code=1AB3C5D7E9F02G4HI68J1KL35MN41OP0",
  "code": "1AB3C5D7E9F02G4HI68J1KL35MN79OP0"
}

Body Request Explicado:

Abaixo será indicado o formato esperado como body de requisição:

• player = Nick do player que receberá o produto dentro do jogo.

• gateway = Gateway escolhido pelo player dentre os possíveis retornados pelo endpoint Gateways .

• servidor = Nome da loja onde o player colocou os produtos no carrinho.

• carrinho = Array de objetos de itens que o comprador colocou no carrinho da loja.

• redirectURL = URLs para redirecionar o player após realizar o pagamento de um carrinho.

• cliente = Dados do comprador, sendo o principal o clienteID.

Formato de Objetos de Itens no carrinho: { id_produto: ID do produto que o player colocou no carrinho. quantidade: Quantidade selecionada no carrinho para este produto. }

OBS: Caso o titular da loja deseje que os players não precisem realizar login para efetivar uma compra, é possível parametrizar no painel de administração da Loja Square os dados que serão solicitados para checkout (Painel > Config > Gerais > Parâmetros Conta). Estando desativado as opções que obrigam a criação de conta e o login, pode-se passar o valor 0 (zero) para clienteID.

Exemplo:

{
	"carrinho": [
		{
			"id_produto": 4,
			"quantidade": 3
		},
		{
			"id_produto": 1186,
			"quantidade": 1
		}
	],
	"redirectURL": {
		"returnURL": "https://minha_loja.lojasquare.com.br/finalizado",
		"cancelURL": "https://minha_loja.lojasquare.com.br/finalizado"
	},
	"cliente": {
		"nome": "Seu nome",
		"sobrenome": "Seu sobrenome",
		"cpf": "000.000.000-00",
		"telefone": "99999999999",
		"email": "[email protected]",
		"clienteID": 1234
	},
	"gateway": "PicPay",
	"player": "Trow_Games"
}

Response:

O retorno da API para esta requisição será:

• urlPayment = URL de pagamento gerada para os itens no carrinho.

• code = Código identificador gerado para o pagamento.

• img = Indica se o retorno é um link ou imagem.

Nota: Em casos onde for gerado um QR Code, os dados de retorno serão retornados no atributo code.