# Authvia API Reference Documentation > Authvia developer docs for interface-agnostic integrations: use the same system of record via REST APIs, SDKs, and SFTP with consistent semantics, blueprints, and data continuity. ## Guides - [How to use SFTP with FileZilla](https://developer.authvia.com/docs/how-to-use-sftp-with-filezilla.md): How to set up and use FileZilla, a free FTP solution, to upload files via SFTP. - [How to use Batch / Bulk Uploading](https://developer.authvia.com/docs/how-to-use-batch-bulk-uploading.md): How to create the files necessary for bulk processing blueprints, customers, business processes, reminders, etc. ## API Reference - [Getting Started](https://developer.authvia.com/reference/getting-started.md): Select a language to begin, enter your credentials and try creating a token. - [About Authentication](https://developer.authvia.com/reference/authentication.md): This page describes the necessary pieces needed for authentication. - [My Requests](https://developer.authvia.com/reference/my-requests.md): Set up the welcome page for your API to help users make their first call. - [Create Token](https://developer.authvia.com/reference/create-token.md) - [Branding](https://developer.authvia.com/reference/account-brand.md): Ensuring your [Customers](ref:customers) recognize that it's you. - [Domain Configuration](https://developer.authvia.com/reference/domain-configuration.md): Set up branded domains for enhanced customer trust and professional appearance. - [Get Account](https://developer.authvia.com/reference/get-account.md): πŸ”‘ [scope](intro/authentication#scopes) `accounts:read` - [Update Account](https://developer.authvia.com/reference/update-account.md): πŸ”‘ [scope](intro/authentication#scopes) `accounts:update` - [Create Account Product](https://developer.authvia.com/reference/create-account-product.md): πŸ”‘ [scope](intro/authentication#scopes) `accounts:update` - [List Account Products](https://developer.authvia.com/reference/list-account-products.md): πŸ”‘ [scope](intro/authentication#scopes) `accounts:read` - [Retrieve Account Product](https://developer.authvia.com/reference/retrieve-account-product.md): πŸ”‘ [scope](intro/authentication#scopes) `accounts:read` - [Update Account Product](https://developer.authvia.com/reference/update-account-product.md): πŸ”‘ [scope](intro/authentication#scopes) `accounts:update` - [Delete Account Product](https://developer.authvia.com/reference/delete-account-product.md): πŸ”‘ [scope](intro/authentication#scopes) `accounts:update` - [What to Blueprint](https://developer.authvia.com/reference/what-to-blueprint.md): When should you create new [Blueprints](create-blueprint), or extend existing ones? - [Blueprint Branding](https://developer.authvia.com/reference/blueprint-branding.md): Establish a brand for your blueprint using the 'theme' attribute. - [Value Interpolation and Functions](https://developer.authvia.com/reference/value-interpolation-and-functions.md): How you use the values provided to create a [Business Process](business-processes) through a [Blueprint](blueprints). - [Relationship to Business Processes](https://developer.authvia.com/reference/relationship-to-business-processes.md): How the [Business Process](business-processes) and [Blueprints](blueprints) relate to one another. - [Create Blueprint](https://developer.authvia.com/reference/create-blueprint.md): > πŸ”‘ [scope](intro/authentication#scopes) `blueprints:create` Create a new [Blueprint](blueprints) for the specified [Account](account). This endpoint allows you to define reusable business process templates. > πŸ“˜ Info > > Blueprints provide predefined templates and workflows that can streamline your business process creation and ensure consistency across your applications. > > You can configure actions, themes, and other settings during creation or update them later. > πŸ’‘ **Tip**: Use blueprints to standardize common business processes like payment flows, customer onboarding, or document collection. - [List Blueprints](https://developer.authvia.com/reference/list-blueprints.md): > πŸ”‘ [scope](intro/authentication#scopes) `blueprints:read` Retrieve a list of [Blueprints](blueprints) for the specified [Account](account). This endpoint allows you to view all blueprints associated with your account. > πŸ“˜ Info > > The response includes pagination information to help you navigate through large blueprint lists. > > You can filter blueprints by various criteria and sort the results as needed. > πŸ’‘ **Tip**: For large blueprint lists, consider using pagination parameters to optimize performance and reduce response times. - [Get Blueprint](https://developer.authvia.com/reference/get-blueprint.md): > πŸ”‘ [scope](intro/authentication#scopes) `blueprints:read` Retrieve a specific [Blueprint](blueprints) by its ID. This endpoint allows you to view detailed blueprint information including actions, configuration, and metadata. > πŸ“˜ Info > > The blueprint ID must exist within your account. This endpoint returns complete blueprint details including all configured actions and settings. - [Delete Blueprint](https://developer.authvia.com/reference/delete-blueprint.md): > πŸ”‘ [scope](intro/authentication#scopes) `blueprints:delete` Delete a specific [Blueprint](blueprints) by its ID. This endpoint permanently removes the blueprint and all associated configuration from your account. > ⚠️ Warning > > This action is irreversible. All blueprint data, including actions, configuration, and metadata, will be permanently deleted. > > Consider deactivating the blueprint instead if you may need to restore the data later. - [Execute Blueprint](https://developer.authvia.com/reference/execute-blueprint.md): > πŸ”‘ [scope](intro/authentication#scopes) `business_processes:create` - [Trigger Schema](https://developer.authvia.com/reference/trigger-schema.md): Turn on Merchant portal forms and Protect against rogue payloads - [HTTPS Execution](https://developer.authvia.com/reference/https-trigger-execution.md): Execute a Trigger from anywhere that https is available. - [Create Trigger](https://developer.authvia.com/reference/create-trigger.md): > πŸ”‘ [scope](intro/authentication#scopes) `triggers:create` Create a [Trigger](trigger-schema) to seamlessly execute a [Blueprint](blueprints), facilitating the creation of a [Business Process](create-business-process) for the [Customer](customers) within the [Account](account) (Merchant). > πŸ“˜ Info > > A [Trigger](trigger-schema) enables the setup of a schema form based on dynamic variable inputs required by the [Blueprint](blueprints) during real-time execution to create a [Business Process](create-business-process). > > A single [Trigger](trigger-schema) is allowed per protocol/resource combination when using the same [Blueprint](blueprints). Note: If you haven't created your first [Blueprint](blueprints) yet, make sure to do so from here [create blueprint](create-blueprint), as the [Trigger](trigger-schema) depends on it. - [List Blueprint Triggers](https://developer.authvia.com/reference/list-triggers.md): > πŸ”‘ [scope](intro/authentication#scopes) `blueprints:read` Retrieve a list of [Triggers](trigger-schema) for the specified [Blueprint](blueprints). This endpoint allows you to view all triggers associated with a blueprint. > πŸ“˜ Info > > The response includes pagination information to help you navigate through large trigger lists. > > You can filter triggers by various criteria and sort the results as needed. > πŸ’‘ **Tip**: For large trigger lists, consider using pagination parameters to optimize performance and reduce response times. - [Get Trigger](https://developer.authvia.com/reference/get-trigger.md): > πŸ”‘ [scope](intro/authentication#scopes) `triggers:read` Load the specific [Trigger](trigger-schema) within a [Account](account) (Merchant) based on specified [Blueprint](blueprints) to review or verify its details. You can also verify that the schema form attached to the [Trigger](trigger-schema) aligns with the [Blueprint](blueprints) details, if applicable. Review the specific [Blueprint](blueprints) by clicking [get blueprint](get-blueprint). - [Delete Blueprint Trigger](https://developer.authvia.com/reference/delete-trigger.md): > πŸ”‘ [scope](intro/authentication#scopes) `blueprints:delete` Delete a specific [Trigger](trigger-schema) for a [Blueprint](blueprints) by its ID. This endpoint permanently removes the trigger and all associated configuration from your account. > ⚠️ Warning > > This action is irreversible. All trigger data, including configuration and metadata, will be permanently deleted. > > Consider deactivating the trigger instead if you may need to restore the data later. - [File Upload Guide](https://developer.authvia.com/reference/file-upload.md): Step-by-step guide for uploading files using the pre-signed URL pattern. - [File Download Guide](https://developer.authvia.com/reference/file-download.md): Step-by-step guide for downloading files using the pre-signed URL pattern. - [List Files](https://developer.authvia.com/reference/list-account-files.md): > πŸ”‘ [scope](intro/authentication#scopes) `files:read` Retrieve a list of [Files](files) for the specified [Account](account). This endpoint allows you to view all files associated with your account. > πŸ“˜ Info > > The response includes pagination information to help you navigate through large file lists. > > You can filter files by various criteria and sort the results as needed. > πŸ’‘ **Tip**: For large file lists, consider using pagination parameters to optimize performance and reduce response times. - [Get Upload URL](https://developer.authvia.com/reference/create-account-file.md): > πŸ”‘ [scope](intro/authentication#scopes) `files:create` Get a pre-signed URL for uploading a file to your [Account](account) storage. This endpoint returns a secure URL that allows you to upload files directly to S3 storage, which can then be used in [Business Processes](create-business-process) or customer interactions. The service supports various file types including PDFs, images, and text files. Files are organized in a virtual directory structure that can be accessed via both API and SFTP. > πŸ“˜ Info > > Files uploaded via this API can be accessed via SFTP in the `/files` virtual directory, and files uploaded via SFTP can be accessed via this API. > > The pre-signed URL is valid for a limited time and should be used immediately for file upload. > ⚠️ Warning > > Ensure your file content matches the specified contentType and fileName. The service validates file extensions against content types. After uploading, you can reference the file in [Business Processes](create-business-process) actions or download it via the [Get File](get-account-file) endpoint. - [Get Download URL](https://developer.authvia.com/reference/get-account-file.md): > πŸ”‘ [scope](intro/authentication#scopes) `files:read` Get a pre-signed URL for downloading a specific file by its unique identifier. This endpoint provides access to file metadata and a secure URL for downloading the file content. The response includes file metadata such as filename, content type, description, and expiration information, along with a pre-signed URL for downloading the actual file content. > πŸ“˜ Info > > This endpoint returns file metadata and a pre-signed URL for downloading. The actual file content is accessed via the provided download URL. > > Files are accessible via both API and SFTP, providing flexibility in how you manage and serve file content. > πŸ“– Tip > > Use this endpoint to serve files to customers during business processes or to download files for local processing. The download URL can also be used directly in customer-facing interfaces. - [Update File Metadata](https://developer.authvia.com/reference/update-account-file.md): > πŸ”‘ [scope](intro/authentication#scopes) `files:update` Update the metadata for a specific file without changing the file content itself. This allows you to modify file categories, tags, customer associations, and other metadata to better organize and manage your file storage. Common use cases include updating file categories, adding or removing tags, associating files with customers or business processes, and updating file descriptions. > πŸ“˜ Info > > This endpoint only updates metadata, not the file content. To replace file content, you would need to delete the existing file and upload a new one. > > Metadata updates are immediately reflected in both API and SFTP access. > πŸ“– Tip > > Use this endpoint to organize files by updating categories, tags, or customer associations. This is especially useful when files need to be reclassified or associated with different business processes. - [Delete File](https://developer.authvia.com/reference/delete-account-file.md): > πŸ”‘ [scope](intro/authentication#scopes) `files:delete` Permanently remove a file from your [Account](account) storage. This action cannot be undone and will immediately free up storage space. The file will no longer be accessible via API or SFTP. Use this endpoint to clean up old files, remove temporary uploads, or manage storage quotas. Consider archiving important files before deletion if you may need them in the future. > ⚠️ Warning > > This action is permanent and cannot be undone. Ensure you have backups of important files before deletion. > > Files that are currently referenced in active [Business Processes](create-business-process) should not be deleted as this may cause errors. > πŸ“˜ Info > > Deleted files are immediately removed from both API and SFTP access. Any existing links or references to the file will no longer work. > > Storage space is freed immediately upon successful deletion. - [SFTP](https://developer.authvia.com/reference/jobs-sftp.md): The basic information on how to use SFTP for batch/bulk operations. - [SFTP Customers](https://developer.authvia.com/reference/sftp-customers.md): Creating and updating customers via SFTP bulk operations. - [SFTP Blueprint Events](https://developer.authvia.com/reference/sftp-blueprint-events.md): Interacting with business processes via blueprint events using SFTP bulk operations. - [SFTP Blueprint Triggering](https://developer.authvia.com/reference/sftp-blueprint-triggering.md): Creating and managing business processes via blueprints using SFTP bulk operations. - [SFTP Payment Methods](https://developer.authvia.com/reference/sftp-payment-methods.md): Creating and updating payment methods via SFTP bulk operations. - [SFTP Transactions](https://developer.authvia.com/reference/sftp-transactions.md): Creating and updating transactions via SFTP bulk operations. - [SFTP Messages](https://developer.authvia.com/reference/sftp-messages.md): Sending messages in bulk via SFTP using CSV files and Handlebars templates. - [SFTP Files](https://developer.authvia.com/reference/sftp-files.md): Uploading and managing files via SFTP virtual directory. - [List Account Jobs](https://developer.authvia.com/reference/list-account-jobs.md): > πŸ”‘ [scope](intro/authentication#scopes) `jobs:read` Lists the jobs from the last 30 days record for an [Account](account). Allows for filtering and pagination to make for easier processing and focusing on results. There is also a webhook event that will fire for each job if you do not want to engage in polling. - [Create Account Job](https://developer.authvia.com/reference/create-account-job.md): > πŸ”‘ [scope](intro/authentication#scopes) `jobs:create` Create a new [Job](jobs) for bulk processing operations. This enables you to upload CSV files for batch operations like customer updates, payment method imports, or transaction processing. The response includes a signed S3 URL where you can upload your CSV file. The URL is valid for 15 minutes and must be used to upload the file contents via PUT request. > πŸ“˜ Info > > The file path must match one of the batch folders defined, as the folder determines the processing logic applied to your data. > ⚠️ Warning > > The contents of the file are used to ensure uniqueness and prevent duplicate processing. For each folder, you can only upload the same logical file once before needing to modify the file contents. After creating a [Job](jobs), you can monitor its progress using the [Get Job](get-account-job) endpoint or set up [webhook subscriptions](webhook-subscriptions) to receive completion notifications. - [List Account Job Lines](https://developer.authvia.com/reference/get-account-job.md): > πŸ”‘ [scope](intro/authentication#scopes) `jobs:read` Lists the lines for a job so that reports or statuses can be determined for a job. Line information will only remain around for 30 days. - [Create Bulk Transaction](https://developer.authvia.com/reference/create-bulk-transaction.md): > πŸ”‘ [scope](intro/authentication#scopes) `transactions:create` Create bulk [Transactions](transactions) to process multiple financial operations in a single request. This enables efficient batch processing for scenarios like recurring payments, bulk refunds, or mass customer updates. Bulk [Transactions](transactions) allow merchants to streamline operations by grouping related financial activities together, reducing API calls and improving processing efficiency. > πŸ“˜ Info > > Each transaction in the bulk request is processed individually, so partial failures are possible. Check the response array for individual transaction statuses. > ⚠️ Warning > > The bulk transaction limit is 100 transactions per request. For larger batches, split your requests accordingly. > πŸ’‘ **Customer Transaction Behaviors** > > For customer-specific transaction behaviors, see the [Customer Transactions](transactions) endpoint which provides additional features like customer context, payment method validation, and customer-specific business rules. > πŸ”„ **Bulk Operations** > > For bulk transaction processing, you can also use the [SFTP bulk operations](sftp-transactions) which allow you to upload CSV files for large-scale transaction processing. This is ideal for scenarios requiring hundreds or thousands of transactions. After creating bulk [Transactions](transactions), you can monitor their status using the [Jobs](jobs) endpoint or set up [webhook subscriptions](webhook-subscriptions) to receive real-time updates. - [Conditions](https://developer.authvia.com/reference/subscriptions-conditions.md): Restrict when your destination will be invoked. - [Delivery Verification](https://developer.authvia.com/reference/subscriptions-verification.md): How can you be sure we sent the payload to you. - [Permissions](https://developer.authvia.com/reference/subscriptions-permissions.md): What permissions are needed when defining a [Subscription](webhook-subscriptions). - [Redrive Policy](https://developer.authvia.com/reference/subscriptions-redrive.md): How we will attempt to send your system when it fails. - [Webhook Events](https://developer.authvia.com/reference/subscriptions-events.md): Available webhook event types and their payloads. - [Create Subscription](https://developer.authvia.com/reference/create-webhook-subscription.md): > πŸ”‘ [scope](intro/authentication#scopes) subscriptions:create + {resource}:read > > > {resource}:read for the type of [Subscription](webhook-subscriptions) being created, such as `business_processes:read` Create [webhook subscriptions](webhook-subscriptions) to receive real-time notifications when specific events occur in your [Account](account). This enables your systems to stay synchronized with [Customer](customers) activities, [Transaction](transactions) updates, and [Business Process](create-business-process) changes. Webhooks are essential for building responsive applications that react to events as they happen, rather than polling for changes. > πŸ“˜ Info > > We make an API call to the destination URL with a test payload to verify that it's valid and working, expecting a response with a status code between 200 and 399. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). After creating a [Subscription](webhook-subscriptions), you can manage it using the [Update Subscription](update-subscription) endpoint or monitor delivery status through the [Subscription Events](get-subscription-events-list) endpoint. - [List Subscriptions](https://developer.authvia.com/reference/get-subscriptions-list.md): > πŸ”‘ [scope](intro/authentication#scopes) subscriptions:read Allows the retrieval of a comprehensive list of [webhook subscriptions](webhook-subscriptions). This capability is crucial for effectively managing and monitoring webhook configurations, ensuring smooth event handling, maintaining system synchronization, and gaining insights into active integrations. - [Get Subscription](https://developer.authvia.com/reference/get-webhook-subscription.md): > πŸ”‘ [scope](intro/authentication#scopes) subscriptions:read Allows the retrieval of detailed information about a specific webhook [Subscription](webhook-subscriptions) based on its unique identifier. This is crucial for verifying [Subscription](webhook-subscriptions) details. - [Delete Subscription](https://developer.authvia.com/reference/delete-webhook-subscription.md): > πŸ”‘ [scope](intro/authentication#scopes) subscriptions:delete Permanently removes a specific [Subscription](webhook-subscriptions) from the [Account](account) (Merchant) using [Subscription](webhook-subscriptions) ID. > ⚠️ Warning > This action is irreversible and should be used with caution, Ensure the [Subscription](webhook-subscriptions) ID is correct before executing. - [Update Subscription Status](https://developer.authvia.com/reference/update-subscription.md): Enables toggling of a webhook's active status, allowing for temporary disabling without deletion. Useful for maintenance periods or when changes to the receiving endpoint are needed. Required Scope: `subscriptions:update` and respective `{resource}:read` for the [Subscription](webhook-subscriptions) type. - [List Subscription Events](https://developer.authvia.com/reference/get-subscription-events-list.md): > πŸ”‘ [scope](intro/authentication#scopes) subscriptions:read Enables the retrieval of a comprehensive list of [webhook subscriptions](webhook-subscriptions) vents within a [account](account) merchant for a specified [webhook subscriptions](webhook-subscriptions). This functionality is essential for efficiently managing and monitoring webhook execution. This ensures smooth event handling, maintains system synchronization, and provides insights into active integrations. - [Job Created](https://developer.authvia.com/reference/job-create-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `jobs.create` Receive real-time notifications when new [Jobs](jobs) are created in your [Account](account). This webhook enables you to synchronize your systems with job creation events. > πŸ“˜ Info > > The webhook payload contains the job ID and basic details. Use the [Get Job](get-account-job) endpoint to retrieve complete job information. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your job management system, triggering notifications, or logging job events in your analytics platform. - [Job Updated](https://developer.authvia.com/reference/job-updated-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `jobs.update` Receive real-time notifications when [Jobs](jobs) are updated in your [Account](account). This webhook enables you to synchronize your systems with job status changes. > πŸ“˜ Info > > The webhook payload contains the job ID and updated details. Use the [Get Job](get-account-job) endpoint to retrieve complete job information. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your job management system, triggering notifications, or logging job status changes in your analytics platform. - [Customers](https://developer.authvia.com/reference/customers.md): Catalog of all the providers we support for customers. - [Customer Signup](https://developer.authvia.com/reference/customer-signup.md): Enabling your customers to create their own [Customer](customers) records. - [CRM Push](https://developer.authvia.com/reference/customer-crm-push.md): Pushing customer data to other CRM systems. - [Just In Time](https://developer.authvia.com/reference/customer-just-in-time.md): You can configure a customers/crm provider to load a [Customer](customers) as it's looking for. - [Create Customer](https://developer.authvia.com/reference/create-customer.md): > πŸ”‘ [scope](intro/authentication#scopes) `customers:create` Create a new [Customer](customers) for the specified [Account](account) (Merchant). This endpoint allows you to establish a customer relationship and store customer information for future interactions. > πŸ“˜ Info > > The `ref` field is required and must be unique within your account. This reference will be used to identify the customer in subsequent API calls. > > You can add customer addresses and metadata during creation or update them later using the respective endpoints. > πŸ’‘ **Tip**: For bulk customer creation, consider using the [SFTP bulk operations](sftp-customers) which allow you to upload CSV files for large-scale customer onboarding. - [List Customers](https://developer.authvia.com/reference/list-customers.md): > πŸ”‘ [scope](intro/authentication#scopes) `customers:read` Retrieve a list of [Customers](customers) for the specified [Account](account) (Merchant). This endpoint allows you to view all customers associated with your account. > πŸ“˜ Info > > The response includes pagination information to help you navigate through large customer lists. > > You can filter customers by various criteria and sort the results as needed. > πŸ’‘ **Tip**: For large customer lists, consider using pagination parameters to optimize performance and reduce response times. - [Get Customer](https://developer.authvia.com/reference/get-customer.md): > πŸ”‘ [scope](intro/authentication#scopes) `customers:read` Retrieve a specific [Customer](customers) by their reference ID. This endpoint allows you to view detailed customer information including profile, addresses, and metadata. > πŸ“˜ Info > > The customer reference must exist within your account. This endpoint returns complete customer details including all associated addresses and metadata. - [Update Customer](https://developer.authvia.com/reference/patch-customer.md): > πŸ”‘ [scope](intro/authentication#scopes) `customers:update` Update a specific [Customer](customers) by their reference ID. This endpoint allows you to modify customer information including profile, addresses, and metadata. > πŸ“˜ Info > > The customer reference must exist within your account. This endpoint allows partial updates - only the fields you specify will be modified. > > Use PUT for complete replacement if you need to replace all customer data. > πŸ’‘ **Tip**: Use PATCH for efficient updates when you only need to modify specific fields. - [Update Customer](https://developer.authvia.com/reference/update-customer.md): > πŸ”‘ [scope](intro/authentication#scopes) `customers:update` Update a specific [Customer](customers) by their reference ID. This endpoint allows you to modify customer information including profile, addresses, and metadata. > πŸ“˜ Info > > The customer reference must exist within your account. This endpoint replaces all customer data with the provided information. > > Use PATCH for partial updates if you only need to modify specific fields. - [Delete Customer](https://developer.authvia.com/reference/delete-customer.md): > πŸ”‘ [scope](intro/authentication#scopes) `customers:delete` Delete a specific [Customer](customers) by their reference ID. This endpoint permanently removes the customer and all associated data from your account. > ⚠️ Warning > > This action is irreversible. All customer data, including payment methods, transactions, and business processes, will be permanently deleted. > > Consider deactivating the customer instead if you may need to restore the data later. - [Customer Addresses Overiew](https://developer.authvia.com/reference/customer-addresses-overview.md): An overview of relation between [Customer](customers) and addressess. - [Create Customer Address](https://developer.authvia.com/reference/create-customer-address.md): > πŸ”‘ [scope](intro/authentication#scopes) `customers:create` Create a new [Address](create-customer-address) for the specified [Customer](customers). This endpoint allows you to add contact information to a customer profile. > πŸ“˜ Info > > The customer reference must exist within your account. You can add multiple addresses of different types (email, phone, postal). > > Addresses are validated before being associated with the customer. > πŸ’‘ **Tip**: Use this endpoint to add contact information like email addresses, phone numbers, or postal addresses to customer profiles. - [List Address](https://developer.authvia.com/reference/list-customer-addresses.md): > πŸ”‘ [scope](intro/authentication#scopes) `customers:read` Retrieve a list of [Addresses](list-customer-addresses) for the specified [Customer](customers). This endpoint allows you to view all addresses associated with a customer. > πŸ“˜ Info > > The response includes pagination information to help you navigate through large address lists. > > You can filter addresses by various criteria and sort the results as needed. > πŸ’‘ **Tip**: For large address lists, consider using pagination parameters to optimize performance and reduce response times. - [Replace Address](https://developer.authvia.com/reference/replace-customer-addresses.md): > πŸ”‘ [scope](intro/authentication#scopes) `customers:update` Replace all [Addresses](list-customer-addresses) for the specified [Customer](customers). This endpoint allows you to completely update the customer's contact information. > πŸ“˜ Info > > The customer reference must exist within your account. This endpoint replaces ALL existing addresses with the new list provided. > > Use PATCH for individual address updates if you want to preserve existing addresses. > ⚠️ Warning > > This action will replace all existing addresses. Any addresses not included in the request will be removed. > πŸ’‘ **Tip**: Use this endpoint when you need to completely update a customer's contact information. - [Relationship to Blueprints](https://developer.authvia.com/reference/relationship-to-blueprints.md): Serves as a detailed plan that helps businesses explain how they interact with their Customers. - [Status](https://developer.authvia.com/reference/business-process-status.md): This overview details the possible statuses of a [Business Process](business-processes) and their potential impacts. - [Notifications](https://developer.authvia.com/reference/business-process-notifications.md): Messages are sent to participants as appropriate. - [Participants](https://developer.authvia.com/reference/business-process-participants.md): Multiple Participants and Data Isolation - [Union](https://developer.authvia.com/reference/business-processes-union.md): Unioning actions gives structure to the relationship between actions. - [Create Business Process](https://developer.authvia.com/reference/create-business-process.md): > πŸ”‘ [scope](intro/authentication#scopes) `business_processes:create` Allows an [account](account) (merchant) to create a [Business Process](create-business-process) for their [Customer](customers) with a series of [Actions](acknowledgement-action) tailored to business requirements. These [Actions](acknowledgement-action) may include performing a [payment](payment-action), capturing the [payment method](payment-method-action), [approval](approval-action), [acknowledgement](acknowledgement-action), and more. > πŸ“– Info > The [Business Process](create-business-process) can be constructed using any combination of [Actions](acknowledgement-action), with the order of [Actions](acknowledgement-action) customizable based on specific requirements. > > [Actions](acknowledgement-action) are accompanied by a [union](business-processes-union) feature, allowing relationships to be established between them. This makes the [Business Process](create-business-process) highly adaptable to meet various business needs. > πŸ’‘ **Tip**: For more structure and predictability in creating business processes, consider using [Blueprints](blueprints). Blueprints provide predefined templates and workflows that can streamline your business process creation and ensure consistency across your applications. - [List Business Processes](https://developer.authvia.com/reference/list-business-processes.md): > πŸ”‘ [scope](intro/authentication#scopes) `business_processes:read` Retrieve a list of [Business Processes](business-processes) for the specified [Customer](customers). This endpoint allows you to view all business processes associated with a customer. > πŸ“˜ Info > > The response includes pagination information to help you navigate through large business process lists. > > You can filter business processes by various criteria and sort the results as needed. > πŸ’‘ **Tip**: For large business process lists, consider using pagination parameters to optimize performance and reduce response times. - [Get Business Process](https://developer.authvia.com/reference/get-business-process.md): > πŸ”‘ [scope](intro/authentication#scopes) `business_processes:read` Retrieve a specific [Business Process](business-processes) by its ID. This endpoint allows you to view detailed business process information including actions, status, and metadata. > πŸ“˜ Info > > The business process ID must exist within your account. This endpoint returns complete business process details including all actions and their status. > πŸ’‘ **Tip**: Use this endpoint to get detailed information about a specific business process and its current state. - [Update Business Process](https://developer.authvia.com/reference/patch-business-process.md): > πŸ”‘ [scope](intro/authentication#scopes) `business_processes:update` Update a specific [Business Process](business-processes) by its ID. This endpoint allows you to modify business process information including status, metadata, and configuration. > πŸ“˜ Info > > The business process ID must exist within your account. This endpoint allows partial updates - only the fields you specify will be modified. > > Use PUT for complete replacement if you need to replace all business process data. > πŸ’‘ **Tip**: Use PATCH for efficient updates when you only need to modify specific fields of a business process. - [Actions](https://developer.authvia.com/reference/business-process-actions.md): Represents a distinct step or operation within the [Business Process](business-processes), such as a payment or capture payment-method step. - [Action Statuses](https://developer.authvia.com/reference/action-status.md): This overview details the possible statuses of a [Actions](business-process-actions). - [List Actions](https://developer.authvia.com/reference/list-business-process-actions.md): > πŸ”‘ [scope](intro/authentication#scopes) `business_processes:read` Allows the retrieval of [Business Process](create-business-process) actions associated to a specific [Business Process](create-business-process) and [Customer](customers) reference within the merchant's [Account](account). This is valuable for monitoring and auditing [Business Process](create-business-process) activities, allowing merchants to verify that each action has been completed as expected. > 🎯 Explore Action types > For detailed information about available action types, please refer to the [Action Catalog](acknowledgement-action) section. - [Get Action](https://developer.authvia.com/reference/get-business-process-action.md): > πŸ”‘ [scope](intro/authentication#scopes) `business_processes:read` Retrieves detailed information on specific [Business Process](create-business-process) action associated with a particular [Business Process](create-business-process) and [Customer](customers) reference within the [Account's](account) (Merchant's) [Account](account). Use this API to track, verify, and analyze individual [Business Process](create-business-process) actions effectively. > 🎯 Explore Action types > For detailed information about available action types, please refer to the [Action Catalog](acknowledgement-action) section. - [Auto Tokenization](https://developer.authvia.com/reference/auto-tokenization.md): Understanding automatic tokenization when creating payment methods - [Payment Method Permissions](https://developer.authvia.com/reference/permissions.md): Understanding how permissions work for payment methods - [PCI and Security](https://developer.authvia.com/reference/pci-and-security.md): Understanding PCI compliance and security measures for payment methods - [Bulk PCI Services](https://developer.authvia.com/reference/bulk-pci-services.md): Professional PCI services for bulk payment method processing - [Create Payment Method](https://developer.authvia.com/reference/create-payment-method.md): > πŸ”‘ [scope](intro/authentication#scopes) `payment_methods:create` Allows an [account](account) to create a [Payment Method](payment-methods) for their [Customer](customers). This endpoint supports two types of payment method creation: **Token**: Use an existing token to create a payment method **Tokenize**: Create a new tokenized payment method from an existing payment method ID > πŸ“– Info > The payment method will be associated with the specified customer and can be used for future transactions. - [List Payment Methods](https://developer.authvia.com/reference/list-payment-methods.md): > πŸ”‘ [scope](intro/authentication#scopes) `payment_methods:read` Enables retrieval of a summary list of [Payment Methods](payment-methods) related to the specified [Customer](customers). - [Transaction Status Flows](https://developer.authvia.com/reference/transaction-status-flows.md): matt@authvia.com - [List Transactions](https://developer.authvia.com/reference/list-customer-transactions.md): > πŸ”‘ [scope](intro/authentication#scopes) `transactions:read` Retrieve a list of [Transactions](transactions) associated with the specified [Customer](customers). This endpoint returns all transactions for the customer, including charges, authorizations, payouts, reversals, refunds, captures, and voids. > πŸ“˜ Info > > Transactions are returned in reverse chronological order (newest first). Use query parameters to filter and paginate results. - [Create Transaction](https://developer.authvia.com/reference/create-customer-transaction.md): > πŸ”‘ [scope](intro/authentication#scopes) `transactions:create` Create a new [Transaction](transactions) for the specified [Customer](customers). This endpoint supports multiple transaction types: **CHARGE**: Process a payment using a stored payment method **AUTHORIZE**: Authorize a payment for later capture **PAYOUT**: Send money to a customer **REVERSAL**: Reverse a previous transaction **NONE**: Create a transaction record without processing > πŸ“– Info > > For CHARGE, AUTHORIZE, and PAYOUT transactions, you must provide a `paymentMethodId` referencing an existing stored payment method. > > For REVERSAL transactions, you must provide the `transactionId` of the original transaction to reverse. > > Currency defaults to USD if not specified. > πŸ”„ **Bulk Transactions** > > For processing multiple transactions at once, use the [Bulk Transactions](transactions) endpoint which allows you to create up to 100 transactions in a single request. - [Get Transaction](https://developer.authvia.com/reference/get-transaction.md): > πŸ”‘ [scope](intro/authentication#scopes) `transactions:read` Retrieve the detailed [Transaction](transactions) record by its unique identifier. This endpoint returns comprehensive transaction information including status, payment method details, metadata, and any child transactions. > πŸ“˜ Info > > The response includes the full transaction history and any related child transactions (captures, refunds, voids, reversals). - [Create Child Transaction](https://developer.authvia.com/reference/create-child-transaction.md): > πŸ”‘ [scope](intro/authentication#scopes) `transactions:create` Create a child [Transaction](transactions) related to the specified parent transaction. This endpoint supports creating child transactions for existing transactions: **CAPTURE**: Capture a previously authorized transaction **REFUND**: Refund a portion or full amount of a completed transaction **VOID**: Void an authorized transaction before capture **REVERSAL**: Reverse a transaction (same as refund) > πŸ“– Info > > Child transactions must reference the parent transaction via the `originId` field, which is automatically set to the parent transaction ID. > > For CAPTURE and REFUND transactions, you can specify a partial amount. If no amount is provided for a REFUND, the full original amount will be refunded. > > VOID transactions can only be performed on authorized transactions that haven't been captured. - [Transaction Created](https://developer.authvia.com/reference/transaction-created-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `transactions.create` Receive real-time notifications when new [Transactions](transactions) are created in your [Account](account). This webhook enables you to synchronize your systems with transaction creation events. > πŸ“˜ Info > > The webhook payload contains the transaction ID and basic details. Use the [Get Transaction](get-transaction) endpoint to retrieve complete transaction information. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your accounting system, triggering notifications, or logging transaction events in your analytics platform. - [Transaction Updated](https://developer.authvia.com/reference/transactions-updated-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `transactions.update` Receive real-time notifications when [Transactions](transactions) are updated in your [Account](account). This webhook enables you to synchronize your systems with transaction status changes. > πŸ“˜ Info > > The webhook payload contains the transaction ID and updated details. Use the [Get Transaction](transactions) endpoint to retrieve complete transaction information. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your accounting system, triggering notifications, or logging transaction status changes in your analytics platform. - [Payment Method Created](https://developer.authvia.com/reference/payment-method-create-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `payment_method.create` Receive real-time notifications when new [Payment Methods](payment-methods) are created in your [Account](account). This webhook enables you to synchronize your systems with payment method creation events. > πŸ“˜ Info > > The webhook payload contains the payment method ID and basic details. Use the [Get Payment Method](get-payment-method) endpoint to retrieve complete payment method information. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your payment processing system, triggering notifications, or logging payment method events in your analytics platform. - [Payment Method Updated](https://developer.authvia.com/reference/payment-method-updated-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `payment_method.updated` Receive real-time notifications when [Payment Methods](payment-methods) are updated in your [Account](account). This webhook enables you to synchronize your systems with payment method modification events. > πŸ“˜ Info > > The webhook payload contains the payment method ID and updated details. Use the [Get Payment Method](get-payment-method) endpoint to retrieve complete payment method information. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your payment processing system, triggering notifications, or logging payment method changes in your analytics platform. - [Business Process Created](https://developer.authvia.com/reference/business-process-created-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `business_processes.create` Receive real-time notifications when new [Business Processes](business-processes) are created in your [Account](account). This webhook enables you to synchronize your systems with business process events, such as when new workflows are initiated. > πŸ“˜ Info > > The webhook payload contains the business process ID and basic details. Use the [Get Business Process](get-business-process) endpoint to retrieve complete information. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your workflow management system, triggering notifications, or logging business process events in your analytics platform. - [Business Process Updated](https://developer.authvia.com/reference/business-process-updated-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `business_processes.update` Receive real-time notifications when [Business Processes](business-processes) are updated in your [Account](account). This webhook enables you to synchronize your systems with business process status changes, such as when workflows complete or fail. > πŸ“˜ Info > > The webhook payload contains the business process ID and updated details. Use the [Get Business Process](get-business-process) endpoint to retrieve complete information. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your workflow management system, triggering notifications, or logging business process status changes in your analytics platform. - [Business Process Action Created](https://developer.authvia.com/reference/business-process-action-created-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `business_processes_actions.create` Receive real-time notifications when new [Business Process Actions](business-process-actions) are created in your [Account](account). This webhook enables you to synchronize your systems with action events, such as when new steps are initiated in a workflow. > πŸ“˜ Info > > The webhook payload contains the action ID and basic details. Use the [Get Business Process Action](get-business-process-action) endpoint to retrieve complete information. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your workflow management system, triggering notifications, or logging action events in your analytics platform. - [Business Process Action Updated](https://developer.authvia.com/reference/business-process-action-updated-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `business_processes_actions.update` Receive real-time notifications when [Business Process Actions](business-process-actions) are updated in your [Account](account). This webhook enables you to synchronize your systems with action status changes, such as when steps complete or fail. > πŸ“˜ Info > > The webhook payload contains the action ID and updated details. Use the [Get Business Process Action](get-business-process-action) endpoint to retrieve complete information. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your workflow management system, triggering notifications, or logging action status changes in your analytics platform. - [Customer Created](https://developer.authvia.com/reference/customers-create-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `customers.create` Receive real-time notifications when new [Customers](customers) are created in your [Account](account). This webhook enables you to synchronize your systems with customer events, such as when customers sign up or are added through your application. > πŸ“˜ Info > > The webhook payload contains the customer reference and basic details. Use the [Get Customer](get-customer) endpoint to retrieve complete customer information. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your CRM system, triggering welcome emails, or logging customer events in your analytics platform. - [Customer Updated](https://developer.authvia.com/reference/customer-updated-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `customers.update` Receive real-time notifications when [Customers](customers) are updated in your [Account](account). This webhook enables you to synchronize your systems with customer changes, such as when customer information is modified. > πŸ“˜ Info > > The webhook payload contains the customer reference and updated details. Use the [Get Customer](get-customer) endpoint to retrieve complete customer information. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your CRM system, triggering notifications, or logging customer changes in your analytics platform. - [Customer Deleted](https://developer.authvia.com/reference/customer-deleted-webhook.md): > πŸ“¬ Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `customers.delete` Receive real-time notifications when [Customers](customers) are deleted from your [Account](account). This webhook enables you to synchronize your systems with customer removal events. > πŸ“˜ Info > > The webhook payload contains the customer reference and deletion details. Note that the customer data may no longer be accessible through the API. > ⚠️ Warning > > Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive). Common use cases include updating your CRM system, triggering cleanup processes, or logging customer deletion events in your analytics platform. - [Acknowledgement](https://developer.authvia.com/reference/acknowledgement-action.md): Acknowledgement action is used to receive user consent - [Approval](https://developer.authvia.com/reference/approval-action.md): Approval action is used to invoke an external system upon user approval - [Choice](https://developer.authvia.com/reference/choice-action.md): Customers can make a choice between the supplied options. - [Convenience-fee](https://developer.authvia.com/reference/convenience-fee-action.md): Add convenience fees to a payment. - [Customer-update](https://developer.authvia.com/reference/customer-update-action.md): The customer-update action allows you to update or add values to a customer record based on the customers/crm/authvia schema. - [Instructions](https://developer.authvia.com/reference/instructions-action.md): Short instructional text snippets for web and messaging. - [Markdown](https://developer.authvia.com/reference/markdown-action.md): Enables the display of acceptable markdown in the business process experience. - [Metadata](https://developer.authvia.com/reference/metadata-action.md): A non-rendering action used purely as a data vessel, designed to pass through metadata from creation to resolution or failure without any additional logic. - [Line-items](https://developer.authvia.com/reference/line-items-action.md): An invoice or cart showing a list of items to be paid for. - [Line-item-customization](https://developer.authvia.com/reference/line-item-customization-action.md): A deeper interaction for a single line of line-items. - [Payment](https://developer.authvia.com/reference/payment-action.md): You can request customers pay for a product/service. - [Payment-amount-selection](https://developer.authvia.com/reference/payment-amount-selection-action.md): Customer amount selection, generally for payments. - [Payment-method](https://developer.authvia.com/reference/payment-method-action.md): Allow customers access to their wallet - [Payout](https://developer.authvia.com/reference/payout-action.md): When you need to pay funds to a customer. - [Reminder](https://developer.authvia.com/reference/reminder-action.md): Merchants can schedule reminders for a business process. - [Service-fee](https://developer.authvia.com/reference/service-fee-action.md): Add service fees to a payment. - [Signature](https://developer.authvia.com/reference/signature-action.md): Collect customer digital signatures to serve as approval, if needed. - [Simple-value](https://developer.authvia.com/reference/simple-value-action.md): Simple value input collects one piece of data from the user, typically through a dedicated form field. - [Surcharge](https://developer.authvia.com/reference/surcharge-action.md): A surcharge fee applied to a payment. - [Tip](https://developer.authvia.com/reference/tip-action.md): Allow customers to add a tip to their payment. - [Value-verification](https://developer.authvia.com/reference/value-verification-action.md): Check whether the customer has or knows a shared value. - [Authentic-id](https://developer.authvia.com/reference/authentic-id-action.md): You can verify a customer’s identity using a government-issued ID and a live selfie. - [Request-attachment](https://developer.authvia.com/reference/request-attachment-action.md): Customers can upload up to 25 supported files when requested or during the conversation. - [Threat-matrix](https://developer.authvia.com/reference/threat-matrix-action.md): Performs real-time fraud prevention analysis during Bank of America transaction processing. - [Upload-attachment](https://developer.authvia.com/reference/upload-attachment-action.md): You can share documents with customers for review. - [Custom-form](https://developer.authvia.com/reference/custom-form-action.md): A custom form action renders a structured form from a JSON Schema (and optional UI Schema) to collect multiple fields of data from the user in a single step. - [Incode](https://developer.authvia.com/reference/incode-action.md): You can verify a customer’s identity using a government-issued ID and a live selfie. - [MCP](https://developer.authvia.com/reference/mcp.md): matt@authvia.com - [Batch](https://developer.authvia.com/reference/batch.md): Catalog of all the providers we support for batch. - [SFTP](https://developer.authvia.com/reference/batch-sftp.md): Catalog of all the providers we support for sftp batch. - [Authvia](https://developer.authvia.com/reference/batch-sftp-authvia.md): How to enable Authvia SFTP on a merchant. - [Messaging](https://developer.authvia.com/reference/messaging.md): Catalog of all the providers we support for messaging. - [eMail](https://developer.authvia.com/reference/messaging-email.md): Catalog of all the providers we support for email messaging. - [Authvia](https://developer.authvia.com/reference/messaging-email-authvia.md): How to enable Authvia eMail on a merchant. - [SendGrid](https://developer.authvia.com/reference/messaging-email-sendgrid.md): How to enable SendGrid eMail on a merchant. - [Link Mask](https://developer.authvia.com/reference/messaging-link-mask.md): Catalog of all the providers we support for link-mask messaging. - [Authvia](https://developer.authvia.com/reference/messaging-link-mask-authvia.md): How to enable Authvia Link Mask on a merchant. - [Bitly](https://developer.authvia.com/reference/messaging-link-mask-bitly.md): How to enable Bitly Link Mask on a merchant. - [Mock](https://developer.authvia.com/reference/messaging-link-mask-mock.md): How to enable Mock Link Mask on a merchant. - [MMS](https://developer.authvia.com/reference/messaging-mms.md): Catalog of all the providers we support for mms messaging. - [Authvia](https://developer.authvia.com/reference/messaging-mms-authvia.md): How to enable Authvia MMS on a merchant. - [Capactiy](https://developer.authvia.com/reference/messaging-mms-capacity.md): How to enable Capactiy MMS on a merchant. - [Infobip Messages](https://developer.authvia.com/reference/messaging-mms-infobipmessages.md): How to enable Infobip Messages MMS on a merchant. - [Mock](https://developer.authvia.com/reference/messaging-mms-mock.md): How to enable Mock MMS on a merchant. - [Secure-US](https://developer.authvia.com/reference/messaging-mms-secure-us.md): How to enable Secure-US MMS on a merchant. - [Sinch](https://developer.authvia.com/reference/messaging-mms-sinch.md): How to enable Sinch MMS on a merchant. - [Syniverse](https://developer.authvia.com/reference/messaging-mms-syniverse.md): How to enable Syniverse MMS on a merchant. - [TextRequest](https://developer.authvia.com/reference/messaging-mms-textrequest.md): How to enable TextRequest MMS on a merchant. - [Twilio](https://developer.authvia.com/reference/messaging-mms-twilio.md): How to enable Twilio MMS on a merchant. - [RCS](https://developer.authvia.com/reference/messaging-rcs.md): Catalog of all the providers we support for rcs messaging. - [Infobip RCS](https://developer.authvia.com/reference/messaging-rcs-infobip.md): How to enable Infobip RCS RCS on a merchant. - [Mock](https://developer.authvia.com/reference/messaging-rcs-mock.md): How to enable Mock RCS on a merchant. - [SMS](https://developer.authvia.com/reference/messaging-sms.md): Catalog of all the providers we support for sms messaging. - [Capactiy](https://developer.authvia.com/reference/messaging-sms-capacity.md): How to enable Capactiy SMS on a merchant. - [Infobip Messages](https://developer.authvia.com/reference/messaging-sms-infobipmessages.md): How to enable Infobip Messages SMS on a merchant. - [Mock](https://developer.authvia.com/reference/messaging-sms-mock.md): How to enable Mock SMS on a merchant. - [Nexmo](https://developer.authvia.com/reference/messaging-sms-nexmo.md): How to enable Nexmo SMS on a merchant. - [Sinch](https://developer.authvia.com/reference/messaging-sms-sinch.md): How to enable Sinch SMS on a merchant. - [Syniverse](https://developer.authvia.com/reference/messaging-sms-syniverse.md): How to enable Syniverse SMS on a merchant. - [TextRequest](https://developer.authvia.com/reference/messaging-sms-textrequest.md): How to enable TextRequest SMS on a merchant. - [Twilio](https://developer.authvia.com/reference/messaging-sms-twilio.md): How to enable Twilio SMS on a merchant. - [VVP USA](https://developer.authvia.com/reference/messaging-sms-vvpusa.md): How to enable VVP USA SMS on a merchant. - [Payments](https://developer.authvia.com/reference/payments.md): Catalog of all the providers we support for payments. - [ACH](https://developer.authvia.com/reference/payments-ach.md): Catalog of all the providers we support for ach payments. - [Agave](https://developer.authvia.com/reference/payments-ach-agave.md): How to enable Agave ACH on a merchant. - [Authorize.net](https://developer.authvia.com/reference/payments-ach-authorizenet.md): How to enable Authorize.net ACH on a merchant. - [CardConnect CardPointe](https://developer.authvia.com/reference/payments-ach-cardconnect.md): How to enable CardConnect CardPointe ACH on a merchant. - [Cardknox](https://developer.authvia.com/reference/payments-ach-cardknox.md): How to enable Cardknox ACH on a merchant. - [Testing Test](https://developer.authvia.com/reference/payments-ach-cardpointe.md): How to enable Testing Test ACH on a merchant. - [Cybersource](https://developer.authvia.com/reference/payments-ach-cybersource.md): How to enable Cybersource ACH on a merchant. - [Elavon Converge](https://developer.authvia.com/reference/payments-ach-elavon.md): How to enable Elavon Converge ACH on a merchant. - [Fintainium Customer](https://developer.authvia.com/reference/payments-ach-fintanium-customer.md): How to enable Fintainium Customer ACH on a merchant. - [Maverick](https://developer.authvia.com/reference/payments-ach-maverick.md): How to enable Maverick ACH on a merchant. - [Mock](https://developer.authvia.com/reference/payments-ach-mock.md): How to enable Mock ACH on a merchant. - [Mock Charge](https://developer.authvia.com/reference/payments-ach-mock-charge.md): How to enable Mock Charge ACH on a merchant. - [NMI](https://developer.authvia.com/reference/payments-ach-nmi.md): How to enable NMI ACH on a merchant. - [JP Morgan Chase Orbital](https://developer.authvia.com/reference/payments-ach-orbital.md): How to enable JP Morgan Chase Orbital ACH on a merchant. - [Fiserv Paypoint](https://developer.authvia.com/reference/payments-ach-paypoint.md): How to enable Fiserv Paypoint ACH on a merchant. - [Payrix](https://developer.authvia.com/reference/payments-ach-payrix.md): How to enable Payrix ACH on a merchant. - [Payroc](https://developer.authvia.com/reference/payments-ach-payroc.md): How to enable Payroc ACH on a merchant. - [Paysafe](https://developer.authvia.com/reference/payments-ach-paysafe.md): How to enable Paysafe ACH on a merchant. - [Plug n Pay Standard](https://developer.authvia.com/reference/payments-ach-plugnpaystandard.md): How to enable Plug n Pay Standard ACH on a merchant. - [PNC](https://developer.authvia.com/reference/payments-ach-pnc.md): How to enable PNC ACH on a merchant. - [USAePay](https://developer.authvia.com/reference/payments-ach-usaepay.md): How to enable USAePay ACH on a merchant. - [Worldpay Vantiv / Express](https://developer.authvia.com/reference/payments-ach-vantiv.md): How to enable Worldpay Vantiv / Express ACH on a merchant. - [Usbank](https://developer.authvia.com/reference/payments-ach-usbank.md): How to enable Usbank ACH on a merchant. - [Credit Card](https://developer.authvia.com/reference/payments-creditcard.md): Catalog of all the providers we support for creditcard payments. - [Agave](https://developer.authvia.com/reference/payments-creditcard-agave.md): How to enable Agave Credit Card on a merchant. - [Authorize.net](https://developer.authvia.com/reference/payments-creditcard-authorizenet.md): How to enable Authorize.net Credit Card on a merchant. - [Avatas](https://developer.authvia.com/reference/payments-creditcard-avatas.md): How to enable Avatas Credit Card on a merchant. - [Bankofamerica](https://developer.authvia.com/reference/payments-creditcard-bankofamerica.md): How to enable Bankofamerica Credit Card on a merchant. - [Bluefin](https://developer.authvia.com/reference/payments-creditcard-bluefin.md): How to enable Bluefin Credit Card on a merchant. - [CardPointe](https://developer.authvia.com/reference/payments-creditcard-cardconnect.md): How to enable CardPointe Credit Card on a merchant. - [Cardknox](https://developer.authvia.com/reference/payments-creditcard-cardknox.md): How to enable Cardknox Credit Card on a merchant. - [Cybersource](https://developer.authvia.com/reference/payments-creditcard-cybersource.md): How to enable Cybersource Credit Card on a merchant. - [Elavon Converge](https://developer.authvia.com/reference/payments-creditcard-elavon.md): How to enable Elavon Converge Credit Card on a merchant. - [Fintainium Customer](https://developer.authvia.com/reference/payments-creditcard-fintanium-customer.md): How to enable Fintainium Customer Credit Card on a merchant. - [Fiserv CommerceHub](https://developer.authvia.com/reference/payments-creditcard-fiserv.md): How to enable Fiserv CommerceHub Credit Card on a merchant. - [Fullsteam](https://developer.authvia.com/reference/payments-creditcard-fullsteam.md): How to enable Fullsteam Credit Card on a merchant. - [Heartland](https://developer.authvia.com/reference/payments-creditcard-heartland.md): How to enable Heartland Credit Card on a merchant. - [Heartlandhealthcare](https://developer.authvia.com/reference/payments-creditcard-heartlandhealthcare.md): How to enable Heartlandhealthcare Credit Card on a merchant. - [Inovio](https://developer.authvia.com/reference/payments-creditcard-inovio.md): How to enable Inovio Credit Card on a merchant. - [Maverick](https://developer.authvia.com/reference/payments-creditcard-maverick.md): How to enable Maverick Credit Card on a merchant. - [Mock](https://developer.authvia.com/reference/payments-creditcard-mock.md): How to enable Mock Credit Card on a merchant. - [Mock](https://developer.authvia.com/reference/payments-creditcard-mock-charge.md): How to enable Mock Credit Card on a merchant. - [NMI](https://developer.authvia.com/reference/payments-creditcard-nmi.md): How to enable NMI Credit Card on a merchant. - [Orbital](https://developer.authvia.com/reference/payments-creditcard-orbital.md): How to enable Orbital Credit Card on a merchant. - [Payrix](https://developer.authvia.com/reference/payments-creditcard-payrix.md): How to enable Payrix Credit Card on a merchant. - [Payroc](https://developer.authvia.com/reference/payments-creditcard-payroc.md): How to enable Payroc Credit Card on a merchant. - [Paysafe](https://developer.authvia.com/reference/payments-creditcard-paysafe.md): How to enable Paysafe Credit Card on a merchant. - [Paytrace](https://developer.authvia.com/reference/payments-creditcard-paytrace.md): How to enable Paytrace Credit Card on a merchant. - [Plugnpaystandard](https://developer.authvia.com/reference/payments-creditcard-plugnpaystandard.md): How to enable Plugnpaystandard Credit Card on a merchant. - [Slimcd](https://developer.authvia.com/reference/payments-creditcard-slimcd.md): How to enable Slimcd Credit Card on a merchant. - [Stripe](https://developer.authvia.com/reference/payments-creditcard-stripe.md): How to enable Stripe Credit Card on a merchant. - [FIS WorldPay Vantiv Express](https://developer.authvia.com/reference/payments-creditcard-vantiv.md): How to enable FIS WorldPay Vantiv Express Credit Card on a merchant. - [FIS WorldPay Vantiv Express](https://developer.authvia.com/reference/payments-creditcard-vantiv-cert.md): How to enable FIS WorldPay Vantiv Express Credit Card on a merchant. - [Vantivhealthcare](https://developer.authvia.com/reference/payments-creditcard-vantivhealthcare.md): How to enable Vantivhealthcare Credit Card on a merchant. - [FluidPay](https://developer.authvia.com/reference/payments-creditcard-fluidpay.md): How to enable FluidPay Credit Card on a merchant. - [Mock Product3](https://developer.authvia.com/reference/payments-creditcard-mock-product-three.md): How to enable Mock Product3 Credit Card on a merchant. - [Elavon EPG](https://developer.authvia.com/reference/payments-creditcard-elavon-epg.md): How to enable Elavon EPG Credit Card on a merchant. - [Paze](https://developer.authvia.com/reference/payments-paze.md): Catalog of all the providers we support for paze payments. - [Elavon Converge](https://developer.authvia.com/reference/payments-paze-elavon-converge.md): How to enable Elavon Converge Paze on a merchant. - [Mock](https://developer.authvia.com/reference/payments-paze-mock.md): How to enable Mock Paze on a merchant. - [Mock Charge](https://developer.authvia.com/reference/payments-paze-mock-charge.md): How to enable Mock Charge Paze on a merchant. - [Token](https://developer.authvia.com/reference/payments-token.md): Catalog of all the providers we support for token payments. - [Braintree](https://developer.authvia.com/reference/payments-token-braintree.md): How to enable Braintree Token on a merchant. - [Cardconnect](https://developer.authvia.com/reference/payments-token-cardconnect.md): How to enable Cardconnect Token on a merchant. - [Fintainium Customer](https://developer.authvia.com/reference/payments-token-fintanium-customer.md): How to enable Fintainium Customer Token on a merchant. - [FluidPay](https://developer.authvia.com/reference/payments-token-fluidpay.md): How to enable FluidPay Token on a merchant. - [Fullsteam](https://developer.authvia.com/reference/payments-token-fullsteam.md): How to enable Fullsteam Token on a merchant. - [Heartland](https://developer.authvia.com/reference/payments-token-heartland.md): How to enable Heartland Token on a merchant. - [Heartland Healthcare](https://developer.authvia.com/reference/payments-token-heartlandhealthcare.md): How to enable Heartland Healthcare Token on a merchant. - [Heartland Healthcare AuthOnly](https://developer.authvia.com/reference/payments-token-heartlandhealthcare-authonly.md): How to enable Heartland Healthcare AuthOnly Token on a merchant. - [Mock](https://developer.authvia.com/reference/payments-token-mock.md): How to enable Mock Token on a merchant. - [Mock Charge](https://developer.authvia.com/reference/payments-token-mock-charge.md): How to enable Mock Charge Token on a merchant. - [Orbital](https://developer.authvia.com/reference/payments-token-orbital.md): How to enable Orbital Token on a merchant. - [Fiserv Paypoint](https://developer.authvia.com/reference/payments-token-paypoint.md): How to enable Fiserv Paypoint Token on a merchant. - [Stripe](https://developer.authvia.com/reference/payments-token-stripe.md): How to enable Stripe Token on a merchant. - [Stripe- Authorize Only](https://developer.authvia.com/reference/payments-token-stripe-authorizeonly.md): How to enable Stripe- Authorize Only Token on a merchant. - [Stripe- Multiuse Token](https://developer.authvia.com/reference/payments-token-stripe-multiuse.md): How to enable Stripe- Multiuse Token Token on a merchant. - [Tilled](https://developer.authvia.com/reference/payments-token-tilled.md): How to enable Tilled Token on a merchant. - [FIS WorldPay Vantiv Express](https://developer.authvia.com/reference/payments-token-vantiv-creditcard.md): How to enable FIS WorldPay Vantiv Express Token on a merchant. - [FIS WorldPay Vantiv Express](https://developer.authvia.com/reference/payments-token-vantiv-creditcard-cert.md): How to enable FIS WorldPay Vantiv Express Token on a merchant. - [FIS WorldPay Vantiv Express PassToken](https://developer.authvia.com/reference/payments-token-vantiv-passtoken.md): How to enable FIS WorldPay Vantiv Express PassToken Token on a merchant. - [Elavon EPG](https://developer.authvia.com/reference/payments-token-elavon-epg.md): How to enable Elavon EPG Token on a merchant. - [Elavon EPG ACH](https://developer.authvia.com/reference/payments-token-elavon-epg-ach.md): How to enable Elavon EPG ACH Token on a merchant. - [FIS WorldPay Vantiv Express PassToken](https://developer.authvia.com/reference/payments-token-vantiv-passtoken-creditcard.md): How to enable FIS WorldPay Vantiv Express PassToken Token on a merchant. - [FIS WorldPay Vantiv Express PassToken](https://developer.authvia.com/reference/payments-token-vantiv-passtoken-creditcard-cert.md): How to enable FIS WorldPay Vantiv Express PassToken Token on a merchant. - [paypal](https://developer.authvia.com/reference/payments-paypal.md): Catalog of all the providers we support for paypal payments. - [Paypal](https://developer.authvia.com/reference/payments-paypal-paypal.md): How to enable Paypal paypal on a merchant. - [venmo](https://developer.authvia.com/reference/payments-venmo.md): Catalog of all the providers we support for venmo payments. - [Paypal](https://developer.authvia.com/reference/payments-venmo-paypal.md): How to enable Paypal venmo on a merchant. - [Payouts](https://developer.authvia.com/reference/payouts.md): Catalog of all the providers we support for payouts. - [ACH](https://developer.authvia.com/reference/payouts-ach.md): Catalog of all the providers we support for ach payouts. - [Checkcommerce](https://developer.authvia.com/reference/payouts-ach-checkcommerce.md): How to enable Checkcommerce ACH on a merchant. - [Mock](https://developer.authvia.com/reference/payouts-ach-mock.md): How to enable Mock ACH on a merchant. - [Credit Card](https://developer.authvia.com/reference/payouts-creditcard.md): Catalog of all the providers we support for creditcard payouts. - [Mock](https://developer.authvia.com/reference/payouts-creditcard-mock.md): How to enable Mock Credit Card on a merchant. - [Nuvei](https://developer.authvia.com/reference/payouts-creditcard-nuvei.md): How to enable Nuvei Credit Card on a merchant. - [paypal](https://developer.authvia.com/reference/payouts-paypal.md): Catalog of all the providers we support for paypal payouts. - [Mock](https://developer.authvia.com/reference/payouts-paypal-mock.md): How to enable Mock paypal on a merchant. - [Paypal](https://developer.authvia.com/reference/payouts-paypal-paypal.md): How to enable Paypal paypal on a merchant. - [Token](https://developer.authvia.com/reference/payouts-token.md): Catalog of all the providers we support for token payouts. - [Mock](https://developer.authvia.com/reference/payouts-token-mock.md): How to enable Mock Token on a merchant. - [PNC](https://developer.authvia.com/reference/payouts-token-pnc.md): How to enable PNC Token on a merchant. - [venmo](https://developer.authvia.com/reference/payouts-venmo.md): Catalog of all the providers we support for venmo payouts. - [Mock](https://developer.authvia.com/reference/payouts-venmo-mock.md): How to enable Mock venmo on a merchant. - [Paypal](https://developer.authvia.com/reference/payouts-venmo-paypal.md): How to enable Paypal venmo on a merchant. - [Tokenize](https://developer.authvia.com/reference/tokenize.md): Catalog of all the providers we support for tokenize. - [ACH](https://developer.authvia.com/reference/tokenize-ach.md): Catalog of all the providers we support for ach tokenize. - [Fintainium Customer](https://developer.authvia.com/reference/tokenize-ach-fintanium-customer.md): How to enable Fintainium Customer ACH on a merchant. - [Masspay ACH](https://developer.authvia.com/reference/tokenize-ach-masspayach.md): How to enable Masspay ACH ACH on a merchant. - [Mock](https://developer.authvia.com/reference/tokenize-ach-mock.md): How to enable Mock ACH on a merchant. - [Fiserv Paypoint](https://developer.authvia.com/reference/tokenize-ach-paypoint.md): How to enable Fiserv Paypoint ACH on a merchant. - [Stripe- MultiUse Token](https://developer.authvia.com/reference/tokenize-ach-stripe-multiuse.md): How to enable Stripe- MultiUse Token ACH on a merchant. - [Elavon EPG ACH](https://developer.authvia.com/reference/tokenize-ach-elavon-epg.md): How to enable Elavon EPG ACH ACH on a merchant. - [Credit Card](https://developer.authvia.com/reference/tokenize-creditcard.md): Catalog of all the providers we support for creditcard tokenize. - [Braintree](https://developer.authvia.com/reference/tokenize-creditcard-braintree.md): How to enable Braintree Credit Card on a merchant. - [CardConnect](https://developer.authvia.com/reference/tokenize-creditcard-cardconnect.md): How to enable CardConnect Credit Card on a merchant. - [Fintanium Customer](https://developer.authvia.com/reference/tokenize-creditcard-fintanium-customer.md): How to enable Fintanium Customer Credit Card on a merchant. - [Fullsteam](https://developer.authvia.com/reference/tokenize-creditcard-fullsteam.md): How to enable Fullsteam Credit Card on a merchant. - [Heartland](https://developer.authvia.com/reference/tokenize-creditcard-heartland.md): How to enable Heartland Credit Card on a merchant. - [Heartland Healthcare](https://developer.authvia.com/reference/tokenize-creditcard-heartlandhealthcare.md): How to enable Heartland Healthcare Credit Card on a merchant. - [Heartland Healthcare AuthOnly](https://developer.authvia.com/reference/tokenize-creditcard-heartlandhealthcare-authonly.md): How to enable Heartland Healthcare AuthOnly Credit Card on a merchant. - [MassPay](https://developer.authvia.com/reference/tokenize-creditcard-masspay.md): How to enable MassPay Credit Card on a merchant. - [Masspay CreditCard](https://developer.authvia.com/reference/tokenize-creditcard-masspaycreditcard.md): How to enable Masspay CreditCard Credit Card on a merchant. - [Mock](https://developer.authvia.com/reference/tokenize-creditcard-mock.md): How to enable Mock Credit Card on a merchant. - [Orbital](https://developer.authvia.com/reference/tokenize-creditcard-orbital.md): How to enable Orbital Credit Card on a merchant. - [PNC](https://developer.authvia.com/reference/tokenize-creditcard-pnc.md): How to enable PNC Credit Card on a merchant. - [Stripe](https://developer.authvia.com/reference/tokenize-creditcard-stripe.md): How to enable Stripe Credit Card on a merchant. - [Stripe- Authorize Only](https://developer.authvia.com/reference/tokenize-creditcard-stripe-authorizeonly.md): How to enable Stripe- Authorize Only Credit Card on a merchant. - [Stripe- MultiUse Token](https://developer.authvia.com/reference/tokenize-creditcard-stripe-multiuse.md): How to enable Stripe- MultiUse Token Credit Card on a merchant. - [Tilled](https://developer.authvia.com/reference/tokenize-creditcard-tilled.md): How to enable Tilled Credit Card on a merchant. - [FIS WorldPay Vantiv Express](https://developer.authvia.com/reference/tokenize-creditcard-vantiv-creditcard.md): How to enable FIS WorldPay Vantiv Express Credit Card on a merchant. - [FIS WorldPay Vantiv Express PassToken](https://developer.authvia.com/reference/tokenize-creditcard-vantiv-passtoken.md): How to enable FIS WorldPay Vantiv Express PassToken Credit Card on a merchant. - [Elavon](https://developer.authvia.com/reference/tokenize-creditcard-elavon-epg.md): How to enable Elavon Credit Card on a merchant. - [Vantiv PassToken](https://developer.authvia.com/reference/tokenize-creditcard-vantiv-passtoken-cert.md): How to enable Vantiv PassToken Credit Card on a merchant. - [FIS WorldPay Vantiv Express](https://developer.authvia.com/reference/tokenize-creditcard-vantiv-creditcard-cert.md): How to enable FIS WorldPay Vantiv Express Credit Card on a merchant. - [Token](https://developer.authvia.com/reference/tokenize-token.md): Catalog of all the providers we support for token tokenize. - [Mock](https://developer.authvia.com/reference/tokenize-token-mock.md): How to enable Mock Token on a merchant. - [Provider Products](https://developer.authvia.com/reference/provider-product-catalog.md): A list of our products organized by provider so you can see all the features supported by each. - [Customers](https://developer.authvia.com/reference/crm.md): Catalog of all the providers we support for customers. - [CRM](https://developer.authvia.com/reference/customers-crm.md): Catalog of all the providers we support for crm customers. - [BrainTree](https://developer.authvia.com/reference/customers-crm-braintree.md): How to enable BrainTree CRM on a merchant. - [Capacity](https://developer.authvia.com/reference/customers-crm-capacity.md): How to enable Capacity CRM on a merchant. - [FluidPay](https://developer.authvia.com/reference/customers-crm-fluidpay.md): How to enable FluidPay CRM on a merchant. - [Mock](https://developer.authvia.com/reference/customers-crm-mock.md): How to enable Mock CRM on a merchant. - [Stripe- Authorize Only](https://developer.authvia.com/reference/customers-crm-stripe-authorizeonly.md): How to enable Stripe- Authorize Only CRM on a merchant. - [Stripe- Multiuse Token](https://developer.authvia.com/reference/customers-crm-stripe-multiuse.md): How to enable Stripe- Multiuse Token CRM on a merchant. - [Tilled](https://developer.authvia.com/reference/customers-crm-tilled.md): How to enable Tilled CRM on a merchant. - [Elavon EPG](https://developer.authvia.com/reference/customers-crm-elavon-epg.md): How to enable Elavon EPG CRM on a merchant. ## Changelog - [Incode sandbox and production routing in blueprints](https://developer.authvia.com/changelog/incode-sandbox-production-routing-blueprints.md) - [Payment method status for Worldpay host response codes](https://developer.authvia.com/changelog/payment-method-status-for-worldpay-host-response-codes.md) - [Orbital American Express card brand](https://developer.authvia.com/changelog/orbital-american-express-card-brand.md) - [Payment method updates for duplicate saved cards](https://developer.authvia.com/changelog/payment-method-updates-for-duplicate-saved-cards.md) - [Orbital transaction authorization codes](https://developer.authvia.com/changelog/orbital-transaction-authorization-codes.md) - [FIS WorldPay Vantiv Express refund and void status on provider errors](https://developer.authvia.com/changelog/fis-worldpay-vantiv-express-refund-and-void-status-on-provider-errors.md) - [Heartland Healthcare token payment authorization amounts](https://developer.authvia.com/changelog/heartland-healthcare-token-payment-authorization-amounts.md) - [Mastercard bank net date on saved cards and authorizations](https://developer.authvia.com/changelog/mastercard-bank-net-date-on-saved-cards-and-authorizations.md) - [Fiserv CommerceHub authorize status for subsequent transactions](https://developer.authvia.com/changelog/fiserv-commercehub-authorize-status-for-subsequent-transactions.md) - [Subscription webhooks for retired transactions](https://developer.authvia.com/changelog/subscription-webhooks-for-retired-transactions.md)