API documentation
Quotes
Transfers
Deposits
Balance
List deposits by asset
Copy
curl --request GET \
--url https://api.brl.xyz/api/v0/assets/{asset}/depositsCopy
{
"deposits": [
{
"id": "660e8400-e29b-41d4-a716-446655440001",
"type": "pix",
"amount": "100.50",
"status": "credited",
"coordinates": {
"source-tax-id": "12345678900",
"source-bank-code": "341",
"source-type": "pix",
"source-account-number": "12345-6",
"source-branch-code": "0001",
"target": "<string>"
},
"created-at": "2024-01-15T10:30:00Z",
"processed-at": "2024-01-15T10:30:00Z"
}
]
}Deposits
List Deposits
Retrieves a list of deposits for the authenticated user for a specific asset type. Asset can be ‘brl’, ‘usd’, ‘usdc’ or ‘usdt’
GET
/
api
/
v0
/
assets
/
{asset}
/
deposits
List deposits by asset
Copy
curl --request GET \
--url https://api.brl.xyz/api/v0/assets/{asset}/depositsCopy
{
"deposits": [
{
"id": "660e8400-e29b-41d4-a716-446655440001",
"type": "pix",
"amount": "100.50",
"status": "credited",
"coordinates": {
"source-tax-id": "12345678900",
"source-bank-code": "341",
"source-type": "pix",
"source-account-number": "12345-6",
"source-branch-code": "0001",
"target": "<string>"
},
"created-at": "2024-01-15T10:30:00Z",
"processed-at": "2024-01-15T10:30:00Z"
}
]
}Path Parameters
Available options:
usdc, usdt, brl, usd Response
Deposits list retrieved successfully
- BRL Deposits
- Token Deposits
- USD Deposits
Show child attributes
Show child attributes
Unique identifier for the BRL deposit
Example:
"660e8400-e29b-41d4-a716-446655440001"
Type of deposit
Available options:
token, pix, manual-fx Example:
"pix"
Amount of the deposit in BRL
Example:
"100.50"
Current status of the deposit
Available options:
created, credited, voided, confirmed Example:
"credited"
Source banking information for the BRL deposit
Show child attributes
Show child attributes
Tax ID of the sender (CPF/CNPJ)
Example:
"12345678900"
Bank code of the sender
Example:
"341"
Type of BRL transfer
Available options:
ted, pix Example:
"pix"
Account number of the sender
Example:
"12345-6"
Branch code of the sender
Example:
"0001"
ISO 8601 timestamp when the deposit was created
Example:
"2024-01-15T10:30:00Z"
ISO 8601 timestamp when the deposit was processed
Example:
"2024-01-15T10:30:00Z"
⌘I