Files
adyen-node-api-library/src/typings/platformsAccount/createAccountHolderResponse.ts
2021-06-21 08:54:25 +02:00

137 lines
5.2 KiB
TypeScript

/**
* Adyen for Platforms: Account API
* 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](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"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](https://docs.adyen.com/development-resources/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/v6/createAccountHolder ```
*
* The version of the OpenAPI document: 6
* Contact: developer-experience@adyen.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import {AccountHolderDetails} from './accountHolderDetails';
import {AccountHolderStatus} from './accountHolderStatus';
import {ErrorFieldType} from './errorFieldType';
import {KYCVerificationResult2} from './kYCVerificationResult2';
export class CreateAccountHolderResponse {
/**
* The code of a new account created for the account holder.
*/
'accountCode'?: string;
/**
* The code of the new account holder.
*/
'accountHolderCode': string;
'accountHolderDetails': AccountHolderDetails;
'accountHolderStatus': AccountHolderStatus;
/**
* The description of the new account holder.
*/
'description'?: string;
/**
* A list of fields that caused the `/createAccountHolder` request to fail.
*/
'invalidFields'?: Array<ErrorFieldType>;
/**
* The type of legal entity of the new account holder.
*/
'legalEntity': CreateAccountHolderResponse.LegalEntityEnum;
/**
* The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.
*/
'primaryCurrency'?: string;
/**
* The reference of a request. Can be used to uniquely identify the request.
*/
'pspReference'?: string;
/**
* The result code.
*/
'resultCode'?: string;
'verification': KYCVerificationResult2;
/**
* The identifier of the profile that applies to this entity.
*/
'verificationProfile'?: string;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "accountCode",
"baseName": "accountCode",
"type": "string"
},
{
"name": "accountHolderCode",
"baseName": "accountHolderCode",
"type": "string"
},
{
"name": "accountHolderDetails",
"baseName": "accountHolderDetails",
"type": "AccountHolderDetails"
},
{
"name": "accountHolderStatus",
"baseName": "accountHolderStatus",
"type": "AccountHolderStatus"
},
{
"name": "description",
"baseName": "description",
"type": "string"
},
{
"name": "invalidFields",
"baseName": "invalidFields",
"type": "Array<ErrorFieldType>"
},
{
"name": "legalEntity",
"baseName": "legalEntity",
"type": "CreateAccountHolderResponse.LegalEntityEnum"
},
{
"name": "primaryCurrency",
"baseName": "primaryCurrency",
"type": "string"
},
{
"name": "pspReference",
"baseName": "pspReference",
"type": "string"
},
{
"name": "resultCode",
"baseName": "resultCode",
"type": "string"
},
{
"name": "verification",
"baseName": "verification",
"type": "KYCVerificationResult2"
},
{
"name": "verificationProfile",
"baseName": "verificationProfile",
"type": "string"
} ];
static getAttributeTypeMap() {
return CreateAccountHolderResponse.attributeTypeMap;
}
}
export namespace CreateAccountHolderResponse {
export enum LegalEntityEnum {
Business = <any> 'Business',
Individual = <any> 'Individual',
NonProfit = <any> 'NonProfit',
Partnership = <any> 'Partnership',
PublicCompany = <any> 'PublicCompany'
}
}