Documentation Index
Fetch the complete documentation index at: https://docs.zuba.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Payins enable you to accept payments from customers through manual bank transfers. The Zuba platform processes these payments and credits funds to your account while maintaining full transparency and compliance.Manual Deposits
Traditional bank transfers where customers manually send funds to your designated account. When you create a manual deposit, Zuba generates unique bank account details (IBAN and reference) for your customer to transfer funds to.Payment Lifecycle
Payment Statuses
| Status | Description | Actions Available |
|---|---|---|
pending | Deposit created, awaiting customer transfer | Monitor, Cancel |
processing | Transfer detected, being verified | Track status |
completed | Funds received and credited to your account | View receipt |
failed | Deposit expired or transfer failed | Review, Create new |
cancelled | Deposit cancelled before completion | View details |
Checking Deposit Status
Listing Deposits
Retrieve all deposits for your account, optionally filtered by status:Cancelling Pending Deposits
Cancel deposits that haven’t been completed yet:Only deposits in
pending status can be cancelled. Once a deposit is processing or completed, it cannot be cancelled.Supported Countries & Currencies
European Union (SEPA Zone)
- Countries: Germany, France, Spain, Italy, Netherlands, Belgium, Austria, Portugal, Finland, Ireland, and more
- Currency: EUR
- Settlement: 1-2 business days
United Kingdom
- Currency: GBP
- Settlement: 1-2 business days via UK bank transfer
Supported Currencies
- Major Fiat: EUR, GBP, USD, CAD
- Settlement Times: Vary by currency and banking network
Webhooks & Notifications
Set up webhooks to receive real-time updates on deposit status changes:Webhook Payload Example
Webhook Events
| Event | Description | When Triggered |
|---|---|---|
deposit.created | Deposit created | When deposit request is initiated |
deposit.processing | Deposit being processed | Transfer detected from customer |
deposit.completed | Deposit completed | Funds received and credited |
deposit.failed | Deposit failed | Transfer failed or deposit expired |
deposit.cancelled | Deposit cancelled | User or system cancellation |
Error Handling
Common deposit errors and solutions:| Error Code | Description | Solution |
|---|---|---|
INVALID_AMOUNT | Amount is invalid or too large | Check amount format and limits |
UNSUPPORTED_CURRENCY | Currency not supported | Use supported currency (EUR, GBP, USD, CAD) |
DEPOSIT_EXPIRED | Deposit reference expired | Create new deposit |
INVALID_REFERENCE | Transfer reference doesn’t match | Ensure customer uses exact reference |
DUPLICATE_CLIENT_REF | Client reference already used | Use unique clientRef for each deposit |
Best Practices
Deposit Creation
Deposit Creation
- Always include unique
clientReffor idempotency and reconciliation - Provide clear instructions to customers about IBAN and reference
- Set reasonable timeout periods and communicate them to customers
- Store deposit IDs for status tracking and customer support
Status Monitoring
Status Monitoring
- Implement webhook endpoints for real-time updates
- Use exponential backoff when polling deposit status
- Handle all possible status transitions in your code
- Log deposit events for audit and debugging
Customer Experience
Customer Experience
- Display IBAN, BIC, and payment reference clearly
- Show expected settlement times (1-2 business days for SEPA)
- Send confirmation emails with payment instructions
- Implement proper error messaging for failed deposits
- Provide customer support contact for payment issues
Security
Security
- Validate webhook signatures to prevent spoofing
- Use HTTPS for all API communications
- Never log sensitive customer payment data
- Implement proper access controls for deposit endpoints
Integration Example
React Deposit Component
Next Steps
Payouts
Send money globally to beneficiaries
Webhook Setup
Configure real-time deposit notifications
Ledger System
Track transactions with double-entry accounting
API Reference
Complete API documentation