Consultar status do pedido de pagamento

Consulta detalhes do pedido de pagamento por número de pedido da plataforma, retornando os status atuais e os timestamps principais.

GET/openapi/payin/orders/{orderNo}

Cabeçalhos

CampoTipoObrigatórioDescrição
x-api-keystringSimComerciante API Key. Use o valor que começa com mch_ na página de configurações do comerciante API.
x-merchant-uidstringSimMerchant UID.
x-timestampstringSimMilissegundos de 13 dígitos timestamp. O desvio padrão permitido do relógio é de 5 minutos.
x-noncestringSimString aleatória exclusiva para cada solicitação, com até 128 caracteres. A reutilização é rejeitada.
x-signaturestringSimAssinatura hexadecimal gerada com HMAC-SHA256. A carga útil contém Merchant UID, timestamp, nonce, método, caminho, query canônico e body canônico.

Parâmetros

CampoTipoObrigatórioDescrição
orderNostringSimParâmetro de caminho. O número do pedido da plataforma retornado ao criar a ordem de pagamento.

Exemplo de requisição

GET /openapi/payin/orders/PI1776193200123ABCD1234

Campos da resposta

CampoTipoObrigatórioDescrição
orderNostringSimNúmero de pedido da plataforma.
merchantOrderNostring | nullSimNúmero do pedido do comerciante.
bindKeystring | nullSimChave vinculativa para recarga de associado. Geralmente vazio para ordens de pagamento compartilhadas.
chainCodestring | nullSimRede do pedido.
tokenSymbolstring | nullSimMoeda do pedido.
txHashstring | nullSimHash da transação correspondente; null antes da detecção.
amountstring | nullSimValor do pedido.
paidAmountstring | nullSimValor pago.
addressstring | nullSimEndereço de recebimento.
cashierUrlstring | nullSimURL do checkout com token aleatório. Consultas assinadas podem recuperar links seguros de pedidos anteriores.
paymentUristring | nullSimPagamento de carteira URI.
expireAtstring | nullSimPrazo de validade do pedido.
createdAtstring | nullSimTempo criado.
detectedAtstring | nullSimHora de detecção do pagamento.
confirmedAtstring | nullSimHora de confirmação.
completedAtstring | nullSimHora de conclusão.
statusstringSimPedido status.

Exemplo de resposta

{
  "orderNo": "PI1776193200123ABCD1234",
  "merchantOrderNo": "M202604150001",
  "bindKey": null,
  "amount": "100.000000",
  "paidAmount": "100.000000",
  "address": "TXYZ3x9nJ5J4xP2gh6mQW7rT31jB8Y2pA9",
  "cashierUrl": "https://open.uugate.com/SK/PI1776193200123ABCD1234#ct=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "paymentUri": "TRON:TXYZ3x9nJ5J4xP2gh6mQW7rT31jB8Y2pA9?token=USDT&amount=100.000000",
  "expireAt": "2026-04-18T06:30:00.000Z",
  "createdAt": "2026-04-18T06:00:00.000Z",
  "detectedAt": "2026-04-18T06:08:15.000Z",
  "confirmedAt": "2026-04-18T06:09:02.000Z",
  "completedAt": "2026-04-18T06:09:02.000Z",
  "status": "completed",
  "chainCode": "TRON",
  "tokenSymbol": "USDT",
  "txHash": "f7f17891f52c35d0c93170f0d12bb347ac16ab34853b4bc8dcf7fd0a8c9aa321"
}

Exemplos de código

Execução: salve Java como UUGateExample.java (UUGateCallback.java para callbacks) e use java nome do arquivo; PHP: php example.php; Go: go run example.go; Node.js: node example.mjs. A verificação de callbacks lê o corpo original da entrada padrão.

import { createHmac, randomBytes } from 'node:crypto';

function required(name) {
  const value = process.env[name]?.trim();
  if (!value) throw new Error(name + ' is required');
  return value;
}
const uid = required("UUGATE_MERCHANT_UID"), key = required("UUGATE_API_KEY");
const timestamp = String(Date.now()), nonce = randomBytes(16).toString("hex");
const method = 'GET', path = '/openapi/payin/orders/PI1776193200123ABCD1234';
const canonicalQuery = '', canonicalBody = "";
const payload = [uid, timestamp, nonce, method, path, canonicalQuery, canonicalBody].join('\n');
const signature = createHmac('sha256', key).update(payload, 'utf8').digest('hex');
const base = (process.env.UUGATE_BASE_URL || 'https://api.uugate.com').replace(/\/+$/, '');
const response = await fetch(base + path, {
  method, redirect: 'error', signal: AbortSignal.timeout(30000),
  headers: { 'Content-Type': 'application/json', 'x-api-key': key, 'x-merchant-uid': uid,
    'x-timestamp': timestamp, 'x-nonce': nonce, 'x-signature': signature },
  ...(canonicalBody ? { body: canonicalBody } : {}),
});
const raw = await response.text();
if (!response.ok) throw new Error('HTTP ' + response.status + ': ' + (raw || 'empty response body'));
JSON.parse(raw);
console.log(raw);

Notas

  • Para o sucesso final do negócio, use status=completed.
  • As quatro linguagens usam as mesmas rotas, parâmetros e respostas. As credenciais vêm de UUGATE_MERCHANT_UID e UUGATE_API_KEY; UUGATE_BASE_URL usa https://api.uugate.com por padrão.
  • canonicalBody é JSON compacto com campos ordenados. Ao alterar parâmetros, ordene objetos recursivamente, preserve arrays e use UTF-8 sem escapes adicionais de barras ou Unicode. Valores monetários são strings; booleanos são true / false.
  • O sucesso retorna o objeto de negócio diretamente, sem envelope code / data. Verifique primeiro o status HTTP. Erros retornam code, message, data e requestId; recusas de segurança podem retornar apenas HTTP 401 / 403 com corpo vazio.
  • Após timeout ou HTTP 5xx, consulte o pedido antes de repetir a criação ou envio. Gere timestamp, nonce e assinatura novos em cada solicitação.