Update a business line

patch/businessLines/{id}

Updates a business line.

Endpoint destination URL

https://kyc-test.adyen.com/lem/v3/businessLines/{id}

Path Parameters

Required

Optional

The unique identifier of the business line.

Request Parameters

Required

Optional

The capability for which you are creating the business line. For example, receivePayments.

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

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

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.

The service for which you are creating the business line.

Possible values:

paymentProcessing
banking

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

Show children

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.

Show children

The reason why the web data is not provided.

Show children

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
Show moreShow less
capabilitystringDeprecated in version 3
Use service instead.
The capability for which you are creating the business line.

Possible values: receivePayments, receiveFromPlatformPayments, issueBankAccount
idstring
The unique identifier of the business line.
industryCodestring
A code that represents the industry of the legal entity for marketplaces or platforms. For example, 4431A for computer software stores.
legalEntityIdstring
Unique identifier of the legal entity that owns the business line.
problemsarray[object]
The verification errors related to capabilities for this supporting entity.
Show children Hide children
entityobject
Show children Hide children
documentsarray[string]
List of document IDs corresponding to the verification errors from capabilities.
idstring
ownerobject
Show children Hide children
documentsarray[string]
List of document IDs corresponding to the verification errors from capabilities.
idstring
typestring
typestring
verificationErrorsarray[object]
Show children Hide children
capabilitiesarray[string]
Contains key-value pairs that specify the actions that the legal entity can do in your platform. The key is a capability required for your integration. For example, issueCard for Issuing.The value is an object containing the settings for the capability.
codestring
The general error code.
messagestring
The general error message.
remediatingActionsarray[object]
An object containing possible solutions to fix a verification error.
Show children Hide children
codestring
messagestring
subErrorsarray[object]
An array containing more granular information about the cause of the verification error.
Show children Hide children
capabilitiesarray[string]
Contains key-value pairs that specify the actions that the legal entity can do in your platform. The key is a capability required for your integration. For example, issueCard for Issuing.The value is an object containing the settings for the capability.
codestring
The general error code.
messagestring
The general error message.
typestring
The type of error.

Possible values:

invalidInput

dataMissing

pendingStatus

rejected

dataReview

remediatingActionsarray[object]
An object containing possible solutions to fix a verification error.
Show children Hide children
codestring
messagestring
typestring
The type of error.

Possible values:

invalidInput

dataMissing

pendingStatus

rejected

dataReview

salesChannelsarray[string]
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.
servicestring
The service for which you are creating the business line.

Possible values:

paymentProcessing

banking

sourceOfFundsobject
Contains information about the source of your user's funds. Required only for the service banking.
Show children Hide children
acquiringBusinessLineIdstringDeprecated in version 3
This field will be removed in v4.
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.
adyenProcessedFundsboolean
Indicates whether the funds are coming from transactions processed by Adyen. If false, a description is required.
descriptionstring
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.
typestring
The type of the source of funds. Possible value: business.
webDataarray[object]
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.
Show children Hide children
webAddressstring
The URL of the website or the app store URL.
webAddressIdstring
The unique identifier of the web address.
webDataExemptionobject
The reason why the web data is not provided.
Show children Hide children
reasonstring
The reason why the web data was not provided. Possible value: noOnlinePresence.
400 - Bad Request
A problem reading or understanding the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Update a business line

Path Parameters

Request Parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error