# README

Go API client for platformsaccount

The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.

For more information, refer to our documentation.

Authentication

To connect to the Account API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the Adyen Support Team. Then use its credentials to authenticate your request, for example:

curl
-U \"[email protected]\":\"YourWsPassword\" \\
-H \"Content-Type: application/json\" \\
...

Note that when going live, you need to generate new web service user credentials to access the live endpoints.

Versioning

The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

https://cal-test.adyen.com/cal/services/Account/v5/createAccountHolder

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 5
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen For more information, please visit https://support.adyen.com/

# Structs

Account struct for Account.
AccountEvent struct for AccountEvent.
AccountHolderDetails struct for AccountHolderDetails.
AccountHolderStatus struct for AccountHolderStatus.
AccountPayoutState struct for AccountPayoutState.
AccountProcessingState struct for AccountProcessingState.
Amount struct for Amount.
BankAccountDetail struct for BankAccountDetail.
BusinessDetails struct for BusinessDetails.
CloseAccountHolderRequest struct for CloseAccountHolderRequest.
CloseAccountHolderResponse struct for CloseAccountHolderResponse.
CloseAccountRequest struct for CloseAccountRequest.
CloseAccountResponse struct for CloseAccountResponse.
CreateAccountHolderRequest struct for CreateAccountHolderRequest.
CreateAccountHolderResponse struct for CreateAccountHolderResponse.
CreateAccountRequest struct for CreateAccountRequest.
CreateAccountResponse struct for CreateAccountResponse.
DeleteBankAccountRequest struct for DeleteBankAccountRequest.
DeletePayoutMethodRequest struct for DeletePayoutMethodRequest.
DeleteShareholderRequest struct for DeleteShareholderRequest.
DocumentDetail struct for DocumentDetail.
ErrorFieldType struct for ErrorFieldType.
FieldType struct for FieldType.
GenericResponse struct for GenericResponse.
GetAccountHolderRequest struct for GetAccountHolderRequest.
GetAccountHolderResponse struct for GetAccountHolderResponse.
GetAccountHolderStatusResponse struct for GetAccountHolderStatusResponse.
GetUploadedDocumentsRequest struct for GetUploadedDocumentsRequest.
GetUploadedDocumentsResponse struct for GetUploadedDocumentsResponse.
IndividualDetails struct for IndividualDetails.
KYCBankAccountCheckResult struct for KYCBankAccountCheckResult.
KYCCardCheckResult struct for KYCCardCheckResult.
KYCCheckResult struct for KYCCheckResult.
KYCCheckStatusData struct for KYCCheckStatusData.
KYCCheckSummary struct for KYCCheckSummary.
KYCShareholderCheckResult struct for KYCShareholderCheckResult.
KYCVerificationResult struct for KYCVerificationResult.
PayoutMethod struct for PayoutMethod.
PayoutScheduleResponse struct for PayoutScheduleResponse.
PerformVerificationRequest struct for PerformVerificationRequest.
PersonalDocumentData struct for PersonalDocumentData.
ShareholderContact struct for ShareholderContact.
SuspendAccountHolderRequest struct for SuspendAccountHolderRequest.
SuspendAccountHolderResponse struct for SuspendAccountHolderResponse.
UnSuspendAccountHolderRequest struct for UnSuspendAccountHolderRequest.
UnSuspendAccountHolderResponse struct for UnSuspendAccountHolderResponse.
UpdateAccountHolderRequest struct for UpdateAccountHolderRequest.
UpdateAccountHolderResponse struct for UpdateAccountHolderResponse.
UpdateAccountHolderStateRequest struct for UpdateAccountHolderStateRequest.
UpdateAccountRequest struct for UpdateAccountRequest.
UpdateAccountResponse struct for UpdateAccountResponse.
UpdatePayoutScheduleRequest struct for UpdatePayoutScheduleRequest.
UploadDocumentRequest struct for UploadDocumentRequest.
ViasAddress struct for ViasAddress.
ViasName struct for ViasName.
ViasPersonalData struct for ViasPersonalData.
ViasPhoneNumber struct for ViasPhoneNumber.

# Type aliases

PlatformsAccount PlatformsAccount service.