Referência da API
Consulte API de Varejo para exemplos de assinatura, estados de pedidos e verificação de callbacks.
Rotas públicas em tempo real
| Finalidade | Método | Caminho | Autenticação |
|---|---|---|---|
| Criar um pedido GMPay | POST | /payments/gmpay/v1/order/create-transaction | HMAC-SHA256 do lojista |
| Consultar configuração | GET | /payments/gmpay/v1/config | Público |
| Abrir o checkout | GET | /pay/checkout-counter/{trade_id} | Público |
| Consultar os dados do checkout | GET | /pay/checkout-counter-resp/{trade_id} | Público |
| Consultar status do pedido | GET | /pay/check-status/{trade_id} | Público |
| Selecionar rede ou provedor | POST | /pay/switch-network | Público |
| Enviar o hash da transação | POST | /pay/submit-tx-hash/{trade_id} | Público |
| Voltar à loja | GET | /pay/return/{trade_id} | Redirecionamento de navegador |
| Criar um pedido EPay | GET ou POST | /payments/epay/v1/order/create-transaction/submit.php | MD5 do lojista |
| Receber uma notificação do OKPay | POST | /payments/okpay/v1/notify | Assinatura do OKPay |
Interface da API de administração
As APIs de gerenciamento estão localizadas em /admin/api/v1/* e são protegidas por JWT, exceto os pontos de extremidade de login e a configuração inicial da senha.
Grupos-chave visíveis na fonte atual:
- O caixa público aceita um hash para uma ordem pendente na blockchain. Um administrador também pode verificar uma ordem expirada ou um candidato em revisão manual.
- Taxas de câmbio:
rate.modeaceitafixedouauto. O modo fixo usarate.forced_rate_list. O automático consultarate.api_url, armazena em cache as respostas válidas por moeda-base e conserva o último cache persistente se a atualização falhar. Deixarrate.forced_rate_listvazio restaura a taxa padrão em CNY para USDT e USDC. /auth/*/api-keys/*/notification-channels/*/config- gerenciamento de cadeias / tokens de cadeia
- gerenciamento de endereço de carteira
- gerenciamento de configurações
Regras sobre credenciais de comerciantes
GMPay
- ID obrigatório do lojista:
pid - Campo de assinatura:
signature - Algoritmo de assinatura desde a versão
v2.0.0: HMAC-SHA256 sobre a string de parâmetros canônica e não vazia, criptografada com a chave doapi_keys.secret_key, que corresponde aopid. - Os clientes GMPay MD5 pré-v2 devem ser atualizados antes de implantar a versão
v2.0.0ou posterior.
Fluxo compatível com EPay
- ID obrigatório do lojista:
pid - Campo de assinatura:
sign - Chave de assinatura: a
secret_keydas linhasapi_keyshabilitadas que correspondem aopid. sign_typeé aceito e geralmente éMD5.- EPay
typeaceitaalipayou um seletor suportado dotoken.networkcomousdt.tron. Os seletores aceitos são preservados nos callbacks de retorno/notificação do EPay.
Ordem de integração recomendada
- Crie ou verifique os credenciais de comerciantes no painel de administração (
pid+secret_key). - Consulta
/payments/gmpay/v1/confige leiadata.supported_assetsse o cliente precisar de opções de rede/token dinâmicas. - Prefira o GMPay para novas integrações.
- Utilize o redirecionamento compatível com EPay apenas quando o sistema upstream (original) exigir esse fluxo.
- Verifique os callbacks com a mesma
secret_keydo lojista