Transações

Busca as informações sobre transações realizadas.

Dados de Hooks (TopCompradores, Meta Mensal, etc)

GET https://api.lojasquare.net/v1/transacoes/hooks

Query Parameters

Name	Type	Description
dataFim	string	Data final do filtro no formato DD/MM/YYYY .
dataInicio	string	Data de início do filtro no formato DD/MM/YYYY .

Headers

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

200 Retorna os dados de hooks relacionados a transações

{
	"metaMensal": {
		"evolucao": 100,
		"exibirValores": true,
		"valorAtual": 1000.00,
		"valorMeta": "1000"
	},
	"topCompradores": {
		"doadores": [
			{
				"player": "LojaSquare1",
				"valor": 250
			},
			{
				"player": "LojaSquare2",
				"valor": 230
			},
			{
				"player": "LojaSquare3",
				"valor": 200
			}
		],
		"exibirValores": true
	}
}

404 Caso os hooks de transações não tenham sido configurados:

{
    "msg": "hook_nao_encontrado"
}

Lista de Transações

GET https://api.lojasquare.net/v1/transacoes

Busca a lista de transações da loja

Query Parameters

Name	Type	Description
status	number	Status da Transação
pagina	number	Página atual da lista de transações
dataInicio	String	Data de início do filtro no formato DD/MM/YYYY .
dataFim	String	Data final do filtro no formato DD/MM/YYYY .
player	String	Nick do player com transações registradas na loja .
codigo	String	Código da transação registrada a ser buscada na loja .

Headers

Name	Type	Description
AUTHORIZATION*	String	Token Privado (Secret API) de autorização para acesso à informações de entregas e transações.

200: OK Retorna a lista de transações de acordo com o filtro.

[
	{
		"transacaoID": 160,
		"userID": 1,
		"servidor": "TrowCraft",
		"player": "Trow_Games",
		"referencia": "VIPs",
		"gateway": "PicPay",
		"valorLiquido": 50,
		"email": "[e-mail]",
		"grupo": "vip",
		"codigo": "123456789",
		"codigoHistorico": 123456789,
		"status": "Pago",
		"statusID": 2,
		"criadoEm": 1630615974,
		"atualizadoEm": 1633221516,
		"detalhes": {
			"produto": "VIP++ (Mensal)",
			"quantidade": 1,
			"cupom": "SEM CUPOM"
		}
	},
	{
		"transacaoID": 161,
		"userID": 1,
		"servidor": "TrowCraft",
		"player": "Trow_Games",
		"referencia": "VIPs",
		"gateway": "Juno",
		"valorLiquido": 20,
		"email": "[e-mail]",
		"grupo": "vip-ferro",
		"codigo": "123456789",
		"codigoHistorico": 123456789,
		"status": "Pago",
		"statusID": 2,
		"criadoEm": 1630615974,
		"atualizadoEm": 1633221516,
		"detalhes": {
			"produto": "VIP Ferro (Mensal)",
			"quantidade": 1,
			"cupom": "SEM CUPOM"
		}
	}
]

404: Not Found Quando não encontrar alguma informação, retornará com este status:

# Quando não encontrar nenhuma transação
{
    "msg": "transacao_nao_encontrada"
}

# Quando não encontrar nenhum usuário pelo token informado
{
	"msg": "usuario_nao_encontrado"
}

400: Bad Request Falha de requisição:

# Quando o status da transação não for válido
{
	"msg": "transacao_status_invalido"
}

INFO: Status das transações: - Pendente = 1 - Pago = 2 - Disputa = 3 - Devolvido = 4 - Cancelado = 5

CUIDADO: A API de transações requer acesso ao token "Secret API". Este token da acesso a informações privadas da loja e dos players. Não deixe este token visível no frontend. Recomendamos o uso via server-side.