HOPPA API Reference
The HOPPA API is a REST API for embedded finance: create users, issue and manage cards, open accounts and wallets, exchange currencies, and move money. Authenticate every request with an x-api-key header. The interactive reference below is generated live from the OpenAPI 3.0 specification (JSON), so it always matches the current API. New to HOPPA? Start with the Quickstart — a user, a card, a top-up, and your first transaction in four calls.
Endpoints by resource
402 endpoints across 26 resources — each with its own reference page.
AdminReferrals
AdminVouchers
- GET
/api/v2/admin/vouchers - POST
/api/v2/admin/vouchers - GET
/api/v2/admin/vouchers/api-keys - POST
/api/v2/admin/vouchers/api-keys - DELETE
/api/v2/admin/vouchers/api-keys/{id} - GET
/api/v2/admin/vouchers/approvals - POST
/api/v2/admin/vouchers/approvals/{id} - POST
/api/v2/admin/vouchers/assignments - POST
/api/v2/admin/vouchers/assignments/from-group - POST
/api/v2/admin/vouchers/assignments/mass - GET
/api/v2/admin/vouchers/audit - POST
/api/v2/admin/vouchers/batch - PUT
/api/v2/admin/vouchers/companies/{companyId}/activation - GET
/api/v2/admin/vouchers/company-statuses - GET
/api/v2/admin/vouchers/dashboard - GET
/api/v2/admin/vouchers/groups - POST
/api/v2/admin/vouchers/groups - PUT
/api/v2/admin/vouchers/groups/{id}/status/{status} - POST
/api/v2/admin/vouchers/imports/preview - GET
/api/v2/admin/vouchers/imports/template - POST
/api/v2/admin/vouchers/imports/{id}/confirm - GET
/api/v2/admin/vouchers/jobs - GET
/api/v2/admin/vouchers/jobs/{id} - GET
/api/v2/admin/vouchers/jobs/{id}/codes/export - GET
/api/v2/admin/vouchers/jobs/{id}/items - POST
/api/v2/admin/vouchers/jobs/{id}/retry - GET
/api/v2/admin/vouchers/liability - POST
/api/v2/admin/vouchers/liability/preview - GET
/api/v2/admin/vouchers/module-status - POST
/api/v2/admin/vouchers/redeem-for-user - GET
/api/v2/admin/vouchers/redemptions/{id} - POST
/api/v2/admin/vouchers/redemptions/{id}/retry - POST
/api/v2/admin/vouchers/redemptions/{id}/reversal - GET
/api/v2/admin/vouchers/reports/daily-statistics - GET
/api/v2/admin/vouchers/reports/liability-snapshots - GET
/api/v2/admin/vouchers/reports/redemptions - GET
/api/v2/admin/vouchers/reports/{report}/export - POST
/api/v2/admin/vouchers/reversals/bulk - GET
/api/v2/admin/vouchers/rules - POST
/api/v2/admin/vouchers/rules - PUT
/api/v2/admin/vouchers/rules/{id}/enabled/{enabled} - PUT
/api/v2/admin/vouchers/settings - PUT
/api/v2/admin/vouchers/settings/global - POST
/api/v2/admin/vouchers/{id}/reveal - PUT
/api/v2/admin/vouchers/{id}/status/{status}
Authentication
User authentication and token management
Banking
- GET
/api/v2/banking/accountsGet all accounts across all banking providers - POST
/api/v2/banking/accounts/fund-testFund an Equals Money account with a sandbox test credit. - GET
/api/v2/banking/balanceGet aggregated balance across all banking providers - POST
/api/v2/banking/budgets/{budgetId}/transfer - POST
/api/v2/banking/equalsmoney-onboardingCreate an EqualsMoney personal onboarding application - POST
/api/v2/banking/orders/quote - POST
/api/v2/banking/orders/trade - POST
/api/v2/banking/otp/resendResend the OTP code for a pending banking operation. - POST
/api/v2/banking/otp/verifyVerify an OTP code for a pending banking operation such as payout creation. - GET
/api/v2/banking/payeesList payees across all banking providers - POST
/api/v2/banking/payeesPayee Step 1: validate a new payee and send the OTP required by Equals Money. - POST
/api/v2/banking/payees/confirmPayee Step 2: create and confirm the payee after OTP verification. - GET
/api/v2/banking/payees/required-fieldsGet required fields for payee creation - DELETE
/api/v2/banking/payees/{payeeId}Delete a payee from ALL banking providers where user has accounts - GET
/api/v2/banking/payoutsList payout transactions for the authenticated user or API-key selected user. - POST
/api/v2/banking/payoutsPayout Step 4: create the payout after OTP verification. - POST
/api/v2/banking/payouts/checkPayout Step 2: check the quoted payout before OTP approval. - POST
/api/v2/banking/payouts/initiatePayout Step 3: send the OTP for a checked payout. - GET
/api/v2/banking/payouts/{payoutId}Get a payout transaction by ID for the authenticated user or API-key selected user. - GET
/api/v2/banking/providersGet list of banking providers the current user has accounts with - POST
/api/v2/banking/quotationsPayout Step 1: create a quote for an existing payee. - POST
/api/v2/banking/quotesGet a quote for a transfer - POST
/api/v2/banking/trades/executeExecute FX trade - POST
/api/v2/banking/trades/quoteGet FX trade quote - GET
/api/v2/banking/transactionsGet transactions across all banking providers - POST
/api/v2/banking/transfers/internalExecute an internal transfer between balances for a specific user within the authenticated company. - GET
/api/v2/banking/users/{userId}/budgets - POST
/api/v2/banking/users/{userId}/budgets - GET
/api/v2/banking/users/{userId}/budgets/{budgetId} - PUT
/api/v2/banking/users/{userId}/budgets/{budgetId}Updates user-editable budget details. Budget status is managed by Equals Money and is read-only. - POST
/api/v2/banking/users/{userId}/budgets/{budgetId}/transfer - GET
/api/v2/banking/users/{userId}/equals-banking-infoGet Equals banking information for a specific user in the authenticated company.
BusinessOnboarding
- GET
/api/v2/business/onboarding/applicationGet the current application status - POST
/api/v2/business/onboarding/applicationCreate a business application for KYB - POST
/api/v2/business/onboarding/application/documentsUpload an EqualsMoney business onboarding document - POST
/api/v2/business/onboarding/application/submitSubmit the application for review - GET
/api/v2/business/onboarding/associated-peopleGet associated people for the current user - POST
/api/v2/business/onboarding/associated-peopleCreate associated people for a business application (Directors, UBOs, Applicants) - POST
/api/v2/business/onboarding/associated-people/{associatedPersonId}/documentsUpload an EqualsMoney associated person onboarding document - GET
/api/v2/business/onboarding/optionsGet canonical EqualsMoney KYB onboarding option values for client select fields.
Card Loads
Asynchronous crypto-to-fiat card loads executed through the crypto on/off-ramp
Cards
Card management operations
- GET
/api/v2/cardsGet list of cards for a user - POST
/api/v2/cardsCreate a new card - GET
/api/v2/cards/cardHoldersGet list of card holders for a user - GET
/api/v2/cards/physical-card-feesGet the card platform physical card production and mailing fees for a user and destination country - GET
/api/v2/cards/quantum-topup/estimateEstimate Quantum top-up conversion using CryptoConnect quotes for USD to USDT/USDC and USDT/USDC to USD - POST
/api/v2/cards/topupTopUp - Direct card top-up with card ID - POST
/api/v2/cards/unload-cardUnloadFromCard - Unload funds from a card to quantum wallet - GET
/api/v2/cards/{cardId}Get detailed card information including sensitive data - DELETE
/api/v2/cards/{cardId}Permanently delete an card. - POST
/api/v2/cards/{cardId}/activateActivate a physical card - PUT
/api/v2/cards/{cardId}/auto-lockEnable or disable Auto Lock for a card - POST
/api/v2/cards/{cardId}/bulk-shipExecute the card platform physical card shipment for the authenticated user's card. - GET
/api/v2/cards/{cardId}/bulk-ship/quoteQuote the card platform physical card shipment fees for the authenticated user's card. - POST
/api/v2/cards/{cardId}/bulk-ship/quoteQuote the card platform physical card shipment fees for the authenticated user's card. - POST
/api/v2/cards/{cardId}/enableEnable (unfreeze) a card to re-enable it - POST
/api/v2/cards/{cardId}/freezeFreeze a card to temporarily disable it - PUT
/api/v2/cards/{cardId}/limitsUpdate card spending limits (daily/weekly/monthly) for a specific user and card - PUT
/api/v2/cards/{cardId}/pinUpdate card PIN - GET
/api/v2/cards/{cardId}/transactionsGet card transactions for a specific user and card - GET
/api/v2/cards/{cardId}/widgetGet secure widget URL for displaying card details in an iframe
Crypto Virtual Accounts
the crypto on/off-ramp Trading API account discovery, funding instructions, route discovery, quotes, execution, and settlement tracking
- POST
/api/v2/crypto-virtual-accounts - POST
/api/v2/crypto-virtual-accounts/bank-address-bookRegister a the crypto on/off-ramp fiat external account - POST
/api/v2/crypto-virtual-accounts/equals-to-interlaceEqualsMoney-to-the card platform transfer (not configured) - POST
/api/v2/crypto-virtual-accounts/equals-to-wallet/confirm - POST
/api/v2/crypto-virtual-accounts/equals-to-wallet/initiate - POST
/api/v2/crypto-virtual-accounts/equalsmoney-depositsDeposit crypto into an EqualsMoney budget through the crypto on/off-ramp - GET
/api/v2/crypto-virtual-accounts/equalsmoney-deposits/{id}Get a the crypto on/off-ramp-to-EqualsMoney deposit - POST
/api/v2/crypto-virtual-accounts/interlace-to-equals/confirmConfirm an the card platform-to-EqualsMoney transfer through the crypto on/off-ramp - POST
/api/v2/crypto-virtual-accounts/interlace-to-equals/initiateInitiate an the card platform-to-EqualsMoney transfer through the crypto on/off-ramp - POST
/api/v2/crypto-virtual-accounts/payin-address - POST
/api/v2/crypto-virtual-accounts/ramp-quote - GET
/api/v2/crypto-virtual-accounts/swap-targets - GET
/api/v2/crypto-virtual-accounts/trading-overview
DiscountCodes
- GET
/api/v2/admin/discount-codesGets all discount codes for the authenticated user's company - POST
/api/v2/admin/discount-codesCreates a new discount code - PUT
/api/v2/admin/discount-codes/cards/{cardId}/discountUpdates a card's discount code (for admin use) - GET
/api/v2/admin/discount-codes/{id}Gets a specific discount code by ID - PUT
/api/v2/admin/discount-codes/{id}Updates an existing discount code - DELETE
/api/v2/admin/discount-codes/{id}Deletes a discount code
DualBalance
Loyalty Program
- POST
/api/loyalty-programs/auto-assign/bulkBulk process transactions for automatic point assignment (legacy endpoint compatibility). - POST
/api/loyalty-programs/auto-assign/card-transactionProcess card transaction for automatic point assignment (legacy endpoint compatibility). - POST
/api/loyalty-programs/auto-assign/payment-requestProcess payment request for automatic point assignment (legacy endpoint compatibility). - POST
/api/loyalty-programs/auto-assign/reverseReverse point assignment (legacy endpoint compatibility). - GET
/api/loyalty-programs/auto-assign/stats/{loyaltyProgramId}Get point assignment statistics for a loyalty program (legacy endpoint compatibility). - GET
/api/loyalty-programs/merchantsGet merchants with filtering (legacy endpoint compatibility). - POST
/api/loyalty-programs/merchantsCreate merchant (legacy endpoint compatibility). - GET
/api/loyalty-programs/merchants/statsGet merchant statistics (legacy endpoint compatibility). - PUT
/api/loyalty-programs/merchants/{merchantId}Update merchant (legacy endpoint compatibility). - DELETE
/api/loyalty-programs/merchants/{merchantId}Delete merchant (legacy endpoint compatibility). - GET
/api/loyalty-programs/merchants/{merchantId}/idsGet merchant IDs for a specific merchant (legacy endpoint compatibility). - POST
/api/loyalty-programs/merchants/{merchantId}/idsAdd merchant ID (legacy endpoint compatibility). - GET
/api/loyalty-programs/programs/{companyId}Get loyalty programs for a specific company (legacy endpoint compatibility). - POST
/api/loyalty-programs/transaction-import/configsCreate transaction import configuration (legacy endpoint compatibility). - GET
/api/loyalty-programs/transaction-import/configs/{companyId}Get transaction import configurations for a company (legacy endpoint compatibility). - GET
/api/loyalty-programs/transaction-import/jobs/{companyId}Get transaction import jobs for a company (legacy endpoint compatibility). - GET
/api/loyalty-programs/transaction-import/transactions/{jobId}Get imported transactions for a specific job (legacy endpoint compatibility). - POST
/api/loyalty-programs/transaction-import/upload/{configId}Upload file for transaction import (legacy endpoint compatibility). - POST
/api/v2/loyalty/auto-assign/bulkProcess multiple transactions in bulk for automatic point assignment - POST
/api/v2/loyalty/auto-assign/card-transactionProcess automatic point assignment for a card transaction - POST
/api/v2/loyalty/auto-assign/payment-requestProcess automatic point assignment for a payment request - POST
/api/v2/loyalty/auto-assign/reverseReverse a point assignment with audit trail support - GET
/api/v2/loyalty/auto-assign/stats/{loyaltyProgramId}Get point assignment statistics for a loyalty program - GET
/api/v2/loyalty/balancesGet point balances for all users (admin view) - GET
/api/v2/loyalty/geographic-analyticsGet geographic analytics with regional performance data - GET
/api/v2/loyalty/geographic-analytics/exportExport geographic analytics data to CSV format - GET
/api/v2/loyalty/location-insightsGet location insights with city and country performance rankings - GET
/api/v2/loyalty/merchant-categoriesGet merchant categories for analytics filtering - GET
/api/v2/loyalty/merchantsGet merchants with search, filtering, and pagination - POST
/api/v2/loyalty/merchantsCreate a new merchant for the authenticated company - GET
/api/v2/loyalty/merchants/statsGet merchant statistics including transaction counts and revenue metrics - PUT
/api/v2/loyalty/merchants/{merchantId}Update an existing merchant - DELETE
/api/v2/loyalty/merchants/{merchantId}Delete a merchant with cascade validation - GET
/api/v2/loyalty/merchants/{merchantId}/idsGet merchant IDs for a specific merchant - POST
/api/v2/loyalty/merchants/{merchantId}/idsCreate a new merchant ID for a specific merchant - PUT
/api/v2/loyalty/merchants/{merchantId}/ids/{midId}Update an existing merchant ID - DELETE
/api/v2/loyalty/merchants/{merchantId}/ids/{midId}Delete a merchant ID - GET
/api/v2/loyalty/merchants/{merchantId}/loyalty-rulesGet merchant loyalty rules for a specific merchant - POST
/api/v2/loyalty/merchants/{merchantId}/loyalty-rulesCreate a new merchant loyalty rule - PUT
/api/v2/loyalty/merchants/{merchantId}/loyalty-rules/{ruleId}Update an existing merchant loyalty rule - DELETE
/api/v2/loyalty/merchants/{merchantId}/loyalty-rules/{ruleId}Delete a merchant loyalty rule - GET
/api/v2/loyalty/programsGet loyalty program configuration for the authenticated company - POST
/api/v2/loyalty/programsCreate or update loyalty program for the authenticated company - PUT
/api/v2/loyalty/programsUpdate loyalty program for the authenticated company - GET
/api/v2/loyalty/rulesGet all loyalty rules for the authenticated company's loyalty program - POST
/api/v2/loyalty/rulesCreate a new loyalty rule for the authenticated company's loyalty program - PUT
/api/v2/loyalty/rules/{ruleId}Update an existing loyalty rule - DELETE
/api/v2/loyalty/rules/{ruleId}Delete a loyalty rule with referential integrity checks - GET
/api/v2/loyalty/statsGet comprehensive loyalty program statistics - POST
/api/v2/loyalty/test-calculationTest point calculation for a transaction - GET
/api/v2/loyalty/transaction-import/configsGet all transaction import configurations for the authenticated company - POST
/api/v2/loyalty/transaction-import/configsCreate a new transaction import configuration - GET
/api/v2/loyalty/transaction-import/jobsGet import job history with status and statistics - GET
/api/v2/loyalty/transaction-import/jobs/details/{jobId}Get detailed information about a specific import job - POST
/api/v2/loyalty/transaction-import/upload/{configId}Upload and process a transaction import file - GET
/api/v2/loyalty/transactionsGet point transactions for all users (admin view) - GET
/api/v2/loyalty/user-balanceGet point balance for the authenticated user - GET
/api/v2/loyalty/user-transactionsGet point transaction history for the authenticated user - GET
/api/v2/loyalty/user/dashboardGet comprehensive user dashboard data with auto-enrollment - GET
/api/v2/loyalty/user/redemption-optionsGet available redemption options for the authenticated user - GET
/api/v2/loyalty/user/transactionsGet user point transactions with advanced filtering
MOR
Merchant of Record onboarding, users, cards, secure card widgets, and company wallets
- POST
/api/v2/mor/public/cardholderCreate or return the merchant's company-level CORPORATE_MANAGED cardholder. - GET
/api/v2/mor/public/cardsGet all merchant cards with their current available and pending balances. - POST
/api/v2/mor/public/cards/batchOrder 1-20 prepaid cards in a batch. - POST
/api/v2/mor/public/cards/{cardId}/assignAssign a merchant-owned card to a user_simple in the same company. - POST
/api/v2/mor/public/cards/{cardId}/loadLoad a merchant-owned card from the merchant's account. - GET
/api/v2/mor/public/cards/{cardId}/secure-widgetGet a secure hosted card-information widget. - POST
/api/v2/mor/public/cards/{cardId}/unloadUnload a merchant-owned card to the merchant's account. - POST
/api/v2/mor/public/kybSubmit or resubmit KYB for the API key's MoR merchant. - GET
/api/v2/mor/public/onboarding-statusGet the merchant onboarding status; optionally refresh it from the card platform. - POST
/api/v2/mor/public/usersAdd a user_simple to the API key's MoR company. - GET
/api/v2/mor/public/users/{userId}/cardsGet one user_simple's assigned cards and aggregate card balances. - GET
/api/v2/mor/public/walletsGet merchant wallets, deposit addresses, and fiat/crypto balances.
Onboarding
Payments
Payment processing and transaction management
- GET
/api/v2/payments/assets/co-brandGet co-brand assets - POST
/api/v2/payments/createCreate a payment with automatic currency exchange and transfer - GET
/api/v2/payments/mandatesList payment mandates with filtering and pagination - POST
/api/v2/payments/mandatesCreate a payment mandate - GET
/api/v2/payments/mandates/{mandateId}Get payment mandate by ID - PUT
/api/v2/payments/mandates/{mandateId}/revokeRevoke a payment mandate - POST
/api/v2/payments/payoutsCreate a payout - GET
/api/v2/payments/requestsList payment requests with filtering and pagination - POST
/api/v2/payments/requestsCreate a payment request - GET
/api/v2/payments/requests/{requestId}Get payment request by ID - PUT
/api/v2/payments/requests/{requestId}/cancelCancel a payment request - POST
/api/v2/payments/withdrawalsCreate a withdrawal - POST
/api/v2/payments/withdrawals/feeGet withdrawal fee estimate
PublicUserReferrals
- POST
/api/v2/users/{userId}/referrals/attributionCreates the immutable rewarded relationship after registration succeeds. - GET
/api/v2/users/{userId}/referrals/commissionsReturns the user's referral commission history. - GET
/api/v2/users/{userId}/referrals/summaryReturns invite, level progress, referral counts, commission totals, and payout mode. - GET
/api/v2/users/{userId}/referrals/vouchersLists assigned vouchers that can be rendered in a WL-hosted user experience. - POST
/api/v2/users/{userId}/referrals/vouchers/redeem-allInitiates all eligible assigned vouchers through the existing voucher processor. - POST
/api/v2/users/{userId}/referrals/vouchers/{assignmentId}/redeemRedeems an assigned voucher without exposing or typing its voucher code.
PublicVouchers
- GET
/api/v2/vouchers - POST
/api/v2/vouchers - GET
/api/v2/vouchers/approvals - POST
/api/v2/vouchers/approvals/{id} - POST
/api/v2/vouchers/assignments - POST
/api/v2/vouchers/assignments/from-group - POST
/api/v2/vouchers/assignments/mass - GET
/api/v2/vouchers/audit - POST
/api/v2/vouchers/batch - GET
/api/v2/vouchers/groups - POST
/api/v2/vouchers/groups - PUT
/api/v2/vouchers/groups/{id}/status/{status} - POST
/api/v2/vouchers/imports/preview - GET
/api/v2/vouchers/imports/template - POST
/api/v2/vouchers/imports/{id}/confirm - GET
/api/v2/vouchers/jobs - GET
/api/v2/vouchers/jobs/{id} - GET
/api/v2/vouchers/jobs/{id}/codes/export - GET
/api/v2/vouchers/jobs/{id}/items - POST
/api/v2/vouchers/jobs/{id}/retry - GET
/api/v2/vouchers/liability - POST
/api/v2/vouchers/liability/preview - POST
/api/v2/vouchers/redemptions - GET
/api/v2/vouchers/redemptions/{id} - DELETE
/api/v2/vouchers/redemptions/{id} - POST
/api/v2/vouchers/redemptions/{id}/retry - POST
/api/v2/vouchers/redemptions/{id}/reversal - POST
/api/v2/vouchers/redemptions/{id}/verification/resend - POST
/api/v2/vouchers/redemptions/{id}/verify - GET
/api/v2/vouchers/reports/daily-statistics - GET
/api/v2/vouchers/reports/liability-snapshots - GET
/api/v2/vouchers/reports/redemptions - GET
/api/v2/vouchers/reports/{report}/export - GET
/api/v2/vouchers/rules - POST
/api/v2/vouchers/rules - PUT
/api/v2/vouchers/rules/{id}/enabled/{enabled} - GET
/api/v2/vouchers/settings - PUT
/api/v2/vouchers/settings - POST
/api/v2/vouchers/validate - POST
/api/v2/vouchers/{id}/reveal - PUT
/api/v2/vouchers/{id}/status/{status}
Tiers
User tier and membership management
Transactions
- GET
/api/v2/transactionsGet paginated transactions with advanced filtering - GET
/api/v2/transactions/exportExport transactions in CSV or PDF format - GET
/api/v2/transactions/statsGet transaction statistics - POST
/api/v2/transactions/syncSync current user's transactions with the card platform (Quantum Account). Adds any missing transactions by external_id. - POST
/api/v2/transactions/top-upProcesses a wallet top-up operation using external payment methods. - GET
/api/v2/transactions/{id}Get transaction by ID - GET
/api/v2/transactions/{id}/equals-money/payment-confirmation
Transfers
Transfer operations between accounts and external services
- GET
/api/v2/transfersList transfers with filtering and pagination - GET
/api/v2/transfers/crypto-refundsGet crypto refunds for a user - POST
/api/v2/transfers/crypto-refundsCreate a crypto refund - POST
/api/v2/transfers/crypto-refunds/gas-feeGet refund gas fee for a specific currency and chain - POST
/api/v2/transfers/crypto-to-quantum-transferCreate a crypto-to-quantum transfer for internal account transfers (destination is always USD) - GET
/api/v2/transfers/crypto-transactionsGet user crypto transactions (CryptoConnect transfers) - POST
/api/v2/transfers/master-to-userCreate a transfer from master account to user - POST
/api/v2/transfers/quantum-usd-to-crypto-exchangeExchange Quantum USD to Crypto (USDC/USDT) - POST
/api/v2/transfers/test-feesTest endpoint for fee charging flow - POST
/api/v2/transfers/user-to-masterCreate a transfer from user to master account - POST
/api/v2/transfers/wallet-topupRequest a wallet top-up via Transak - GET
/api/v2/transfers/withdrawals/available-balanceGet available withdrawal balance for a user - POST
/api/v2/transfers/withdrawals/cryptoCreate an external crypto withdrawal (to blockchain address) - POST
/api/v2/transfers/withdrawals/crypto/confirmConfirm a crypto withdrawal with an emailed OTP code - POST
/api/v2/transfers/withdrawals/crypto/resendResend the OTP for a pending API crypto withdrawal. - GET
/api/v2/transfers/withdrawals/fee-and-quotaGet withdrawal fee and quota information - GET
/api/v2/transfers/withdrawals/validateValidate withdrawal request - GET
/api/v2/transfers/{transferId}Get transfer by ID
Users
User management operations including creation, updates, and KYC
- GET
/api/v2/usersList users with filtering and pagination - POST
/api/v2/usersCreate a new user - GET
/api/v2/users/check-referralCheck if a referral code is valid for a company - POST
/api/v2/users/create-interlace-account/{userId}Create an account for the authenticated user - GET
/api/v2/users/occupation-codesGet complete list of occupation codes - GET
/api/v2/users/{userId}Get user by ID - PUT
/api/v2/users/{userId}Update user information - GET
/api/v2/users/{userId}/assetsGet user assets (balances). Passing `userId = 0` returns master account balances for the authenticated company. - GET
/api/v2/users/{userId}/crypto-addressesGet user crypto wallet addresses. Passing `userId = 0` returns master account addresses for the authenticated company. - GET
/api/v2/users/{userId}/kyc/detailed-statusGet detailed KYC status breakdown for the user - POST
/api/v2/users/{userId}/kyc/equalsmoney/documentsRespond to an EqualsMoney document request - POST
/api/v2/users/{userId}/kyc/sumsub-access-tokenGet a SumSub access token for the user (for mobile SDK) - PUT
/api/v2/users/{userId}/kyc/sumsub-tokenUpdate user SumSub KYC token - POST
/api/v2/users/{userId}/kyc/verifyVerify and update user KYC information with comprehensive verification data - POST
/api/v2/users/{userId}/sumsub/kyc-urlGenerate SumSub KYC verification URL for user - POST
/api/v2/users/{userId}/tierSet user tier and queue the first subscription fee for scheduled fee charging - GET
/api/v2/users/{userId}/walletsList crypto wallets for a user. Passing `userId = 0` returns master account wallets for the authenticated company.
Webhooks
Outbound webhook requests sent by CryptoCard Platform to configured partner webhook URLs.
- POST
/webhooks/outbound/account.activatedaccount.activated - POST
/webhooks/outbound/account.createdaccount.created - POST
/webhooks/outbound/account.deposit.addressaccount.deposit.address - POST
/webhooks/outbound/account.status_updatedaccount.status_updated - POST
/webhooks/outbound/bank_account.statusbank_account.status - POST
/webhooks/outbound/budget.createdbudget.created - POST
/webhooks/outbound/budget.credit_pendingbudget.credit_pending - POST
/webhooks/outbound/budget.creditedbudget.credited - POST
/webhooks/outbound/budget.debitedbudget.debited - POST
/webhooks/outbound/budget.deletedbudget.deleted - POST
/webhooks/outbound/budget.transaction.closedbudget.transaction.closed - POST
/webhooks/outbound/budget.updatedbudget.updated - POST
/webhooks/outbound/business_account.transactionbusiness_account.transaction - POST
/webhooks/outbound/card.3ds.otpcard.3ds.otp - POST
/webhooks/outbound/card.3ds_auth_requestcard.3ds_auth_request - POST
/webhooks/outbound/card.activatedcard.activated - POST
/webhooks/outbound/card.createdcard.created - POST
/webhooks/outbound/card.deletedcard.deleted - POST
/webhooks/outbound/card.shippedcard.shipped - POST
/webhooks/outbound/card.state_updatedcard.state_updated - POST
/webhooks/outbound/card.topupcard.topup - POST
/webhooks/outbound/card.transactioncard.transaction - POST
/webhooks/outbound/card.unloadcard.unload - POST
/webhooks/outbound/card.updatedcard.updated - POST
/webhooks/outbound/cardholder.approvedcardholder.approved - POST
/webhooks/outbound/cardholder.createdcardholder.created - POST
/webhooks/outbound/cardholder.deletedcardholder.deleted - POST
/webhooks/outbound/cardholder.statuscardholder.status - POST
/webhooks/outbound/digitalwallet.token_transitiondigitalwallet.token_transition - POST
/webhooks/outbound/fee.createdfee.created - POST
/webhooks/outbound/kyc.information_requestkyc.information_request - POST
/webhooks/outbound/kyc.interlace_submission_failedkyc.interlace_submission_failed - POST
/webhooks/outbound/kyc.updatekyc.update - POST
/webhooks/outbound/kyc.verifiedkyc.verified - POST
/webhooks/outbound/legal_entity.statuslegal_entity.status - POST
/webhooks/outbound/order.cancelledorder.cancelled - POST
/webhooks/outbound/order.completedorder.completed - POST
/webhooks/outbound/order.createdorder.created - POST
/webhooks/outbound/payment.completedpayment.completed - POST
/webhooks/outbound/payment.createdpayment.created - POST
/webhooks/outbound/payment.mandate.cancelledpayment.mandate.cancelled - POST
/webhooks/outbound/payment.mandate.createdpayment.mandate.created - POST
/webhooks/outbound/payment.request.cancelledpayment.request.cancelled - POST
/webhooks/outbound/payment.request.confirmed.directpayment.request.confirmed.direct - POST
/webhooks/outbound/payment.request.confirmed.with.exchangepayment.request.confirmed.with.exchange - POST
/webhooks/outbound/payment.request.createdpayment.request.created - POST
/webhooks/outbound/payment.returnedpayment.returned - POST
/webhooks/outbound/paymentbatch.cancelledpaymentbatch.cancelled - POST
/webhooks/outbound/paymentbatch.completedpaymentbatch.completed - POST
/webhooks/outbound/paymentbatch.createdpaymentbatch.created - POST
/webhooks/outbound/paymentbatch.processingpaymentbatch.processing - POST
/webhooks/outbound/paymentbatch.validation_errorpaymentbatch.validation_error - POST
/webhooks/outbound/paymentbatchorder.cancelledpaymentbatchorder.cancelled - POST
/webhooks/outbound/paymentbatchorder.completedpaymentbatchorder.completed - POST
/webhooks/outbound/paymentbatchorder.createdpaymentbatchorder.created - POST
/webhooks/outbound/payout.paymentpayout.payment - POST
/webhooks/outbound/person.createdperson.created - POST
/webhooks/outbound/recipient.createdrecipient.created - POST
/webhooks/outbound/recipient.deletedrecipient.deleted - POST
/webhooks/outbound/user.kyc.updateduser.kyc.updated - POST
/webhooks/outbound/user.registereduser.registered - POST
/webhooks/outbound/wallet.refundwallet.refund - POST
/webhooks/outbound/wallet.topped_upwallet.topped_up - POST
/webhooks/outbound/wallet.withdrawalwallet.withdrawal
WhitelabelTransactions
- GET
/api/v2/whitelabel/transactionsGet company transactions (user_id = 0 and company_id matches the user's company). - GET
/api/v2/whitelabel/transactions/exportExport all transactions matching the filters (no pagination) for CSV export. - POST
/api/v2/whitelabel/transactions/syncSync transactions from the card platform for the whitelabel company's account. Creates transactions with user_id=0 and company_id set to the requesting user's company.