Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.tazapay.com/llms.txt

Use this file to discover all available pages before exploring further.

You can create Collection Accounts (Virtual Accounts and Stablecoin Wallets) for yourself or for your entities programmatically via the Tazapay API. Collection Accounts can only be created once you or your entity has been onboarded on Tazapay and approved by our team.
Before creating a collection account, call the Metadata API to discover which account types, currencies, and payment method types are available for your account.

​
High-level Flow

Collection Account Creation Flow
1

Onboarding and Approval

Ensure you or your entity has been onboarded on Tazapay and approved by our team before making API calls.
2

Check the Metadata API

Call the Collection Account Metadata API to discover:
  • Available payment method types for your account
  • Supported currencies and domicile countries
  • Transfer limits and on_behalf_of restrictions
3

Create the Account

Call the Collection Account Creation API with your requirements — account type, country, currencies, and payment method type.If Tazapay can fulfill the requirements, a Collection Account object is created with status disabled and an initial enablement request.
4

Track via Webhooks

Subscribe to webhook events to receive real-time status updates as the enablement request progresses. Once the request succeeds, the account status changes to enabled and is ready to receive funds.

​
Collection Account Status Flow

Every Collection Account has a status — either enabled or disabled — that tells you whether it can currently receive funds. This status is not set directly. Instead, it is determined by the state of requests associated with the account. Each time you want to enable, disable, or re-enable an account, a request is created and goes through its own lifecycle. The account status updates automatically based on how that request progresses. There are three types of requests:
Request TypeWhat it does
EnablementActivates the account so it can start receiving funds. Created automatically when the account is first set up.
DisablementDeactivates the account so it stops accepting incoming payments.
Re-enablementReactivates a previously disabled account, if the account supports it.
Each request moves through its own set of states — such as Processing, Requires Action, Approval Hold — before reaching a terminal state (Succeeded, Failed, or Cancelled). The account status at any point reflects the outcome of the most recent request.
Collection Account Status Flow
The diagram above shows the enablement request flow. For disablement and re-enablement, the account status transitions are reversed — see the table below.

​
Status by Request State

Request StateAccount Status — EnablementAccount Status — Disablement
ProcessingDisabledEnabled
Requires ActionDisabledEnabled
Approval HoldDisabledEnabled
SucceededEnabledDisabled
FailedDisabledEnabled
CancelledDisabledEnabled

​
Webhook Events

Subscribe to the following events to track the full lifecycle of your collection accounts:
EventDescription
collection_account.creation_succeededThe collection account has been successfully enabled and is ready to receive funds.
collection_account.creation_failedThe collection account creation request failed.
collection_account.creation_requires_actionAction is required from you before the creation can proceed.
collection_account.creation_under_approval_holdThe creation request is under review and pending approval by Tazapay.
collection_account.creation_under_processingThe creation request is being processed.
collection_account.creation_cancelledThe creation request was cancelled.
collection_account.disablement_succeededThe collection account has been successfully disabled.
collection_account.disablement_failedThe disablement request failed.
collection_account.disablement_requires_actionAction is required from you before the disablement can proceed.
collection_account.disablement_under_processingThe disablement request is being processed.
collection_account.disablement_cancelledThe disablement request was cancelled.

​
Closing a Collection Account

To close (disable) a collection account, call the Disable Collection Account API: 
POST /v3/collection_account/{id}/disable
Once a disablement request is submitted:
  • The account status remains enabled while the request is in progress.
  • Webhook events are sent as the request moves through each state.
  • On success, the account transitions to disabled and will no longer accept incoming payments.
To cancel an in-progress disablement request, use the Cancel Collection Account Request API.
Once disabled, a collection account cannot be re-enabled unless the account_reenablement_supported field on the account object is true. Contact support@tazapay.com if you need assistance.

​
Coverage

See the full list of supported virtual account and stablecoin options:

Virtual Accounts Coverage

Supported countries, currencies, and transfer modes.

Stablecoins Coverage

Supported stablecoins and blockchain networks.