API reference
Every endpoint, field and object
Generated from the v1 contract. Requests go to https://sandbox.api.ndeipi.example/v1 in the sandbox and carry your key in the Api-Key header; every POST also needs an Idempotency-Key.
Users
A user is one of your customers: a person or a business. Users verify their identity and accept the terms through hosted links before they can hold or move money.
Wallets
A wallet holds one asset for one user. Every user has at most one wallet per asset.
Transfers
Every movement of money is a transfer with a source and a destination. The pair decides the kind: user to user, on-ramp, off-ramp or conversion.
Deposit accounts
Standing bank details that credit a user's wallet every time they pay in.
- GETList a user's deposit accounts
/v1/users/{user_id}/deposit_accounts - POSTCreate a standing deposit account
/v1/users/{user_id}/deposit_accounts - GETGet a deposit account
/v1/users/{user_id}/deposit_accounts/{deposit_account_id} - POSTDeactivate a deposit account
/v1/users/{user_id}/deposit_accounts/{deposit_account_id}/deactivate - POSTReactivate a deposit account
/v1/users/{user_id}/deposit_accounts/{deposit_account_id}/reactivate - GETList deposits received
/v1/users/{user_id}/deposit_accounts/{deposit_account_id}/activity
Payout accounts
Bank or PayPal destinations a user can be paid out to.
Rates and routes
What can move where, at what price and within what limits. Read routes at run time instead of hard-coding rails.
Webhooks
Endpoints that receive signed events, and the event log behind them.
- GETList webhook endpoints
/v1/webhook_endpoints - POSTRegister a webhook endpoint
/v1/webhook_endpoints - GETGet a webhook endpoint
/v1/webhook_endpoints/{webhook_endpoint_id} - PATCHUpdate a webhook endpoint
/v1/webhook_endpoints/{webhook_endpoint_id} - DELETEDelete a webhook endpoint
/v1/webhook_endpoints/{webhook_endpoint_id} - POSTSend a test event (coming soon)
/v1/webhook_endpoints/{webhook_endpoint_id}/test - GETList events
/v1/events - GETGet an event
/v1/events/{event_id} - POSTRedeliver an event
/v1/events/{event_id}/redeliver
Sandbox
Calls that stand in for the real world in the sandbox: identity checks finishing, money arriving and payouts landing. Production keys get 403 sandbox_only.
Objects
The resources the API returns, field by field.
- OBJUser
User - OBJOnboarding Links
OnboardingLinks - OBJWallet
Wallet - OBJWallet Balance
WalletBalance - OBJWallet History Entry
WalletHistoryEntry - OBJTransfer
Transfer - OBJTransfer Preview
TransferPreview - OBJReceipt
Receipt - OBJDeposit Instructions
DepositInstructions - OBJDeposit Account
DepositAccount - OBJDeposit
Deposit - OBJPayout Account
PayoutAccount - OBJRoute
Route - OBJRate
Rate - OBJQuote
Quote - OBJWebhook Endpoint
WebhookEndpoint - OBJEvent
Event - OBJError
Error