Query Parameters
All parameters are optional - call with none to get every capability available to your account, or narrow the list down.string
Filter capabilities by the country in which the account would be domiciled (ISO 3166 alpha-2, e.g.
SG). Applies to virtual accounts.array of string
Filter capabilities to those supporting the given currencies (ISO format, e.g.
SGD).string
The entity ID of a customer, to check availability for a specific onboarded entity.
boolean
Set to
true to return capabilities for collecting on behalf of your customers, including any restrictions that apply (see on_behalf_of in the response below).Response - Capabilities
The response contains a singlecapabilities array. Each entry describes one account configuration you can provision.
- Virtual Accounts
- Stablecoin Wallets
string
The payment method type this capability describes - e.g.
local_bank_transfer_sgd, wire_transfer.array of string
Currencies supported by this virtual account type.
object
Minimum and maximum limits per transaction.
object
Local rail details, present for local payment method types.
object
Whether - and under which conditions - this capability can be used to collect on behalf of your customers. This is where industry and country restrictions surface.
string
How long the account takes to provision -
instant, same_day, t_plus_1, t_plus_2, t_plus_3, or extended.boolean
Whether an account of this type can be re-enabled after being disabled.
Putting It to Work
1
Call the Metadata API first
Before showing account options in your product or calling Create Collection Account, fetch the capabilities for your account.
2
Build against the returned list
Only offer the countries, currencies, and payment method types that come back - the list already reflects your account’s restrictions.
3
Check on_behalf_of before collecting for customers
If you provision accounts for your customers, check
on_behalf_of.support and its restriction fields per capability, and handle additional_requirements before creating the account.Capabilities can differ between sandbox and production, and between accounts - always query the environment and account you are integrating against.