Create Account Product

post

https://api.authvia.com/v3/accounts/{account-id}/products

🔑 scope accounts:update

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Enable additional capabilities for your Account by adding products that integrate with third-party systems or enable new behaviors within the Authvia platform. Products are organized by lines (such as messaging or payments), which determine the available product types and providers.

Each product line enables specific functionality - for example, the payments line allows you to process credit card transactions, while the messaging line enables SMS and email communications with Customers.

📘 Info

The order of products matters when you have conflicting/duplicate products, by line/product/provider. Newly created products always go to the bottom, and bottom products are always preferred.

📘 Special Feature

The customers/crm/mock product enables a signup form for Customers to self-register and adds validation checking for each Customer created.

For a complete list of available products and providers, see our Provider Product Catalog. If you don't see an option you need, please contact [email protected].

Path Params

account-id

string

required

The unique identifier (AVID) of the Account.

Body Params

Schema for representing a merchant product.

string

The unique identifier (UUID) of the merchant product.

line

string

Dictates the conceptual behavior you are enabling, and which 'product' and 'provider' options you can choose. See Provider Product Catalog Link for details.

product

string

Determines a specific concept within the conceptual behavior you are enabling. So ACH within payments, or SMS within messaging.

provider

string

What external system is going to facilitate the behavior outlined by the line and product. Each provider can have different capabilities and features enabled, so be sure to visit the Provider Product Catalog Link for specifics on the enabled provider.

config

object

External system provide a input configuration settings for the product to access the required functionalities. Please check the provider specific page for the product you are trying to configure. Here - Provider Product Catalog Link

features

object

The selected product from the provider allows to adjust and control various features based on their preferences. Please check the provider specific page for the specific product you are trying to configure. Here - Provider Product Catalog Link

appdata

object

Stores up to 50 custom attributes with string keys and scalar values, enabling merchant developers to link their system with Authvia for improved integration.

disabled

boolean

Allow merchant to disabled or enabled the product and it's functionalities as per the business requirements.

status

string

Used to determine the status of configuration when a provider has self configuration capabilities. This takes place when a product in the product catalog has a features attribute named SETUP_MAPPINGS. The initial value will be UNCONFIGURED until the config on the product meets the product catalogs defined schema, once it does then each mapping will be executed, and upon successful execution the product value will be set to READY.
While the status is UNCONFIGURED the product will be set to disabled and cannot be changed.
Please check the provider specific page for the product you are trying to configure. Here - Provider Product Catalog Link

Responses

📘 Info

📘 Special Feature

200Successfully created account product. Returns the complete account details including the newly added product configuration.

400Bad Request - The request cannot be processed due to a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401The request is valid, but server authentication failed to verify the identity. The user's access token has either expired or is not valid. Creating a new token might resolve the issue.