Base URL: https://your-domain.com/apiAll endpoints on this page require Authorization: Bearer {token}.
Flow overview
Get available currencies
Call GET /get-deposit-currency-list.
Get available payment methods
Call POST /fees-limit-currency-payment-methods-is-active-payment-methods-list with the chosen currency.
Check amount and fees
Call GET /get-deposit-details-with-amount-limit-check.
Complete the deposit
Choose the appropriate payment endpoint: Stripe, PayPal, Bank, or CoinPayments.
GET /get-deposit-currency-list Returns the list of currencies available for deposit, filtered by active fee/limit rules.
Request parameters The authenticated user’s ID (used to determine the default wallet).
Response fields Key-value map of currency_id to {id, code, type}.
Currency ID of the user’s default wallet.
curl --request GET \ --url 'https://your-domain.com/api/get-deposit-currency-list?user_id=42' \ --header 'Authorization: Bearer {token}'
GET /get-deposit-bank-list Returns banks available for bank-transfer deposits for a given currency.
Request parameters The selected currency ID.
Response fields 200 on success, 401 if no banks found.
curl --request GET \ --url 'https://your-domain.com/api/get-deposit-bank-list?currency_id=1' \ --header 'Authorization: Bearer {token}'
POST /fees-limit-currency-payment-methods-is-active-payment-methods-list Returns the active payment methods available for a given currency and deposit transaction type.
Request parameters The selected currency ID.
The deposit transaction type ID.
Response fields Key-value map of payment_method_id to {id, name}.
curl --request POST \ --url https://your-domain.com/api/fees-limit-currency-payment-methods-is-active-payment-methods-list \ --header 'Authorization: Bearer {token}' \ --header 'Content-Type: application/json' \ --data '{"currency_id": 1, "currencyType": "fiat", "transaction_type_id": 2}'
GET /get-deposit-details-with-amount-limit-check Validates the deposit amount and returns a full fee breakdown.
Request parameters The authenticated user’s ID.
Selected payment method ID.
Response fields 200 on success, 401 on limit failure.
Failure reason: minLimit or minMaxLimit.
Calculated percentage fee.
Maximum deposit limit (null if unlimited).
User’s current wallet balance for this currency.
Name of the selected payment method.
curl --request GET \ --url 'https://your-domain.com/api/get-deposit-details-with-amount-limit-check?user_id=42&amount=200¤cy_id=1&paymentMethodId=3' \ --header 'Authorization: Bearer {token}'
POST /deposit/stripe-make-payment Initiates a Stripe card deposit by creating a payment intent.
Request parameters The authenticated user’s ID.
Card expiry month (1–12).
Card expiry year (4 digits).
Deposit amount (before fees).
Total amount including fees.
Payment method ID for Stripe.
Response fields 200 on success, 401 on failure.
Error message on failure.
Stripe payment intent ID. Pass to /deposit/stripe-confirm-payment.
Stripe payment method ID. Pass to /deposit/stripe-confirm-payment.
curl --request POST \ --url https://your-domain.com/api/deposit/stripe-make-payment \ --header 'Authorization: Bearer {token}' \ --header 'Content-Type: application/json' \ --data '{ "user_id": 42, "cardNumber": "4242424242424242", "month": 12, "year": 2026, "cvc": 123, "amount": 200, "totalAmount": 206, "currency_id": 1, "payment_method_id": 3 }'
POST /deposit/stripe-confirm-payment Confirms a Stripe payment intent and credits the user’s wallet.
Request parameters The authenticated user’s ID.
Stripe payment intent ID from /deposit/stripe-make-payment.
Stripe payment method ID from /deposit/stripe-make-payment.
Total amount including fees.
Response fields 200 on success, 401 on failure.
curl --request POST \ --url https://your-domain.com/api/deposit/stripe-confirm-payment \ --header 'Authorization: Bearer {token}' \ --header 'Content-Type: application/json' \ --data '{ "user_id": 42, "paymentIntendId": "pi_abc123", "paymentMethodId": "pm_xyz456", "amount": 200, "totalAmount": 206, "currency_id": 1, "payment_method_id": 3 }'
POST /deposit/get-paypal-info Retrieves the PayPal client ID and configuration for the given currency and payment method. Use the returned credentials to initialize the PayPal SDK on the client.
Request parameters The selected currency ID.
The PayPal payment method ID.
Response fields 200 on success, 401 if credentials not found.
Decoded PayPal configuration object (client_id, secret, mode, etc.).
curl --request POST \ --url https://your-domain.com/api/deposit/get-paypal-info \ --header 'Authorization: Bearer {token}' \ --header 'Content-Type: application/json' \ --data '{"currency_id": 1, "method_id": 4}'
POST /deposit/paypal-payment-store Records a completed PayPal deposit. Call this after the PayPal SDK confirms a COMPLETED transaction.
Request parameters The authenticated user’s ID.
Deposit amount (before fees).
PayPal payment method ID.
PayPal order details object returned by the SDK. Must contain status: "COMPLETED".
Response fields 200 on success, 401 on failure.
Created transaction record.
curl --request POST \ --url https://your-domain.com/api/deposit/paypal-payment-store \ --header 'Authorization: Bearer {token}' \ --header 'Content-Type: application/json' \ --data '{ "user_id": 42, "amount": 200, "currency_id": 1, "paymentMethodId": 4, "details": {"status": "COMPLETED", "id": "PAYPAL-ORDER-ID"} }'
POST /deposit/bank-payment-store Records a bank transfer deposit. The deposit is created with Pending status and must be confirmed by an administrator.
Request parameters The authenticated user’s ID.
The bank ID from /get-deposit-bank-list.
Payment method ID for the bank.
Payment method name (e.g. Bank).
Optional proof-of-payment file upload (multipart/form-data).
Response fields 200 on success, 401 on error.
Bank deposits are created as Pending and require admin approval before funds are credited.
curl --request POST \ --url https://your-domain.com/api/deposit/bank-payment-store \ --header 'Authorization: Bearer {token}' \ --form 'user_id=42' \ --form 'currency_id=1' \ --form 'amount=500' \ --form 'bank_id=2' \ --form 'deposit_payment_id=5' \ --form 'deposit_payment_name=Bank' \ --form 'totalFees=5' \ --form 'file=@/path/to/receipt.pdf'
POST /deposit/coinpayments-payment-store Initiates a CoinPayments crypto deposit. Returns a payment address and QR code URL.
Request parameters The authenticated user’s ID.
Cryptocurrency currency ID.
CoinPayments payment method ID.
Response fields 200 on success, 401 on failure.
URL of the payment QR code image.
Crypto wallet address to send funds to.
Unix timestamp of transaction creation.
Unix timestamp when the address expires.
curl --request POST \ --url https://your-domain.com/api/deposit/coinpayments-payment-store \ --header 'Authorization: Bearer {token}' \ --header 'Content-Type: application/json' \ --data '{ "user_id": 42, "currency_id": 10, "amount": 0.005, "totalFees": 0.0001, "currency_type": "crypto", "deposit_payment_id": 6 }'
