Dutch API endpoint reference

180 endpoints, generated from the routes the server registers. The 22 public developer endpoints use a live developer key; the 149 dashboard endpoints are the internal API behind the Dutch dashboard. There is no sandbox.

Public developer API (22)

GET /v1/balances Returns the available balance of every wallet on your organization
POST /v1/bank-deposits Creates an Eversend amount-bound temporary NGN bank account for a quoted deposit
GET /v1/bank-deposits/:id Returns the account instructions and reconciliation status for one bank deposit
POST /v1/bank-deposits/quote Returns the Dutch API fee, NGN wallet credit, and Eversend amount limits for a Nigeria-only bank deposit
GET /v1/card-payments Lists this business’s development-mode mock payment records
POST /v1/card-payments Creates a development-mode mock payment record in pending status
GET /v1/card-payments/:id Returns one business-scoped mock payment and its recorded event timeline
POST /v1/card-payments/:id/refund Marks an eligible succeeded mock payment refunded
POST /v1/collections Asks a payer to approve an Africa-only mobile-money payment in CM/XAF, GH/GHS, KE/KES, RW/RWF or UG/UGX
GET /v1/collections/:id Returns one collection by its id
POST /v1/collections/quote Returns the Dutch API fee for an Africa-only mobile-money collection, the amount that lands in your wallet, and the currently available amount range
POST /v1/funding The current endpoint responds with HTTP 501 and the machine-readable error funding_not_available
POST /v1/fx/convert Executes a conversion at the rate locked by POST /v1/fx/quote
POST /v1/fx/quote Locks a conversion rate for a short time
POST /v1/payouts Sends money to a mobile money wallet or bank account
GET /v1/payouts/:id Returns one payout by its id
POST /v1/payouts/quote Prices a payout without reserving or charging anything: what the recipient gets, and the fees object
GET /v1/ping Proves that your live key, project and network are accepted
GET /v1/transactions Lists every transaction on your organization, newest first: collections, deposits, payouts, withdrawals, swaps, conversions, card funding, card transactions and fees
DELETE /v1/webhooks Stops all webhook deliveries
GET /v1/webhooks Returns the current webhook URL (the secret is never returned again)
POST /v1/webhooks Registers (or replaces) your single webhook URL and returns a new signing secret, shown once

Dashboard API (149)

