Skip to content

Latest commit

 

History

History
225 lines (165 loc) · 6.88 KB

BusinessLinesApi.md

File metadata and controls

225 lines (165 loc) · 6.88 KB

BusinessLinesApi

All URIs are relative to https://kyc-test.adyen.com/lem/v3

Method HTTP request Description
deleteBusinessLinesId DELETE /businessLines/{id} Delete a business line
getBusinessLinesId GET /businessLines/{id} Get a business line
patchBusinessLinesId PATCH /businessLines/{id} Update a business line
postBusinessLines POST /businessLines Create a business line

deleteBusinessLinesId

deleteBusinessLinesId(id)

Delete a business line

Deletes a business line. >If you delete a business line linked to a payment method, it can affect your merchant account's ability to use the payment method. The business line is removed from all linked merchant accounts.

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.legalentitymanagement.*

val apiInstance = BusinessLinesApi()
val id : kotlin.String = id_example // kotlin.String | The unique identifier of the business line to be deleted.
try {
    apiInstance.deleteBusinessLinesId(id)
} catch (e: ClientException) {
    println("4xx response calling BusinessLinesApi#deleteBusinessLinesId")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BusinessLinesApi#deleteBusinessLinesId")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The unique identifier of the business line to be deleted.

Return type

null (empty response body)

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getBusinessLinesId

BusinessLine getBusinessLinesId(id)

Get a business line

Returns the detail of a business line.

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.legalentitymanagement.*

val apiInstance = BusinessLinesApi()
val id : kotlin.String = id_example // kotlin.String | The unique identifier of the business line.
try {
    val result : BusinessLine = apiInstance.getBusinessLinesId(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BusinessLinesApi#getBusinessLinesId")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BusinessLinesApi#getBusinessLinesId")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The unique identifier of the business line.

Return type

BusinessLine

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

patchBusinessLinesId

BusinessLine patchBusinessLinesId(id, businessLineInfoUpdate)

Update a business line

Updates a business line.

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.legalentitymanagement.*

val apiInstance = BusinessLinesApi()
val id : kotlin.String = id_example // kotlin.String | The unique identifier of the business line.
val businessLineInfoUpdate : BusinessLineInfoUpdate =  // BusinessLineInfoUpdate | 
try {
    val result : BusinessLine = apiInstance.patchBusinessLinesId(id, businessLineInfoUpdate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BusinessLinesApi#patchBusinessLinesId")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BusinessLinesApi#patchBusinessLinesId")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The unique identifier of the business line.
businessLineInfoUpdate BusinessLineInfoUpdate [optional]

Return type

BusinessLine

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

postBusinessLines

BusinessLine postBusinessLines(businessLineInfo)

Create a business line

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. >If you are using hosted onboarding, only use v2 for your API requests.

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.legalentitymanagement.*

val apiInstance = BusinessLinesApi()
val businessLineInfo : BusinessLineInfo =  // BusinessLineInfo | 
try {
    val result : BusinessLine = apiInstance.postBusinessLines(businessLineInfo)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BusinessLinesApi#postBusinessLines")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BusinessLinesApi#postBusinessLines")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
businessLineInfo BusinessLineInfo [optional]

Return type

BusinessLine

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json