Welcome to Enovipay vIBAN
Machine-to-machine access to your vIBAN accounts. This is not the dashboard — no cookies, CSRF, or authenticator codes. Authenticate with an API key id and secret over HTTP Basic.
What you can do
| Capability | Endpoint |
|---|---|
| List active vIBAN accounts | GET /v1/accounts |
| Live balances | GET /v1/balance |
| Transaction history, including open declarations as pending lines | GET /v1/transactions, GET /v1/transactions/:id |
| Declare an expected deposit | POST /v1/deposits |
| Read declarations | GET /v1/deposits, GET /v1/deposits/:id |
| Customers (saved payees and payers) | GET/POST /v1/customers, GET/PATCH/DELETE /v1/customers/:customerId |
| Create a payout | POST /v1/payouts (no TOTP; the API secret is the verification) |
| List payouts | GET /v1/payouts |
| One outbound webhook | Dashboard Settings → Notifications, or PUT /v1/webhook — payout status, incoming credits (with their deposit match), and deposit expiry |
Every call is scoped to the merchant that owns the credential. There is no merchant id in the path or body.
Deposit notification addresses are a dashboard setting (GET/PUT /merchant/notification-emails on Settings → Notifications), not a /v1 resource. An empty list sends nothing.
You cannot request a new vIBAN, move money between your own accounts, or export statements on this API.
Saved payees are customers. The earlier saved-payee routes are removed.
Start here
Integration guides
Saved payees and payers, and your customer reference
Name the vIBAN you expect the payment on
Pay a customer by id or inline
Signature verification, match status, deposit expiry
Error envelope, customer codes, throttles
Sandbox first, then production keys
Updated 15 days ago
