Teste sua integração em 5 minutos
Use nosso Playground da API Sandbox público com credenciais de teste compartilhadas. Nenhum dinheiro real é cobrado — os pedidos nunca chegam aos provedores de pagamento ao vivo.
Passo 1: Obtenha credenciais sandbox
Abra /sandbox. Copie o App ID, a API Key (para assinatura) e a Query Key (para consulta de pedidos).
Passo 2: Crie um pedido de teste
Use o formulário do Playground ou envie um POST assinado para /api/createorder:
curl -X POST "https://seu-dominio.com/api/createorder" \
-H "Content-Type: application/json" \
-d '{
"appid": "SEU_SANDBOX_APPID",
"action": "createorder",
"clientip": "127.0.0.1",
"amount": "9.99",
"currency": "USD",
"paymentMethod": "alipay",
"description": "Pedido de teste",
"notify_url": "https://seu-dominio.com/api/sandbox/webhook-receiver",
"sign_type": "MD5",
"sign": "ASSINATURA_MD5_CALCULADA"
}'
O Playground calcula a assinatura MD5 para você. Veja Documentação da API — Assinatura para o algoritmo.
Passo 3: Simule o pagamento
Abra o redirectUrl da resposta de criação de pedido (ou use Simular pagamento no Playground). Clique em Simular Sucesso. O gateway enfileira um webhook para sua notify_url.
Passo 4: Verifique a assinatura do webhook
Os callbacks são enviados como GET com parâmetros de consulta incluindo sign e sign_type=MD5. Verifique usando o mesmo algoritmo de criação de pedido, com sua API Key.
// Exemplo em Node.js (conceitual)
const crypto = require('crypto');
function verifyCallback(params, apiKey) {
const copy = { ...params };
delete copy.sign;
delete copy.sign_type;
const keys = Object.keys(copy).filter(k => copy[k] != null).sort();
const str = keys.map(k => k + '=' + copy[k]).join('&') + apiKey;
const expected = crypto.createHash('md5').update(str).digest('hex');
return expected === params.sign;
}
Seu servidor deve responder com o texto simples success (sem distinção entre maiúsculas e minúsculas).
Passo 5: Consulte o status do pedido
GET /api/order?action=order&appid=APPID&key=QUERY_KEY&paymentId=ORDER_ID
Ou faça polling no endpoint público: GET /api/order/status/:orderId
Indo para produção
- Registre uma conta de comerciante e use seu
appid,apikeyekeyde produção. - Defina sua
notify_urlreal nas configurações da conta ou por pedido. - Nunca exponha a API Key no código do lado do cliente.
- Sempre verifique as assinaturas do webhook no lado do servidor.
Referência completa: Documentação da API · Teste ao vivo: Playground Sandbox