List & Get Deposits
List Deposits​
Returns all deposits for your organization with pagination.
Endpoint​
GET /api/v2/organizations/{org_id}/deposits
Query Parameters​
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number (default: 1) |
quantity | integer | No | Items per page (default: 25) |
Request​
curl "https://api.4pay.cc/api/v2/organizations/{org_id}/deposits" \
-H "Authorization: Bearer YOUR_API_KEY"
Response​
200 OK
{
"data": [
{
"id": "abc123e4-5678-90ab-cdef-1234567890ab",
"status": "completed",
"currency": "USDTTRC20",
"amount": "100.00",
"settlementCurrency": "USD",
"settlementAmount": "99.50",
"createdAt": "2025-06-02T15:38:49+00:00"
},
{
"id": "def456e7-8901-23ab-cdef-4567890abcde",
"status": "in_progress",
"currency": "USDCTRC20",
"amount": "0.00",
"settlementCurrency": "USD",
"settlementAmount": "0.00",
"createdAt": "2025-06-03T10:00:00+00:00"
}
],
"pagination": {
"quantity": 25,
"totalQuantity": 2,
"currentPage": 1,
"pages": 1
}
}
Get Deposit Details​
Returns detailed information about a specific deposit, including fee breakdown and blockchain transaction hash.
Endpoint​
GET /api/v2/organizations/{org_id}/deposits/{deposit_id}
Path Parameters​
| Parameter | Type | Required | Description |
|---|---|---|---|
org_id | string | Yes | Your organization ID |
deposit_id | string | Yes | Deposit UUID |
Request​
curl "https://api.4pay.cc/api/v2/organizations/{org_id}/deposits/{deposit_id}" \
-H "Authorization: Bearer YOUR_API_KEY"
Response​
200 OK
{
"data": {
"id": "abc123e4-5678-90ab-cdef-1234567890ab",
"paymentAddress": "TXYZabc123def456ghi789jkl012mno345",
"status": "completed",
"currency": "USDTTRC20",
"amount": "100.00",
"feeCurrency": "USDTTRC20",
"feeAmount": "0.50",
"settlementCurrency": "USD",
"settlementAmount": "99.50",
"txHash": "abc123def456789...",
"createdAt": "2025-06-02T15:38:49+00:00"
}
}
Response Fields​
| Field | Type | Description |
|---|---|---|
paymentAddress | string | TRON address the crypto was sent to |
status | string | in_progress, completed, or failed |
currency | string | Crypto currency sent (USDTTRC20 or USDCTRC20) |
amount | string | Crypto amount received |
feeCurrency | string | Currency the fee was charged in |
feeAmount | string | Fee deducted from the deposit |
settlementCurrency | string | Currency credited to wallet (usually USD) |
settlementAmount | string | Amount credited to wallet after fee |
txHash | string | Blockchain transaction hash (once confirmed) |