Deposit Banks

Get deposit count grouped by payer bank for a given period.

info

This endpoint is only available in production.

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

Endpoint

GET /v2/metrics/deposits/banks

Query Parameters

Parameter	Type	Required	Description
start	string	required	Start datetime in YYYY-MM-DD HH:MM:SS format
end	string	required	End datetime in YYYY-MM-DD HH:MM:SS format

Example Request

curl -X GET "https://api-pix.crypto2pay.app/v2/metrics/deposits/banks?start=2026-08-01%2000%3A00%3A00&end=2026-08-04%2023%3A59%3A59" \
  -H "Authorization: YOUR_API_KEY"

Example Response

[
  {
    "count": 23130,
    "ispb": "18236120",
    "bank_name": "NU PAGAMENTOS - IP"
  },
  {
    "count": 6985,
    "ispb": "22896431",
    "bank_name": "PICPAY"
  }
]

Response Fields

Field	Type	Description
count	number	Number of deposits from this bank
ispb	string	ISPB code identifying the bank
bank_name	string	Full name of the payer bank

note

Results are sorted by count in descending order.