Criar ordem de pagamento de saída

Cria uma ordem de pagamento. Após o sucesso, a plataforma congela o valor do pagamento e a taxa de rede e, em seguida, retorna os detalhes do pedido.

Se fromAddress não for fornecido, o sistema seleciona automaticamente um endereço com saldo suficiente. Se nenhum estiver disponível, retornará saldo de endereço insuficiente.

POST/openapi/payout/orders

Cabeçalhos

Campo	Tipo	Obrigatório	Descrição
x-api-key	string	Sim	Comerciante API Key. Use o valor que começa com mch_ na página de configurações do comerciante API.
x-merchant-uid	string	Sim	Merchant UID.
x-timestamp	string	Sim	Milissegundos de 13 dígitos timestamp. O desvio padrão permitido do relógio é de 5 minutos.
x-nonce	string	Sim	String aleatória exclusiva para cada solicitação, com até 128 caracteres. A reutilização é rejeitada.
x-signature	string	Sim	Assinatura 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

Campo	Tipo	Obrigatório	Descrição
chainCode	string	Sim	Código da cadeia. Valores suportados: TRON / BSC / SOL.
tokenSymbol	string	Sim	Símbolo simbólico.
fromAddress	string	Não	Endereço do remetente especificado. Se omitido, o sistema atribui um automaticamente.
toAddress	string	Sim	Endereço de recebimento.
amount	string	Sim	Valor do pagamento, até 6 casas decimais.
deleteSourceAfterSuccess	boolean	Não	Booleano JSON opcional, false por padrão. Quando true, exclui logicamente a origem somente após este pagamento ser confirmado na blockchain; falha ou cancelamento não exclui. Pagamentos não exigem reserva de saldo.
merchantOrderNo	string	Sim	Número do pedido do comerciante.
notifyUrl	string	Sim	Retorno de chamada específico do pedido URL. Recomenda-se um HTTPS URL público de propriedade do comerciante.

Exemplo de requisição

{
  "chainCode": "TRON",
  "tokenSymbol": "USDT",
  "fromAddress": "TNjBrNq2a9FK2vwu4W9C1QdLKSZ42Yx5YY",
  "toAddress": "TS7b7iD8G2PaPqK1TqSmLJ9nrrYH4oKX1S",
  "amount": "35.50",
  "deleteSourceAfterSuccess": false,
  "merchantOrderNo": "PO202604150001",
  "notifyUrl": "https://merchant.example.com/api/uugate/payout-notify"
}

Campos da resposta

Campo	Tipo	Obrigatório	Descrição
orderNo	string	Sim	Número da ordem de pagamento da plataforma.
merchantOrderNo	string \| null	Sim	Número do pedido do comerciante.
fromAddress	string \| null	Sim	Endereço real do remetente.
toAddress	string	Sim	Endereço de recebimento.
amount	string	Sim	Valor do pagamento.
txHash	string \| null	Sim	Hash on-chain retornado após transmissão.
status	string	Sim	enviado / transmitido / confirmed / failed.
submittedAt	string \| null	Sim	Hora enviada.
broadcastedAt	string \| null	Sim	Hora da transmissão.
confirmedAt	string \| null	Sim	Hora de confirmação.
failedAt	string \| null	Sim	Hora falhada.
createdAt	string \| null	Sim	Tempo criado.

Exemplo de resposta

{
  "orderNo": "PO1776193200A1B2C3D4",
  "merchantOrderNo": "PO202604150001",
  "fromAddress": "TNjBrNq2a9FK2vwu4W9C1QdLKSZ42Yx5YY",
  "toAddress": "TS7b7iD8G2PaPqK1TqSmLJ9nrrYH4oKX1S",
  "amount": "35.500000",
  "txHash": "b3d4fb0cb11eb86bb906d1e0ee3b84e17f40d5441d1e4c651ea46920a48a9a01",
  "status": "broadcasted",
  "submittedAt": "2026-04-15T03:00:00Z",
  "broadcastedAt": "2026-04-15T03:00:08Z",
  "confirmedAt": null,
  "failedAt": null,
  "createdAt": "2026-04-15T03:00:00Z"
}

Exemplos de código

cURL Exemplo de solicitação

curl -X POST 'https://api.uugate.com/openapi/payout/orders' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: mch_xxxxxxxxxxxxxxxxxxxx' \
  -H 'x-merchant-uid: 880001' \
  -H 'x-timestamp: 1776193200000' \
  -H 'x-nonce: 2f5c7b147c3748f0a8b3d9bb38aa91a4' \
  -H 'x-signature: <SIGNATURE_HEX>' \
  -d '{
    "chainCode": "TRON",
    "tokenSymbol": "USDT",
    "fromAddress": "TNjBrNq2a9FK2vwu4W9C1QdLKSZ42Yx5YY",
    "toAddress": "TS7b7iD8G2PaPqK1TqSmLJ9nrrYH4oKX1S",
    "amount": "35.50",
    "deleteSourceAfterSuccess": false,
    "merchantOrderNo": "PO202604150001",
    "notifyUrl": "https://merchant.example.com/api/uugate/payout-notify"
  }'

Notas

A API publica oferece apenas pagamentos individuais. Pagamentos em lote estao disponiveis somente no painel do comerciante.
Um pagamento de 10 exige pelo menos 10 de saldo disponível na origem, sem reserva adicional, independentemente de deleteSourceAfterSuccess. O valor não é reduzido; a conta de taxas deve cobrir a taxa de rede.
Envie true / false, nao strings. Tentativas com o mesmo merchantOrderNo devem manter o parametro. Nao e possivel excluir a origem com outras transferencias pendentes.
Criacao ou transmissao bem-sucedida nao e confirmacao na blockchain. A exclusao logica preserva historico, registros e referencias de chaves. Falha ou cancelamento preserva a origem.
The create API automatically attempts submission. Use status from the response or a later query; an HTTP 2xx alone is not on-chain success.