For the complete documentation index, see llms.txt. This page is also available as Markdown.

Submit a deposit

post

Optionally notify the 1Click service that a deposit has been sent to the deposit address, using the blockchain transaction hash. This can speed up swap processing by allowing the system to preemptively verify the deposit. This endpoint is a transparent proxy to the 1Click API.

Path parameters
apiKeystringRequired

API key generated at https://studio.aurora.dev

Body
txHashstringRequired

Transaction hash of your deposit.

Example: 0xabc123
depositAddressstringRequired

Deposit address returned in the quote response.

Example: 0x76b4c56085ED136a8744D52bE956396624a730E8
nearSenderAccountstringOptional

Sender account (used only for the NEAR blockchain).

Example: sender.near
memostringOptional

Memo. Use if the deposit was submitted with one.

Example: 1111111
Responses
200

Deposit transaction submitted successfully

application/json

Deposit transaction submitted successfully

correlationIdstringRequired

Unique identifier for request tracing and debugging.

Example: 550e8400-e29b-41d4-a716-446655440000
statusstring · enumRequired

Current execution status of the swap:

  • KNOWN_DEPOSIT_TX - a deposit transaction is known but not yet confirmed.

  • PENDING_DEPOSIT - waiting for the deposit to arrive at the deposit address.

  • INCOMPLETE_DEPOSIT - the deposit received is below the required amount.

  • PROCESSING - the deposit was received and the swap is being processed.

  • SUCCESS - the swap completed successfully.

  • REFUNDED - the deposit was refunded.

  • FAILED - the swap failed.

Example: SUCCESSPossible values:
updatedAtstringRequired

Timestamp in ISO format when the state was last updated.

Example: 2019-08-24T14:15:22Z
post
/api/deposit/submit/{apiKey}

Last updated