Deposit Volumes

Get deposit volume metrics for a specific date.

info

This endpoint is only available in production.

Base URL: https://api-pix.crypto2pay.app/v2/metrics/deposits

Endpoint

GET /v2/metrics/deposits

Query Parameters

Parameter	Type	Required	Description
date	string	required	Date in YYYY-MM-DD format

Example Request

curl -X GET "https://api-pix.crypto2pay.app/v2/metrics/deposits?date=2026-08-04" \
  -H "Authorization: YOUR_API_KEY"

Example Response

{
  "date": "2026-08-04",
  "pending": {
    "qtd": 184,
    "amount": 12577.80
  },
  "expired": {
    "qtd": 6663,
    "amount": 1296962.97
  },
  "paid": {
    "qtd": 48600,
    "amount": 4168422.03
  },
  "refunded": {
    "qtd": 105,
    "amount": 10397.10
  }
}

Response Fields

Field	Type	Description
date	string	The queried date in YYYY-MM-DD format
pending.qtd	number	Number of pending deposits
pending.amount	number	Total amount of pending deposits
expired.qtd	number	Number of expired deposits
expired.amount	number	Total amount of expired deposits
paid.qtd	number	Number of paid deposits
paid.amount	number	Total amount of paid deposits
refunded.qtd	number	Number of refunded deposits
refunded.amount	number	Total amount of refunded deposits

note

All amounts are in BRL. Timestamps use UTC-3 (Brasília timezone). Data updates in real time.