API explorerChangelog
Introduction

Sections

API explorer
Changelog

Theme switcher

New deposit received

When a deposit is detected on any of your wallets from the products TREASURY and VIRTUAL WALLETS, a notification will be sent to the configured webhook notification (if not configured, nothing will be sent). Each product has a minimum deposit amount required to be processed, which are:

Minimum deposit amounts by product:

  • CARDS: 10 USD
  • VIRTUAL WALLETS: 1 USD
  • TREASURY: 1 USD

For configure the webhook please sea the management endpoints

The request is composed by the following fields:

PRODUCT: TREASURY | CARDS | VIRTUAL_WALLETS

EVENT TYPE: DEPOSIT

STATUS: SUCCESS

Data Payload:

Field

Type

Description

wallet_id

String

Unique identifier of the card that needs the approval

wallet_address

String

Address of one of your wallets that received the tokens

transaction_hash

String

Hash of the operation to check on the blockchain

blockchain

String

Blockchain name where the operation was made. For possibles values check the Management/Blockchain endpoint

from_wallet_address

String

Address of the wallet that send the tokens

amount

Decimal with 2 digit precision

Amount received

net_amount

Decimal with 2 digiti precision

Net amount credited to the customer after deductions for fees and operational charges

token

Object

Information of the received token

created_at

Date Time

Date and time when the transaction was created

Token payload:

Field

Type

Description

name

String

Full name of the token

symbol

String

Short name of the token

address

String

Address of the token contract

Full payload example:

Plain text
{
  "product": "TREASURY",
  "event_type": "DEPOSIT",
  "operation_id": "0x1234567890123456789012345678901234567890",
  "status": "SUCCESS",
  "data": {
    "wallet_id": "ivZPARvNBLOSZx69q4DCBBGUfVhCMsLw",
    "wallet_address": "0xff899364c6e15524531ed3739ea3e878eb1c6d86",
    "transaction_hash": "0xa348fb3f57c8ecc92ca0aaa858c520432a23cd5e5aeeee3e116fba229891e581",
    "from_wallet_address": "0xde0da9cb48b9133b9011fbc0a073c71e7cc23830",
    "amount": "100.1",
    "net_amount": "99.25",
    "token": {
      "name": "USD Circle",
      "symbol": "USDC",
      "address": "0x41e94eb019c0762f9bfcf9fb1e58725bfb0e7582"
    },
    "created_at": "2024-06-28T10:20:56.654-03:00"
  } 
}

Response:

No response is needed
Was this section helpful?

What made this section unhelpful for you?

On this page
  • New deposit received