Create Account Product

🔑 scope accounts:update

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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.

string

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

string

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

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.

boolean

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

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

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json