POST /businessLines

Creates a business line.

This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
industryCode String Yes

A code that represents the industry of the legal entity for marketplaces or platforms. For example, 4431A for computer software stores.

capability String No

The capability for which you are creating the business line.

Possible values: receivePayments, receiveFromPlatformPayments, issueBankAccount

Possible values:

  • "receivePayments"
  • "receiveFromPlatformPayments"
  • "issueBankAccount"
sourceOfFunds Object No

Contains information about the source of your user's funds. Required only for the service banking.

sourceOfFunds.description String No

Text describing the source of funds. For example, for type business, provide a description of where the business transactions come from, such as payments through bank transfer. Required when adyenProcessedFunds is false.

sourceOfFunds.adyenProcessedFunds Boolean No

Indicates whether the funds are coming from transactions processed by Adyen. If false, a description is required.

sourceOfFunds.acquiringBusinessLineId String No

The unique identifier of the business line that will be the source of funds.This must be a business line for a receivePayments or receiveFromPlatformPayments capability.

sourceOfFunds.type String No

The type of the source of funds. Possible value: business.

Possible values:

  • "business"
webData[] Array No

List of website URLs where your user's goods or services are sold. When this is required for a service but your user does not have an online presence, provide the reason in the webDataExemption object.

webData[].webAddress String No

The URL of the website or the app store URL.

webData[].webAddressId String No

The unique identifier of the web address.

service String Yes

The service for which you are creating the business line.

Possible values:

  • paymentProcessing
  • banking

Possible values:

  • "paymentProcessing"
  • "banking"
salesChannels[] Array No

A list of channels where goods or services are sold.

Possible values: pos, posMoto, eCommerce, ecomMoto, payByLink.

Required only in combination with the service paymentProcessing.

webDataExemption Object No

The reason why the web data is not provided.

webDataExemption.reason String No

The reason why the web data was not provided. Possible value: noOnlinePresence.

Possible values:

  • "notCollectedDuringOnboarding"
  • "noOnlinePresence"
legalEntityId String Yes

Unique identifier of the legal entity that owns the business line.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.