Skip to content

Commit ea2bab0

Browse files
committed
update versions and changelogs
1 parent 81b3872 commit ea2bab0

4 files changed

Lines changed: 102 additions & 3 deletions

File tree

Gemfile.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
zai_payment (2.7.0)
4+
zai_payment (2.8.0)
55
base64 (~> 0.3.0)
66
faraday (~> 2.0)
77
openssl (~> 3.3)

changelog.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,80 @@
11
## [Released]
22

3+
## [2.8.0] - 2025-11-07
4+
5+
### Added
6+
- **Virtual Accounts Resource**: Complete virtual account management for Australian payments 🏦
7+
- `ZaiPayment.virtual_accounts.list(wallet_account_id)` - List all virtual accounts for a wallet account
8+
- `ZaiPayment.virtual_accounts.show(virtual_account_id)` - Get virtual account details
9+
- `ZaiPayment.virtual_accounts.create(wallet_account_id, account_name:, aka_names:)` - Create virtual account for a wallet account
10+
- `ZaiPayment.virtual_accounts.update_aka_names(virtual_account_id, aka_names)` - Update AKA names (0-3 items)
11+
- `ZaiPayment.virtual_accounts.update_account_name(virtual_account_id, account_name)` - Update account name (used in CoP lookups)
12+
- `ZaiPayment.virtual_accounts.update_status(virtual_account_id, status)` - Close a virtual account (status: 'closed')
13+
- Support for AKA names for account aliases
14+
- Support for Confirmation of Payee (CoP) lookups via account names
15+
- Validation for account names (max 140 characters)
16+
- Validation for AKA names (0-3 items)
17+
- Full RSpec test suite with 65+ test examples
18+
- Comprehensive documentation in `docs/virtual_accounts.md`
19+
- Practical examples in `examples/virtual_accounts.md`
20+
21+
- **PayID Resource**: PayID registration management for Australian NPP payments 💳
22+
- `ZaiPayment.pay_ids.create(virtual_account_id, pay_id:, type:, details:)` - Register a PayID for a virtual account
23+
- `ZaiPayment.pay_ids.show(pay_id_id)` - Get PayID details including status
24+
- `ZaiPayment.pay_ids.update_status(pay_id_id, status)` - Deregister a PayID (status: 'deregistered')
25+
- Support for EMAIL PayID type
26+
- Validation for PayID format (max 256 characters)
27+
- Validation for details (pay_id_name and owner_legal_name, 1-140 characters each)
28+
- Asynchronous status update with 202 Accepted response
29+
- Full RSpec test suite with 35+ test examples
30+
- Comprehensive documentation in `docs/pay_ids.md`
31+
- Practical examples in `examples/pay_ids.md`
32+
33+
### Documentation
34+
- **Virtual Accounts Guide** (`docs/virtual_accounts.md`):
35+
- Complete guide for all 6 virtual account endpoints
36+
- Detailed workflow for account creation and management
37+
- AKA names for account aliases
38+
- Account name updates for CoP lookups
39+
- Status updates for closing accounts
40+
- Error handling patterns
41+
- Comprehensive use cases
42+
43+
- **Virtual Accounts Examples** (`examples/virtual_accounts.md`):
44+
- List virtual accounts examples
45+
- Show virtual account examples
46+
- Create virtual account examples
47+
- Update AKA names examples
48+
- Update account name examples
49+
- Update status (close account) examples
50+
- Complete workflow patterns
51+
- Rails integration examples
52+
53+
- **PayID Guide** (`docs/pay_ids.md`):
54+
- Complete guide for all 3 PayID endpoints
55+
- PayID registration with EMAIL type
56+
- PayID format validation rules
57+
- Status updates for deregistration
58+
- Integration with virtual accounts
59+
- Error handling patterns
60+
- Comprehensive use cases
61+
62+
- **PayID Examples** (`examples/pay_ids.md`):
63+
- Register PayID examples
64+
- Show PayID examples
65+
- Update status (deregister) examples
66+
- Complete workflow patterns
67+
- Rails integration examples
68+
69+
### Enhanced
70+
- **README.md**:
71+
- Added Virtual Accounts to features section
72+
- Added PayID to features section
73+
- Added documentation links to virtual accounts and PayID guides
74+
- Updated roadmap to mark Virtual Accounts and PayID as Done
75+
76+
**Full Changelog**: https://github.com/Sentia/zai-payment/compare/v2.7.0...v2.8.0
77+
378
## [2.7.0] - 2025-11-04
479

580
### Added

lib/zai_payment/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# frozen_string_literal: true
22

