High-level Flow
- Merchant / Entity is onboarded on Tazapay and approved by our team.
- Call the Collection Account Metadata API to retrieve the list of Tazapay collection account capabilities available to you — including supported payment method types, currencies, transfer limits, and on_behalf_of restrictions.
- Call the Collection Account Creation API with your requirements (type, country, currencies, payment method type, etc.).
- If Tazapay can fulfill those requirements, a Collection Account object is created along with an initiated request inside the collection account object.
- You will receive webhook events as the status of the collection account changes (see below). Using these webhooks, you can fetch the latest details of the collection account and track its current status.
Webhook Events
Subscribe to the following events to track the lifecycle of your collection accounts:| Event | Description |
|---|---|
collection_account.creation_succeeded | The collection account has been successfully enabled and is ready to receive funds. |
collection_account.creation_failed | The collection account creation request failed. |
collection_account.creation_requires_action | Action is required from you before the creation can proceed. |
collection_account.creation_under_approval_hold | The creation request is under review and pending approval by Tazapay. |
collection_account.creation_under_processing | The creation request is being processed. |
collection_account.creation_cancelled | The creation request was cancelled. |
collection_account.disablement_succeeded | The collection account has been successfully disabled. |
collection_account.disablement_failed | The disablement request failed. |
collection_account.disablement_requires_action | Action is required from you before the disablement can proceed. |
collection_account.disablement_under_processing | The disablement request is being processed. |
collection_account.disablement_cancelled | The disablement request was cancelled. |
Collection Account Status by Request State
The table below shows the resulting Collection Account status for each request state, depending on whether the request is an enablement or disablement.| Request State | VA / Wallet Status (Enablement Request) | VA / Wallet Status (Disablement Request) |
|---|---|---|
| Processing | Disabled | Enabled |
| Requires Action | Disabled | Enabled |
| Approval Hold | Disabled | Enabled |
| Succeeded | Enabled | Disabled |
| Failed | Disabled | Enabled |
| Cancelled | Disabled | Enabled |