Skip to main content

List & Get Deposits


List Deposits​

Returns all deposits for your organization with pagination.

Endpoint​

GET /api/v2/organizations/{org_id}/deposits

Query Parameters​

ParameterTypeRequiredDescription
pageintegerNoPage number (default: 1)
quantityintegerNoItems 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​

ParameterTypeRequiredDescription
org_idstringYesYour organization ID
deposit_idstringYesDeposit 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​

FieldTypeDescription
paymentAddressstringTRON address the crypto was sent to
statusstringin_progress, completed, or failed
currencystringCrypto currency sent (USDTTRC20 or USDCTRC20)
amountstringCrypto amount received
feeCurrencystringCurrency the fee was charged in
feeAmountstringFee deducted from the deposit
settlementCurrencystringCurrency credited to wallet (usually USD)
settlementAmountstringAmount credited to wallet after fee
txHashstringBlockchain transaction hash (once confirmed)