Viewing Deposit Transactions
Query and retrieve deposit transaction history across PayPal, Bank, and cryptocurrency payment methods
Viewing Deposit Transactions
Query and retrieve deposit transaction history across PayPal, Bank, and cryptocurrency payment methods
Overview
These query endpoints allow users and administrators to retrieve deposit transaction records across different payment methods. The API provides comprehensive querying capabilities with filtering, ordering, and status-based retrieval options for PayPal, Bank, and Coinpayment (cryptocurrency) deposit transactions.
📋 Transaction Types
Three categories of deposit transactions are available:
Fiat deposits via PayPal checkout
Wire transfers and bank deposits
Blockchain cryptocurrency deposits
PayPal Deposit Transactions
Get All PayPal Deposit Transactions
Query Schema
getAllPaypalDepositTxns(
orderBy: String
): [PaypalDepositTransaction]Parameters:
orderBy(String, Optional) - The field to order the results by (e.g., "createdAt", "amount")
Example:
query {
getAllPaypalDepositTxns(orderBy: "createdAt") {
id
userId
amount
currencyCode
status
createdAt
}
}Get PayPal Deposit Transactions by User
Query Schema
getPaypalDepositTxnsByUser(
orderBy: String,
showStatus: Int
): [PaypalDepositTransaction]Parameters:
orderBy(String, Optional) - The field to order the results byshowStatus(Int, Optional) - Filter by visibility status (0 = hidden, 1 = visible)
Example:
query {
getPaypalDepositTxnsByUser(orderBy: "createdAt", showStatus: 1) {
id
amount
currencyCode
status
orderId
createdAt
}
}Get PayPal Deposit Transaction by ID
Query Schema
getPaypalDepositTxnById(
id: Int,
showStatus: Int
): PaypalDepositTransactionParameters:
id(Int, Optional) - The ID of the transactionshowStatus(Int, Optional) - Filter by visibility status
Example:
query {
getPaypalDepositTxnById(id: 123, showStatus: 1) {
id
userId
amount
currencyCode
orderId
status
createdAt
updatedAt
}
}Bank Deposit Transactions
Get All Bank Deposit Transactions
Query Schema
getAllBankDepositTxns(
orderBy: String
): [BankDepositTransaction]Parameters:
orderBy(String, Optional) - The field to order the results by
Example:
query {
getAllBankDepositTxns(orderBy: "createdAt") {
transactionId
userId
amount
currencyCode
status
createdAt
}
}Get Bank Deposit Transactions by User
Query Schema
getBankDepositTxnsByUser(
orderBy: String,
showStatus: Int
): [BankDepositTransaction]Parameters:
orderBy(String, Optional) - The field to order the results byshowStatus(Int, Optional) - Filter by visibility status
Example:
query {
getBankDepositTxnsByUser(orderBy: "createdAt", showStatus: 1) {
transactionId
amount
currencyCode
status
createdAt
}
}Get Bank Deposit Transaction by ID
Query Schema
getBankDepositTxnById(
id: Int,
showStatus: Int
): BankDepositTransactionParameters:
id(Int, Optional) - The ID of the transactionshowStatus(Int, Optional) - Filter by visibility status
Example:
query {
getBankDepositTxnById(id: 456, showStatus: 1) {
transactionId
userId
amount
currencyCode
status
createdAt
updatedAt
}
}Get Bank Deposit Transaction by ID (Admin)
Query Schema
getBankDepositTxnByIdByAdmin(
id: Int
): BankDepositTransactionAdmin Access Required
This query is accessible only to users with ADMIN privileges.
Parameters:
id(Int, Optional) - The ID of the transaction
Example:
query {
getBankDepositTxnByIdByAdmin(id: 789) {
transactionId
userId
amount
currencyCode
cryptoType
status
createdAt
updatedAt
}
}Get Unconfirmed Bank Deposit Transactions
Query Schema
getUnconfirmedBankDepositTxns: [BankDepositTransaction]Parameters: None
Example:
query {
getUnconfirmedBankDepositTxns {
transactionId
userId
amount
currencyCode
status
createdAt
}
}Get Unconfirmed Bank Deposit Transactions by User
Query Schema
getUnconfirmedBankDepositTxnsByUser: [BankDepositTransaction]Parameters: None
Example:
query {
getUnconfirmedBankDepositTxnsByUser {
transactionId
amount
currencyCode
status
createdAt
}
}Coinpayment (Cryptocurrency) Deposit Transactions
Get All Coinpayment Deposit Transactions
Query Schema
getCoinpaymentDepositTx: [CoinpaymentDepositTransaction]Parameters: None
Example:
query {
getCoinpaymentDepositTx {
txnId
userId
coin
network
depositAddress
status
createdAt
}
}Get Coinpayment Deposit Transactions by User
Query Schema
getCoinpaymentDepositTxByUser(
showStatus: Int
): [CoinpaymentDepositTransaction]Parameters:
showStatus(Int, Optional) - Filter by visibility status
Example:
query {
getCoinpaymentDepositTxByUser(showStatus: 1) {
txnId
coin
network
depositAddress
amount
status
createdAt
}
}Get Coinpayment Deposit Transactions by Admin
Query Schema
getCoinpaymentDepositTxByAdmin(
userId: Int
): [CoinpaymentDepositTransaction]Admin Access Required
This query is accessible only to users with ADMIN privileges.
Parameters:
userId(Int, Optional) - The ID of the user to filter by
Example:
query {
getCoinpaymentDepositTxByAdmin(userId: 123) {
txnId
userId
coin
network
depositAddress
amount
status
createdAt
updatedAt
}
}Get Coinpayment Deposit Transaction by ID
Query Schema
getCoinpaymentDepositTxById(
id: Int
): CoinpaymentDepositTransactionParameters:
id(Int, Optional) - The ID of the transaction
Example:
query {
getCoinpaymentDepositTxById(id: 456) {
txnId
userId
coin
network
cryptoType
depositAddress
amount
confirmations
status
createdAt
updatedAt
}
}Common Query Patterns
Recent Transactions
Order by creation date to show most recent deposits first
orderBy: "createdAt"High-Value Deposits
Order by amount to prioritize large deposits
orderBy: "amount"Visible Transactions
Filter to show only visible transactions
showStatus: 1Pending Confirmations
Query unconfirmed deposits awaiting approval
getUnconfirmedBankDepositTxnsUse Cases
Transaction History
Display comprehensive deposit history to users for accounting and tracking purposes.
Audit & Compliance
Enable administrators to review and audit all deposit transactions for compliance.
Financial Reporting
Generate financial reports and analytics based on deposit transaction data.
Support & Troubleshooting
Quickly look up specific transactions to assist users with deposit-related inquiries.
Important Notes
Default Ordering
When no orderBy parameter is specified, transactions are typically returned in their default database order. For chronological ordering, explicitly specify orderBy: "createdAt".
Show Status Filtering
The showStatus parameter allows filtering transactions by visibility. When not specified, the behavior depends on the specific query - some may return all transactions while others may filter by default. Always specify this parameter explicitly for predictable results.
💡 Best Practices
- •Implement pagination for queries that return large result sets to improve performance
- •Cache frequently accessed transaction data to reduce database load
- •Use specific queries (by ID) instead of fetching all transactions when possible
- •Filter by showStatus to respect user privacy preferences for hidden transactions
- •Implement date range filtering on the client side for better transaction browsing