/**
* Lemonway DirectKit API 2.0
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: v2
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type { AccountBalanceOutput, AccountBlockedInput, AccountBlockedOutput, AccountDetailsBatchInput, AccountDetailsBatchOutput, AccountDetailsOutput, AccountDocumentsOutput, AccountKycStatusOutput, AddUltimateBeneficialOwnerInput, AddUltimateBeneficialOwnerOutput, BalanceHistoryOutput, EnrolmentInitInput, EnrolmentInitOutput, GetUltimateBeneficialOwnerOutput, KycStatusOutput, RegisterIndividualAccountInput, RegisterIndividualAccountOutput, RegisterLegalAccountInput, RegisterLegalAccountOutput, SignDocumentInitInput, SignDocumentInitOutput, UpdateAccountStatusInput, UpdateAccountStatusOutput, UpdateIndividualAccountDetailsInput, UpdateIndividualAccountDetailsOutput, UpdateLegalAccountDetailsInput, UpdateLegalAccountDetailsOutput, UpdateUltimateBeneficialOwnerInput, UpdateUltimateBeneficialOwnerOutput, UploadDocumentInput, UploadDocumentOutput } from '../models';
export interface AccountsAccountSingleGetRequest {
accountid: string;
authorization: string;
pSUIPAddress: string;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsAddUltimateBeneficialOwnerRequest {
accountId: string;
authorization: string;
pSUIPAddress: string;
parameters: AddUltimateBeneficialOwnerInput;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsBalancesGetRequest {
authorization: string;
pSUIPAddress: string;
updateDate?: string;
internalAccountIdStart?: number;
internalAccountIdEnd?: number;
page?: number;
limit?: number;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsBalancesHistoryGetRequest {
accountId: string;
authorization: string;
pSUIPAddress: string;
atDate?: string;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsBlockedPutRequest {
accountid: string;
authorization: string;
pSUIPAddress: string;
parameters: AccountBlockedInput;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsDocumentGetRequest {
accountid: string;
authorization: string;
pSUIPAddress: string;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsDocumentsSignInitPostRequest {
accountid: string;
documentid: number;
authorization: string;
pSUIPAddress: string;
parameters: SignDocumentInitInput;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsDocumentsUploadPostRequest {
accountid: string;
authorization: string;
pSUIPAddress: string;
parameters: UploadDocumentInput;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsEnrolmentInitRequest {
accountid: string;
authorization: string;
pSUIPAddress: string;
parameters: EnrolmentInitInput;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsGetUltimateBeneficialOwnerRequest {
accountId: string;
authorization: string;
pSUIPAddress: string;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsIndividualPostRequest {
authorization: string;
pSUIPAddress: string;
parameters: RegisterIndividualAccountInput;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsIndividualPutRequest {
accountid: string;
authorization: string;
pSUIPAddress: string;
parameters: UpdateIndividualAccountDetailsInput;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsKycStatusGetRequest {
updateDate: string;
authorization: string;
pSUIPAddress: string;
page?: number;
limit?: number;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsKycstatusPutRequest {
accountid: string;
authorization: string;
pSUIPAddress: string;
parameters: UpdateAccountStatusInput;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsLegalPostRequest {
authorization: string;
pSUIPAddress: string;
parameters: RegisterLegalAccountInput;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsLegalSinglePutRequest {
accountid: string;
authorization: string;
pSUIPAddress: string;
parameters: UpdateLegalAccountDetailsInput;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsRetrievePostRequest {
authorization: string;
pSUIPAddress: string;
parameters: AccountDetailsBatchInput;
page?: number;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsTransactionsGetRequest {
accountId: string;
authorization: string;
pSUIPAddress: string;
startDate?: string;
endDate?: string;
executionDateStart?: string;
executionDateEnd?: string;
page?: number;
limit?: number;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
export interface AccountsUpdateUltimateBeneficialOwnerRequest {
accountId: string;
ultimateBeneficialOwnerId: number;
authorization: string;
pSUIPAddress: string;
parameters: UpdateUltimateBeneficialOwnerInput;
pSUAcceptLanguage?: string;
pSUUserAgent?: string;
}
/**
*
*/
export declare class AccountsApi extends runtime.BaseAPI {
/**
* This method enables your system to get detailed payment account information including: payment account balance, account type, if the account is blocked, and account email address.
Fill at least one search field
* Get Detailed Payment Account Data
*/
accountsAccountSingleGetRaw(requestParameters: AccountsAccountSingleGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* This method enables your system to get detailed payment account information including: payment account balance, account type, if the account is blocked, and account email address.
Fill at least one search field
* Get Detailed Payment Account Data
*/
accountsAccountSingleGet(requestParameters: AccountsAccountSingleGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* The method enables you to link an Ultimate Beneficial Owner to a legal payment account. To be validated all Legal accounts need to provide their Ultimate Beneficial Owner information. ``` An Ultimate Beneficial Owner is a natural person that owns directly or indirectly (i.e. through another entity) more than 25% of the shares/stock or voting rights of the legal entity, or a person having significant control over it through other means. Any company established in EEA or EU is obliged to obtain and maintain this information with the competent central register (as per article 30 of Directive 2015/843/EU). Similar requirements may also exist in other countries. In order to comply with AML-CTF legal provisions, payment institutions are required to identify the beneficial owner(s) of a legal entity(i.e.a company or an organisation). ``` If the Legal Representative is also an Ultimate Beneficial Owner, you can specify this information when creating or updating a legal account.
* Create an Ultimate Beneficial Owner
*/
accountsAddUltimateBeneficialOwnerRaw(requestParameters: AccountsAddUltimateBeneficialOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* The method enables you to link an Ultimate Beneficial Owner to a legal payment account. To be validated all Legal accounts need to provide their Ultimate Beneficial Owner information. ``` An Ultimate Beneficial Owner is a natural person that owns directly or indirectly (i.e. through another entity) more than 25% of the shares/stock or voting rights of the legal entity, or a person having significant control over it through other means. Any company established in EEA or EU is obliged to obtain and maintain this information with the competent central register (as per article 30 of Directive 2015/843/EU). Similar requirements may also exist in other countries. In order to comply with AML-CTF legal provisions, payment institutions are required to identify the beneficial owner(s) of a legal entity(i.e.a company or an organisation). ``` If the Legal Representative is also an Ultimate Beneficial Owner, you can specify this information when creating or updating a legal account.
* Create an Ultimate Beneficial Owner
*/
accountsAddUltimateBeneficialOwner(requestParameters: AccountsAddUltimateBeneficialOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* Use the GetBalances method to get all payment accounts where the balance has changed since the input date, or all the balances of payment accounts with internal ID between payment accountIdStart and payment accountIdEnd.
* Get all Payment Account Balances
*/
accountsBalancesGetRaw(requestParameters: AccountsBalancesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* Use the GetBalances method to get all payment accounts where the balance has changed since the input date, or all the balances of payment accounts with internal ID between payment accountIdStart and payment accountIdEnd.
* Get all Payment Account Balances
*/
accountsBalancesGet(requestParameters: AccountsBalancesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* Get Payment Account Balance History
*/
accountsBalancesHistoryGetRaw(requestParameters: AccountsBalancesHistoryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* Get Payment Account Balance History
*/
accountsBalancesHistoryGet(requestParameters: AccountsBalancesHistoryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* Block or Unblock an Account
*/
accountsBlockedPutRaw(requestParameters: AccountsBlockedPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* Block or Unblock an Account
*/
accountsBlockedPut(requestParameters: AccountsBlockedPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* Get Documents Associated with a Payment Account
*/
accountsDocumentGetRaw(requestParameters: AccountsDocumentGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* Get Documents Associated with a Payment Account
*/
accountsDocumentGet(requestParameters: AccountsDocumentGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* This functionality allows you to generate an electronic signature. For now, only SDD mandates can be signed with this method.
Requirement: - A Mandate needs to be registered with RegisterSddMandate
Three steps to follow for this method: - A call to SignDocumentInit of DirectKit to make the signature request and get a token
- A redirection from your website to the WebKit, with the token in GET parameter (see Finalize document signature)
- A return page where your user will be redirected after the signature
* Generate an Electronic Signature of a Document
*/
accountsDocumentsSignInitPostRaw(requestParameters: AccountsDocumentsSignInitPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* This functionality allows you to generate an electronic signature. For now, only SDD mandates can be signed with this method.
Requirement: - A Mandate needs to be registered with RegisterSddMandate
Three steps to follow for this method: - A call to SignDocumentInit of DirectKit to make the signature request and get a token
- A redirection from your website to the WebKit, with the token in GET parameter (see Finalize document signature)
- A return page where your user will be redirected after the signature
* Generate an Electronic Signature of a Document
*/
accountsDocumentsSignInitPost(requestParameters: AccountsDocumentsSignInitPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* Upload documents to a payment account. The maximum file size for manual validation is 1.25 MB for manual validation. For instant validation the maximum file size is 0.5 MB.
For security reasons, only the following documents types are accepted: PDF, JPG, JPEG and PNG
Refrain from using TIFF
Note: If a previously uploaded document has been rejected, it is possible to upload the same document again to the same document type slot
* Upload Documents for KYC (Know Your Customers)
*/
accountsDocumentsUploadPostRaw(requestParameters: AccountsDocumentsUploadPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* Upload documents to a payment account. The maximum file size for manual validation is 1.25 MB for manual validation. For instant validation the maximum file size is 0.5 MB.
For security reasons, only the following documents types are accepted: PDF, JPG, JPEG and PNG
Refrain from using TIFF
Note: If a previously uploaded document has been rejected, it is possible to upload the same document again to the same document type slot
* Upload Documents for KYC (Know Your Customers)
*/
accountsDocumentsUploadPost(requestParameters: AccountsDocumentsUploadPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* Initialize a Deutsche Post POSTIDENT Identification
*/
accountsEnrolmentInitRaw(requestParameters: AccountsEnrolmentInitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* Initialize a Deutsche Post POSTIDENT Identification
*/
accountsEnrolmentInit(requestParameters: AccountsEnrolmentInitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* This method enables you get all the Ultimate Beneficial Owners associated to a legal payment account.
* Get all Ultimate Beneficial Owners associated to a payment account.
*/
accountsGetUltimateBeneficialOwnerRaw(requestParameters: AccountsGetUltimateBeneficialOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* This method enables you get all the Ultimate Beneficial Owners associated to a legal payment account.
* Get all Ultimate Beneficial Owners associated to a payment account.
*/
accountsGetUltimateBeneficialOwner(requestParameters: AccountsGetUltimateBeneficialOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* This method allows you to create a individual payment account
1. Your users enter their data on your website, for example on their profile space on your website
2. Your server calls our Accounts API
3. Lemonway creates the payment account in your environment
4. Your system reads the method response and informs the user
* Create a New Individual Account
*/
accountsIndividualPostRaw(requestParameters: AccountsIndividualPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* This method allows you to create a individual payment account
1. Your users enter their data on your website, for example on their profile space on your website
2. Your server calls our Accounts API
3. Lemonway creates the payment account in your environment
4. Your system reads the method response and informs the user
* Create a New Individual Account
*/
accountsIndividualPost(requestParameters: AccountsIndividualPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* This method enables you to update information related to a client payment account. 1. The user enters their new data 2. The user calls the Lemonway webservice 3. Lemonway records data when it exists 4. The application processes Lemonway\'s response and displays a confirmation message
* Update Individual Payment Account Data
*/
accountsIndividualPutRaw(requestParameters: AccountsIndividualPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* This method enables you to update information related to a client payment account. 1. The user enters their new data 2. The user calls the Lemonway webservice 3. Lemonway records data when it exists 4. The application processes Lemonway\'s response and displays a confirmation message
* Update Individual Payment Account Data
*/
accountsIndividualPut(requestParameters: AccountsIndividualPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* Use this method to find users, documents, IBAN for which the status has changed since a specified date.
Note:
This method will return the same user multiple times in the same request if his status has changed multiple time since a specified date.
* Find a user, document or an IBAN that has been modified since an entry date
*/
accountsKycStatusGetRaw(requestParameters: AccountsKycStatusGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* Use this method to find users, documents, IBAN for which the status has changed since a specified date.
Note:
This method will return the same user multiple times in the same request if his status has changed multiple time since a specified date.
* Find a user, document or an IBAN that has been modified since an entry date
*/
accountsKycStatusGet(requestParameters: AccountsKycStatusGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* The method allows a payment account status to be updated or closed
Note:
The availability of this functionality depends on your contract.
* Update Payment Account Status
*/
accountsKycstatusPutRaw(requestParameters: AccountsKycstatusPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* The method allows a payment account status to be updated or closed
Note:
The availability of this functionality depends on your contract.
* Update Payment Account Status
*/
accountsKycstatusPut(requestParameters: AccountsKycstatusPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* This method allows you to create a legal payment account
1. Your users enter their data on your website, for example on their profile space on your website
2. Your server calls our Accounts API
3. Lemonway creates the payment account in your environment
4. Your system reads the method response and informs the user
* Create a New Legal Account
*/
accountsLegalPostRaw(requestParameters: AccountsLegalPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* This method allows you to create a legal payment account
1. Your users enter their data on your website, for example on their profile space on your website
2. Your server calls our Accounts API
3. Lemonway creates the payment account in your environment
4. Your system reads the method response and informs the user
* Create a New Legal Account
*/
accountsLegalPost(requestParameters: AccountsLegalPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* This method enables you to update information relating to a legal CLIENT payment account. 1. The user enters their new data 2. The user calls the Lemonway webservice 3. Lemonway records data when it exists 4. The application processes Lemonway\'s response and displays a confirmation message
* Update Legal Payment Account Data
*/
accountsLegalSinglePutRaw(requestParameters: AccountsLegalSinglePutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* This method enables you to update information relating to a legal CLIENT payment account. 1. The user enters their new data 2. The user calls the Lemonway webservice 3. Lemonway records data when it exists 4. The application processes Lemonway\'s response and displays a confirmation message
* Update Legal Payment Account Data
*/
accountsLegalSinglePut(requestParameters: AccountsLegalSinglePutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* This method enables your system to get detailed payment account information including: payment account balance, account type, if the account is blocked, and account email address.
Fill at least one search field.
* Get Detailed Payments Accounts Data
*/
accountsRetrievePostRaw(requestParameters: AccountsRetrievePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* This method enables your system to get detailed payment account information including: payment account balance, account type, if the account is blocked, and account email address.
Fill at least one search field.
* Get Detailed Payments Accounts Data
*/
accountsRetrievePost(requestParameters: AccountsRetrievePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* Use the GetWalletTransHistory to retrieve the list of Money-In, Money-Out and P2P (payment between payment account) of a given payment account. The following numbered list corresponds to the payment type specified in the response attribute Method: 0 Card 1 Bank transfert (MoneyIn) 3 Bank transfert (MoneyOut) 4 P2P 13 IDEAL 14 DirectDebit 15 CHEQUE 16 Neosurf 17 SoFort 18 PFS Physical Card 19 Multibanco 20 Payshop 21 MB WAY 22 Polish Instant Transfer 23 PAGARE 24 MobilePay 25 PayTrail 26 WeChat (via PayTend) 27 P24 28 MoneyIn by TPE 29 Trustly
* Get list of all Payment Account Transactions
*/
accountsTransactionsGetRaw(requestParameters: AccountsTransactionsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* Use the GetWalletTransHistory to retrieve the list of Money-In, Money-Out and P2P (payment between payment account) of a given payment account. The following numbered list corresponds to the payment type specified in the response attribute Method: 0 Card 1 Bank transfert (MoneyIn) 3 Bank transfert (MoneyOut) 4 P2P 13 IDEAL 14 DirectDebit 15 CHEQUE 16 Neosurf 17 SoFort 18 PFS Physical Card 19 Multibanco 20 Payshop 21 MB WAY 22 Polish Instant Transfer 23 PAGARE 24 MobilePay 25 PayTrail 26 WeChat (via PayTend) 27 P24 28 MoneyIn by TPE 29 Trustly
* Get list of all Payment Account Transactions
*/
accountsTransactionsGet(requestParameters: AccountsTransactionsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
/**
* This method enables you to update information related to an Ultimate Beneficial Owner.
* Update Ultimate Beneficial Owner data
*/
accountsUpdateUltimateBeneficialOwnerRaw(requestParameters: AccountsUpdateUltimateBeneficialOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>;
/**
* This method enables you to update information related to an Ultimate Beneficial Owner.
* Update Ultimate Beneficial Owner data
*/
accountsUpdateUltimateBeneficialOwner(requestParameters: AccountsUpdateUltimateBeneficialOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise;
}