Ir para o conteúdo

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 ​

FinalidadeMétodoCaminhoAutenticação
Criar um pedido GMPayPOST/payments/gmpay/v1/order/create-transactionHMAC-SHA256 do lojista
Consultar configuraçãoGET/payments/gmpay/v1/configPúblico
Abrir o checkoutGET/pay/checkout-counter/{trade_id}Público
Consultar os dados do checkoutGET/pay/checkout-counter-resp/{trade_id}Público
Consultar status do pedidoGET/pay/check-status/{trade_id}Público
Selecionar rede ou provedorPOST/pay/switch-networkPúblico
Enviar o hash da transaçãoPOST/pay/submit-tx-hash/{trade_id}Público
Voltar à lojaGET/pay/return/{trade_id}Redirecionamento de navegador
Criar um pedido EPayGET ou POST/payments/epay/v1/order/create-transaction/submit.phpMD5 do lojista
Receber uma notificação do OKPayPOST/payments/okpay/v1/notifyAssinatura 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.mode aceita fixed ou auto. O modo fixo usa rate.forced_rate_list. O automático consulta rate.api_url, armazena em cache as respostas válidas por moeda-base e conserva o último cache persistente se a atualização falhar. Deixar rate.forced_rate_list vazio 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 do api_keys.secret_key, que corresponde ao pid.
  • Os clientes GMPay MD5 pré-v2 devem ser atualizados antes de implantar a versão v2.0.0 ou posterior.

Fluxo compatível com EPay ​

  • ID obrigatório do lojista: pid
  • Campo de assinatura: sign
  • Chave de assinatura: a secret_key das linhas api_keys habilitadas que correspondem ao pid.
  • sign_type é aceito e geralmente é MD5.
  • EPay type aceita alipay ou um seletor suportado do token.network como usdt.tron. Os seletores aceitos são preservados nos callbacks de retorno/notificação do EPay.
  1. Crie ou verifique os credenciais de comerciantes no painel de administração (pid + secret_key).
  2. Consulta /payments/gmpay/v1/config e leia data.supported_assets se o cliente precisar de opções de rede/token dinâmicas.
  3. Prefira o GMPay para novas integrações.
  4. Utilize o redirecionamento compatível com EPay apenas quando o sistema upstream (original) exigir esse fluxo.
  5. Verifique os callbacks com a mesma secret_key do lojista