POST/v1/deposits

Criar um depósito

Cria uma nova intenção de depósito. A resposta inclui um endereço de uso único, recém-gerado, na chain solicitada. Fundos enviados para esse endereço são creditados no saldo interno do merchant para o ativo correspondente.

Envie sempre uma Idempotency-Key para que retentativas sejam seguras. O corpo da requisição precisa ser JSON (Content-Type: application/json).

Parâmetros

stringRequired

Ativo a receber. Precisa ser um de ETH, USDT, BTC, TRX.

stringRequired

Família de chain. Precisa ser uma de ethereum, tron, bitcoin, e compatível com asset.

stringOptional

Valor esperado opcional, como string decimal com até 8 casas. Quando informado, o depósito é marcado como underpaid ou overpaid conforme o valor efetivamente recebido.

stringOptional

Seu identificador para este depósito (ex.: ID de pedido). 1–255 chars. Devolvido em todos os webhooks relacionados a este depósito.

stringOptional

URL de webhook por depósito (http(s), máx 2000 chars). Sobrescreve os endpoints de webhook da conta para eventos deste depósito.

stringOptional

Timestamp ISO-8601 em que a janela do endereço de depósito fecha. Se omitido, usa o padrão de 30 minutos.

objectOptional

Pares chave/valor livres devolvidos no objeto deposit e em todos os webhooks relacionados.

Retorno

Retorna o objeto Deposit criado com status: "pending".

Erros

Status	Code	Description
400	`invalid_request_error`	Parâmetro ausente, inválido, ou combinação `asset`/`chain` não suportada.
401	`authentication_error`	Chave de API ausente ou inválida.
409	`idempotency_key_reused`	A `Idempotency-Key` foi usada anteriormente com um corpo de requisição diferente.

Criar um depósito

curl https://api.aeses.io/v1/deposits \
-H "x-api-key: sk_live_..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
  "asset": "USDT",
  "chain": "ethereum",
  "amount": "99.50",
  "reference_id": "ord_4421",
  "webhook_url": "https://example.com/webhooks/aeses"
}'

Response

{
"object": "deposit",
"id": "dep_01hxyz7m2p5rt4vg3k8aqwe9fn",
"status": "pending",
"asset": "USDT",
"chain": "ethereum",
"expected_amount": "99.50",
"received_amount": null,
"deposit_address": "0x8f3a9c2bF7e1A4d62D8b9fF6E3c5a7E1d2B4c8A9",
"reference_id": "ord_4421",
"webhook_url": "https://example.com/webhooks/aeses",
"metadata": null,
"tx_hash": null,
"confirmations": 0,
"expires_at": 1731600000,
"created_at": 1731598200
}