33
module ZaiPayment
4-
VERSION = '2.7.0'
4+
VERSION = '2.8.0'
55
end

readme.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ A lightweight and extensible Ruby client for the **Zai (AssemblyPay)** API — s
2424
- 🏦 **Bank Account Management** - Complete CRUD + validation for AU/UK bank accounts
2525
- 💳 **BPay Account Management** - Manage BPay accounts for Australian bill payments
2626
- 💼 **Wallet Account Management** - Show wallet accounts, check balances, and pay bills via BPay
27+
- 🏦 **Virtual Accounts** - Complete virtual account management with PayTo and BPay support
28+
- 💳 **PayID Management** - Create and manage PayIDs for Australian NPP payments
2729
- 🎫 **Token Auth** - Generate secure tokens for bank and card account data collection
2830
- 🪝 **Webhooks** - Full CRUD + secure signature verification (HMAC SHA256)
2931
- 🧪 **Batch Transactions** - Prelive-only endpoints for testing batch transaction flows
@@ -160,6 +162,23 @@ if payment_response.success?
160162
end
161163
```
162164

165+
### Virtual Accounts
166+
167+
Manage virtual accounts with support for AKA names and Confirmation of Payee (CoP) lookups.
168+
169+
**📚 Documentation:**
170+
- 📖 [Virtual Account Management Guide](docs/virtual_accounts.md) - Complete guide for virtual accounts
171+
- 💡 [Virtual Account Examples](examples/virtual_accounts.md) - Real-world patterns and workflows
172+
- 🔗 [Zai: Virtual Accounts API Reference](https://developer.hellozai.com/reference/overview-va)
173+
174+
### PayID
175+
176+
Register and manage PayIDs (EMAIL type) for Australian NPP (New Payments Platform) payments.
177+
178+
**📚 Documentation:**
179+
- 📖 [PayID Management Guide](docs/pay_ids.md) - Complete guide for PayID registration
180+
- 💡 [PayID Examples](examples/pay_ids.md) - Real-world patterns and workflows
181+
163182
### Token Auth
164183

165184
Generate secure tokens for collecting bank and card account information.
@@ -246,7 +265,8 @@ end
246265
| ✅ Token Auth | Generate bank/card tokens | Done |
247266
| ✅ Batch Transactions (Prelive) | Simulate batch processing flows | Done |
248267
| ✅ Payments | Single and recurring payments | Done |
249-
| 🏦 Virtual Accounts (VA / PIPU) | Manage virtual accounts & PayTo | ⏳ Planned |
268+
| ✅ Virtual Accounts | Manage virtual accounts & PayTo | Done |
269+
| ✅ PayID | Create and manage PayIDs | Done |
250270

251271
## 🧪 Development
252272

@@ -305,6 +325,8 @@ Everyone interacting in the ZaiPayment project's codebases, issue trackers, chat
305325
- [**Bank Account Guide**](docs/bank_accounts.md) - Managing bank accounts for AU/UK users
306326
- [**BPay Account Guide**](docs/bpay_accounts.md) - Managing BPay accounts for Australian bill payments
307327
- [**Wallet Account Guide**](docs/wallet_accounts.md) - Managing wallet accounts, checking balances, and paying bills
328+
- [**Virtual Account Guide**](docs/virtual_accounts.md) - Managing virtual accounts with PayTo and BPay support
329+
- [**PayID Guide**](docs/pay_ids.md) - Creating and managing PayIDs for Australian NPP payments
308330
- [**Webhook Examples**](examples/webhooks.md) - Complete webhook usage guide
309331
- [**Documentation Index**](docs/readme.md) - Full documentation navigation
310332

@@ -314,6 +336,8 @@ Everyone interacting in the ZaiPayment project's codebases, issue trackers, chat
314336
- [Bank Account Examples](examples/bank_accounts.md) - Bank account integration patterns
315337
- [BPay Account Examples](examples/bpay_accounts.md) - BPay account integration patterns
316338
- [Wallet Account Examples](examples/wallet_accounts.md) - Wallet account and bill payment workflows
339+
- [Virtual Account Examples](examples/virtual_accounts.md) - Virtual account management and PayTo workflows
340+
- [PayID Examples](examples/pay_ids.md) - PayID creation and management workflows
317341
- [Token Auth Examples](examples/token_auths.md) - Secure token generation and integration
318342
- [Webhook Examples](examples/webhooks.md) - Webhook integration patterns
319343
- [Batch Transaction Examples](examples/batch_transactions.md) - Testing batch transaction flows (prelive only)

0 commit comments

Comments
 (0)