POST /v1/auth/login-code Email a one-time sign-in code to an existing account
POST /v1/auth/logout End the current session (works before the authenticator step)
GET /v1/auth/me Where the signed-in session stands: ready (the business account is fully set up) and mfa (enrolled, satisfied)
POST /v1/auth/signup-code Email a one-time code to create an account
GET /v1/business/action-items List outstanding tasks (verification, PIN, approvals)
POST /v1/business/action-items/:id/dismiss Dismiss a task
GET /v1/business/activity-logs Audit trail of actions taken in the organization
GET /v1/business/analytics Activity analytics for the dashboard: counts, completed volume by currency and outcome for each kind (deposits, collections, withdrawals, disbursements, transfers, card funding, card transactions, swaps, conversions, fees), fees charged and a daily series
GET /v1/business/balances Wallet balances from the ledger
POST /v1/business/bank-deposits Create an amount-bound Eversend temporary Nigerian bank account using an unused quote
GET /v1/business/bank-deposits/:id Read bank account details and provider-confirmed deposit reconciliation status
POST /v1/business/bank-deposits/quote Get an NGN-only Nigeria bank-deposit quote with limits and Dutch API fee
GET /v1/business/banks Bank list for a payout country (?country=NG)
GET /v1/business/card-payments List organization-scoped development mock card payments; supports status, date range and search filters
GET /v1/business/card-payments/:id Read one mock payment and its persisted event timeline
POST /v1/business/card-payments/:id/refund Mark an eligible succeeded mock payment refunded; this does not contact a card processor or move money
POST /v1/business/card-payments/mock Create a pending mock payment for dashboard integration testing; no money moves
GET /v1/business/card-payments/settings Read Card Payments return/webhook URL settings and non-live mode
PUT /v1/business/card-payments/settings Save HTTPS return and webhook URL metadata in mock mode
GET /v1/business/card-payments/summary Aggregate mock payment counts, volume by currency and daily history; available balance is not claimed before launch
GET /v1/business/cards List virtual cards (masked; the full card number is not returned)
POST /v1/business/cards Issue a virtual card
DELETE /v1/business/cards/:id Terminate a card
GET /v1/business/cards/:id/billing-address Billing address registered for a card
GET /v1/business/cards/:id/details Full card details, revealed only on request and never stored
POST /v1/business/cards/:id/freeze Freeze a card
POST /v1/business/cards/:id/fund Top up a card in USD from the USD wallet
GET /v1/business/cards/:id/transactions Card transaction history from the card network
POST /v1/business/cards/:id/unfreeze Unfreeze a card
POST /v1/business/cards/:id/withdraw Move card balance back to the USD wallet
GET /v1/business/cards/pricing Returns the USD one-time issuance fee and monthly card fee
GET /v1/business/cards/stats Card counts and balances
GET /v1/business/cards/users List cardholders
POST /v1/business/cards/users Create a cardholder with identity details
GET /v1/business/checkouts/links List the organization's payment links, including their secure share URLs and current status
POST /v1/business/checkouts/links Create a fixed-amount payment link for supported mobile-money currencies
GET /v1/business/claas/rates Live indicative USDT and USDC rates against USD and XAF (cached for 30 seconds)
GET /v1/business/claas/requests List the organization's liquidity requests
POST /v1/business/claas/requests Ask the Dutch team for a stablecoin liquidity line: buy or sell, asset, currency, expected size and frequency
POST /v1/business/close Request account closure (owner only; the organization name must be typed exactly)
GET /v1/business/collections List collections
POST /v1/business/collections/fees Live quote for a mobile-money collection in CM/XAF, GH/GHS, KE/KES, RW/RWF or UG/UGX
POST /v1/business/collections/initiate Start a mobile-money collection for CM/XAF, GH/GHS, KE/KES, RW/RWF or UG/UGX
GET /v1/business/controls/kill-switch Read whether money movement is paused
PUT /v1/business/controls/kill-switch Pause or resume all money movement
GET /v1/business/controls/limits Per-currency live transfer limits
DELETE /v1/business/controls/limits/:currency Disable a currency's live limit
PUT /v1/business/controls/limits/:currency Set per-request and daily limits for a currency
GET /v1/business/countries Supported African destination options
GET /v1/business/credentials Your public Business ID and webhook URL and signing secret
GET /v1/business/developers/ip-whitelist List allowed API caller IPs
POST /v1/business/developers/ip-whitelist Add an allowed IP
DELETE /v1/business/developers/ip-whitelist/:id Remove an allowed IP
GET /v1/business/developers/request-logs Public API request log
PUT /v1/business/developers/webhook Set the webhook URL from the dashboard
GET /v1/business/developers/webhook-deliveries Webhook delivery history
POST /v1/business/developers/webhook-deliveries/:id/retry Retry a failed delivery
POST /v1/business/developers/webhook/rotate-secret Rotate the key that signs events sent to your webhook URL (save a webhook URL first)
POST /v1/business/developers/webhook/test Send a test event to the webhook URL
POST /v1/business/exchanges Convert between wallets using a locked quote
POST /v1/business/exchanges/quotation Lock a conversion rate (wallets, or USDT/USDC to USD/XAF at 1.45%, minimum 10)
GET /v1/business/global-accounts List requested and provisioned global accounts
POST /v1/business/global-accounts Request a USD, EUR or GBP global account
GET /v1/business/global-accounts/currencies Currencies a global account can be requested in (USD, EUR and GBP)
GET /v1/business/kyb-progress Cumulative completed transaction volume for the signed-in business, converted to USD equivalents
GET /v1/business/notifications List notifications
POST /v1/business/notifications/:id/read Mark a notification read
GET /v1/business/notifications/preferences Read notification preferences
PUT /v1/business/notifications/preferences Update notification preferences
POST /v1/business/notifications/read-all Mark every notification read
GET /v1/business/overview/summary Overview total: the USD wallet balance (other wallets are never converted at an invented rate)
GET /v1/business/payouts List payouts
POST /v1/business/payouts Confirm a quoted payout (Send money)
POST /v1/business/payouts/:id/approve Approve a payout waiting for review (PIN required)
POST /v1/business/payouts/:id/reject Reject a payout waiting for review; the amount is returned
POST /v1/business/payouts/bulk Queue a CSV batch of up to 100 mobile money payouts
POST /v1/business/payouts/bulk/validate Validate each row of a bulk batch without sending anything
POST /v1/business/payouts/quotation Quote a payout with the published Dutch API fee and the current exchange rate
GET /v1/business/profile Read the signed-in user's profile
PUT /v1/business/profile Update the profile
GET /v1/business/providers Available Dutch API products
DELETE /v1/business/providers/:provider Disconnect an organization's own partner credentials
PUT /v1/business/providers/:provider Save an organization's own partner credentials (stored encrypted)
POST /v1/business/providers/:provider/test Test partner credentials
GET /v1/business/readiness A plain checklist of whether the business is ready: project API keys, payment network, connection test, limits, emergency stop and webhook
GET /v1/business/recipients List saved recipients
POST /v1/business/recipients Save a recipient
DELETE /v1/business/recipients/:id Delete a recipient
GET /v1/business/search Search recipients (and team members, for those who can manage the team)
GET /v1/business/security/pin Whether a transaction PIN is set
POST /v1/business/security/pin Set or change the 6-digit transaction PIN
POST /v1/business/security/pin/verify Verify the PIN (attempts are rate limited and locked after repeated failures)
GET /v1/business/security/sessions List active sign-in sessions
DELETE /v1/business/security/sessions/:id Sign a session out
POST /v1/business/security/sessions/revoke-others Sign out every other session
GET /v1/business/settings Organization settings
PUT /v1/business/settings Update organization settings
POST /v1/business/settings/logo Upload the organization logo
PUT /v1/business/settings/payout-approval Turn payout approval on or off
GET /v1/business/solutions List the canonical 17-product catalog with live, limited, request-only, scheduled, or coming-soon availability and this organization's access requests
POST /v1/business/solutions/:solutionId/request Record an organization-scoped request for a non-live solution
GET /v1/business/stablecoin-accounts List the business stablecoin deposit addresses with their asset, network, provider and status
POST /v1/business/stablecoin-accounts Send {"asset":"USDC","network":"Solana"} to create or return the existing USDT/USDC deposit address
GET /v1/business/stablecoin-networks List deposit networks; pass ?asset=USDC or ?asset=USDT to filter to chains enabled for that asset by the provider
POST /v1/business/statements Generate a wallet statement (PDF or CSV) from the ledger; returns a 5-minute download link
GET /v1/business/support/conversations List support conversations
POST /v1/business/support/conversations Open a support conversation
POST /v1/business/support/conversations/:id/attachments Attach a file to a conversation
POST /v1/business/support/conversations/:id/close Close a conversation
GET /v1/business/support/conversations/:id/messages List messages
POST /v1/business/support/conversations/:id/messages Send a message
GET /v1/business/team/invitations List pending invitations
POST /v1/business/team/invitations Invite a teammate
DELETE /v1/business/team/invitations/:id Cancel an invitation
POST /v1/business/team/invitations/:id/resend Resend an invitation
GET /v1/business/team/me The caller's role and permissions
GET /v1/business/team/permissions All permission keys
GET /v1/business/team/roles List roles
POST /v1/business/team/roles Create a custom role
DELETE /v1/business/team/roles/:id Delete a custom role
PUT /v1/business/team/roles/:id Edit a custom role
POST /v1/business/team/transfer-ownership Transfer ownership to another member
GET /v1/business/team/users List team members
DELETE /v1/business/team/users/:id Remove a team member
GET /v1/business/team/users/:id One team member
PUT /v1/business/team/users/:id/role Change a member's role
PUT /v1/business/team/users/:id/status Suspend or reactivate a member
GET /v1/business/transactions List all transactions with filters (type, kind, status, search, dates)
GET /v1/business/transactions/:id/receipt PDF receipt for one transaction; returns a 5-minute download link
POST /v1/business/transactions/:id/refresh Refresh the live status of an open collection or payout
POST /v1/business/transactions/export Export transactions as CSV, Excel or PDF; returns a 5-minute download link
GET /v1/business/treasury/summary USDT Treasury in one call: USDT and USDC balances, deposit addresses, the networks (Solana, BNB Chain, Polygon), conversion terms and recent stablecoin activity
GET /v1/business/verification Business verification status
PUT /v1/business/verification Save verification details
POST /v1/business/verification/documents Upload a verification document (private storage)
POST /v1/business/verification/submit Submit verification for review
GET /v1/business/virtual-accounts List requested and issued virtual bank accounts (NGN and GHS)
POST /v1/business/virtual-accounts Request a virtual bank account in NGN or GHS, with an optional label
GET /v1/business/virtual-accounts/currencies Currencies a virtual account can be requested in (NGN and GHS for now)
GET /v1/business/wallet-preferences List supported wallet currencies and whether each is shown in the dashboard
PUT /v1/business/wallet-preferences/:currency Activate or deactivate a supported wallet in the dashboard; this does not block money movement
POST /v1/business/withdrawals Confirm a withdrawal quote with the transaction PIN (token, pin)
POST /v1/business/withdrawals/quotation Quote a wallet withdrawal to an African mobile-money destination: CM, GH, KE, RW, CD, TZ, ZM, SN, CI or UG
GET /v1/projects List projects with the Business ID, each project id and its independent live key prefix (never the secret)
POST /v1/projects Create a Dutch API project
PATCH /v1/projects/:id Set a project active (only when nothing is blocked) or paused
POST /v1/projects/:id/keys A new live API key for the project
GET /v1/projects/:id/readiness Readiness checks for a project: live key, Dutch API product, connection test, live limits, kill switch and webhooks
GET /v1/providers Available Dutch API products and whether each is implemented

Health and webhooks (5)

GET / Service banner
POST /api/v1/webhooks/card-payments Mock-only signed payment status callback
GET /health Liveness probe
GET /health/ready Readiness probe
POST /hooks/:provider Payment confirmations from the payment network