Skip to main content
POST
/
v1
/
deposits
Get pending deposits for specified addresses
curl --request POST \
  --url https://gateway-api-testnet.circle.com/v1/deposits \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "USDC",
  "sources": [
    {
      "depositor": "<string>",
      "domain": 0
    }
  ]
}
'
{
  "token": "USDC",
  "deposits": [
    {
      "depositor": "<string>",
      "domain": 0,
      "transactionHash": "0x2c5f3e4a9e4b1a4b9c8d6a7d5b8e9f0a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e",
      "amount": "<string>",
      "status": "pending",
      "blockHeight": "15000000",
      "blockHash": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
      "blockTimestamp": "2023-11-07T05:31:56Z"
    }
  ]
}

Body

application/json
token
enum<string>
required

Token type to query deposits for

Available options:
USDC
sources
object[]
required

List of sources to query deposits from. If domain is omitted from any source, the deposits from all domains for that depositor will be returned.

Response

Successfully retrieved deposits

Response containing pending deposits for specified sources

token
enum<string>
required

Token type that was queried

Available options:
USDC
deposits
object[]
required

List of pending deposits for each source