Package com.adyen.service.management

Class ApiCredentialsCompanyLevel

java.lang.Object

com.adyen.Service

com.adyen.ApiKeyAuthenticatedService

com.adyen.service.management.ApiCredentialsCompanyLevel

public class ApiCredentialsCompanyLevel
extends ApiKeyAuthenticatedService

Field Summary

Fields inherited from class com.adyen.Service

GSON

Constructor Summary

Constructors

Constructor	Description
ApiCredentialsCompanyLevel(Client client)

Method Summary

Modifier and Type	Method	Description
CreateCompanyApiCredentialResponse	createApiCredential(String companyId, CreateCompanyApiCredentialRequest createCompanyApiCredentialRequest)	Create an API credential.
CompanyApiCredential	getApiCredential(String companyId, String apiCredentialId)	Get an API credential
ListCompanyApiCredentialsResponse	listApiCredentials(String companyId, Map<String,String> queryParams)	Get a list of API credentials
CompanyApiCredential	updateApiCredential(String companyId, String apiCredentialId, UpdateCompanyApiCredentialRequest updateCompanyApiCredentialRequest)	Update an API credential.

Methods inherited from class com.adyen.Service

getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiCredentialsCompanyLevel

public ApiCredentialsCompanyLevel(Client client)

Method Detail

listApiCredentials

public ListCompanyApiCredentialsResponse listApiCredentials(String companyId,
                                                            Map<String,String> queryParams)
                                                     throws ApiException,
                                                            IOException

Get a list of API credentials

Parameters:

companyId - The unique identifier of the company account. (required)

queryParams - (optional) pageNumber: The number of the page to fetch. (optional) pageSize: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional)

Returns:

ListCompanyApiCredentialsResponse

Throws:

ApiException - if fails to make API call

IOException

getApiCredential

public CompanyApiCredential getApiCredential(String companyId,
                                             String apiCredentialId)
                                      throws ApiException,
                                             IOException

Get an API credential

Parameters:

companyId - The unique identifier of the company account. (required)

apiCredentialId - Unique identifier of the API credential. (required)

Returns:

CompanyApiCredential

Throws:

ApiException - if fails to make API call

IOException

updateApiCredential

public CompanyApiCredential updateApiCredential(String companyId,
                                                String apiCredentialId,
                                                UpdateCompanyApiCredentialRequest updateCompanyApiCredentialRequest)
                                         throws ApiException,
                                                IOException

Update an API credential.

Parameters:

companyId - The unique identifier of the company account. (required)

apiCredentialId - Unique identifier of the API credential. (required)

updateCompanyApiCredentialRequest - (optional)

Returns:

CompanyApiCredential

Throws:

ApiException - if fails to make API call

IOException

createApiCredential

public CreateCompanyApiCredentialResponse createApiCredential(String companyId,
                                                              CreateCompanyApiCredentialRequest createCompanyApiCredentialRequest)
                                                       throws ApiException,
                                                              IOException

Create an API credential.

Parameters:

companyId - The unique identifier of the company account. (required)

createCompanyApiCredentialRequest - (optional)

Returns:

CreateCompanyApiCredentialResponse

Throws:

ApiException - if fails to make API call

IOException