Integração Compralo Referência da API

Bem-vindo à documentação da integração de sistemas terceiros com a API da Compralo. Nesta documentação descrevemos como você pode integrar o seu sistema com a nossa API REST de forma simples para começar a receber pagamentos através da melhor plataforma de pagamentos do Brasil.

A API da Compralo é baseada na métodologia REST, e utiliza solicitações via POST e GET para se comunicar com outros sistemas. Todas as solicitações são autenticadas pela api_key, este código esta associado à sua conta na Compralo e pode ser visualizado em https://app.compralo.io/account.

API Endpoint
https://app.compralo.io/api/v1
Termos de Serviços: https://compralo.io/termos
Contato p/ Desenvolvedores: [email protected]
Schemes: http, https
Versão: 1.0.0

Autenticação

api_key

nome
api_key
no
body

Utilitários

Caso você precise calcular o preço na cryptomoeda desejada, basta utilizar este endpoint https://app.compralo.io/api/v1/seller/getPrice através de GET. Nele você poderá ver o preço em REAL das cryptomoedas na plataforma Compralo.

Bibliotecas

Cliente PHP

Instalação via Composer: https://github.com/Compralo/compralo-php

Faturas

Com os métodos do Checkout você consegue gerar novas faturas, verificar o status e listar as faturas geradas.

Criar uma nova Fatura

POST /seller/generateInvoice

Objeto para Criar a Fatura

Exemplo de Solicitação
{
  "api_key": 827260d4-fb11-45c6-7e45-b2c65ac51ee9,
  "store_name": "Loja da Maria",
  "value": 410.30,
  "postback_url": "https://lojadamaria.dev/postback",
  "description": "Jaqueta p/ Inverno",
  "back_url": "https://lojadamaria.dev/pedido/87172",
}
200 OK

Operação realizada com sucesso

422 Unprocessable Entity

Campos Inválidos

Exemplo de Resposta (200 OK)
{
  "status": true,
  "message": "Invoice generate with success",
  "token": "TkotMc9vRGgUNyEf",
  "url": "https://app.compralo.io/invoice/TkotMc9vRGgUNyEf",
}
Exemplo de Resposta (422 Unprocessable Entity)
{
  "status": false,
}

Verificar Status de uma Fatura

GET /seller/checkStatus/{Invoice}
Invoice

Token da Fatura

type
string
in
path
Exemplo de Resposta (200 OK)
{
  "status": 1,
}
Exemplo de Resposta (422 Unprocessable Entity)
{
  "status": false,
}

Transações

Com os métodos de Transações, você pode realizar transações na sua conta, como: Saques.

Criar um novo Saque

POST /withdrawal/create

Objeto para Criar a Saque

Exemplo de Solicitação
{
  "api_key": 827260d4-fb11-45c6-7e45-b2c65ac51ee9,
  "coin": "BTC",
  "value": 0.148598,
  "destination": "1CJg8qBrJJM26mvtJnJ8hX2T...",
}

Operação realizada com sucesso

422 Unprocessable Entity

Campos Inválidos

Exemplo de Resposta (200 OK)
{
  "status": true,
  "message": "Withdrawal created with success",
  "hash": "0a04c5355d00cd37213ea262f764d...",
}
Exemplo de Resposta (422 Unprocessable Entity)
{
  "status": false,
}

Verificar conta de Usuário

POST /withdrawal/checkAccount

Objeto para Consultar Usuário

Exemplo de Solicitação
{
  "api_key": 827260d4-fb11-45c6-7e45-b2c65ac51ee9,
  "doc": "888.888.888-88",
}
200 OK

Operação realizada com sucesso

422 Unprocessable Entity

Campos Inválidos

Exemplo de Resposta (200 OK)
{
  "status": true,
  "message": "Conta encontrada na Compralo",
  "code": "888888",
}
Exemplo de Resposta (422 Unprocessable Entity)
{
  "status": false,
}

Schema

CreateInvoice: objeto

api_key: string (text)
store_name: string (text)
value: integer (int32) *em BRL
postback_url: string (url)
description: string (text)
back_url: string (url)
Example
{
  "api_key": 827260d4-fb11-45c6-7e45-b2c65ac51ee9,
  "store_name": "Loja da Maria",
  "value": 410.30,
  "postback_url": "https://lojadamaria.dev/postback",
  "description": "Jaqueta p/ Inverno",
  "back_url": "https://lojadamaria.dev/pedido/87172"
}

CreateWithdrawal: objeto

api_key: string (text)
coin: string (text)
value: integer (int32) *em BRL
destination: string (text)
Example
{
  "api_key": 827260d4-fb11-45c6-7e45-b2c65ac51ee9,
  "coin": "BTC",
  "value": 0.148598,
  "destination": "1CJg8qBrJJM26mvtJnJ8hX2T...",
}