Create Business Process

post

https://api.authvia.com/v3/accounts/{account-id}/customers/{ref}/business-processes

scope `business_processes:create`

Allows an account (merchant) to create a Business Process for their Customer with a series of Actions tailored to business requirements. These Actions may include performing a payment, capturing the payment method, approval, acknowledgement, and more.

Info

The Business Process can be constructed using any combination of Actions, with the order of Actions customizable based on specific requirements.

Actions are accompanied by a union feature, allowing relationships to be established between them.

This makes the Business Process highly adaptable to meet various business needs.

Tip: For more structure and predictability in creating business processes, consider using Blueprints. Blueprints provide predefined templates and workflows that can streamline your business process creation and ensure consistency across your applications.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account-id

string

required

The unique identifier (AVID) of the Account.

ref

string

required

The Account's (Merchant's) unique reference for the Customer.

Query Params

async

boolean

When set to true, the creation of the Business Process will be allowed to run in the background. This will result in a 201 response being returned immediately, without a response body.

synchronous

boolean

When set to true, creation the Business Process will require more time as it ensures the entire process is fully created before returning the response body.

Body Params

idSeed

string

length ≥ 1

Generates unique-deterministic id based on this value and merchant avid, if any business-process already exists with this value, it will return an error.

actions

array of objects

required

length ≥ 1

A list of business process actions. The order of these actions is critical for rendering messages or web experiences for customers. Each action must be defined according to the specifications in the Action Catalog section.

actions*

type

string

enum

Specifies the type of action to be performed. Each action type represents a distinct step or operation within the business process, such as a payment or capture payment-method step.

union

number

Defines the relationship of this action with another action in terms of union. This field is used to link related actions within the business process.

context

object

Provides additional contextual information relevant to the action. This can include any data or parameters that are necessary for executing the action within the given context. For more info or exact definition look inside Action Catalog section

features

object

Specifies additional features or attributes of the action. This field may include both required and optional settings or configurations that further detail how the action should be executed. For more info or exact definition look inside Action Catalog section.

addresses

array of objects

length ≥ 1

Represents a collection of contact addresses associated with the customer. Each address object must adhere to specific formats,email or phone number.

addresses

value

required

The address value to be validated. e.164 format if phone number, valid email otherwise.

blueprint

string

The ID of the blueprint used to create the business process. This field is present only if the business process was created using a blueprint.

schedule

1000000000000 to 9999999999999

It is used to schedule a business process at a specific time in future. The value can be provided as a duration or a point in time but must be within 365 days from the current or creation time.

expiration

1000000000000 to 9999999999999

Specifies the expiration of the business process, starting from the creation time or the scheduled time if defined. The default value is 45 days (45d). The expiration can be provided as either a duration or a specific point in time, but it must be within 365 days from the creation or scheduled time if defined.

callback

string

length between 10 and 65536

This webhook URL will be invoked when the business process is created and resolved/failed.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successfully created customer business process. Returns the newly created business process with action details.

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.