Class OnboardingApi

OnboardingApi - object-oriented interface

Export

Hierarchy

BaseAPI
- OnboardingApi

Index

Constructors

constructor

new OnboardingApi(configuration?, basePath?, axios?): OnboardingApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns OnboardingApi
Inherited from BaseAPI.constructor
- Defined in base.ts:56

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

getEsignatureSigner

getEsignatureSigner(requestParameters, options?): Promise<AxiosResponse<EsignatureSigner, any>>
Retrieves an Esignature Signer.

Summary
Get Esignature Signer

Throws

Memberof
OnboardingApi
Parameters
- requestParameters: OnboardingApiGetEsignatureSignerRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<EsignatureSigner, any>>
- Defined in api/onboarding-api.ts:981

getMccDescriptions

getMccDescriptions(requestParameters, options?): Promise<AxiosResponse<MccDescription[], any>>
Retrieves descriptions for all valid merchant category codes (MCC).

Summary
Get MCC Descriptions

Throws

Memberof
OnboardingApi
Parameters
- requestParameters: OnboardingApiGetMccDescriptionsRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<MccDescription[], any>>
- Defined in api/onboarding-api.ts:993

getMerchantApplication

getMerchantApplication(requestParameters, options?): Promise<AxiosResponse<MerchantApplication, any>>
Retrieves the details of an existing merchant application. The application can only be accessed if its status is created or started. Once the application is submitted or active, it is no longer accessible.

Summary
Get a Merchant Application

Deprecated

Throws

Memberof
OnboardingApi
Parameters
- requestParameters: OnboardingApiGetMerchantApplicationRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<MerchantApplication, any>>
- Defined in api/onboarding-api.ts:1006

getOnboardingApplication

getOnboardingApplication(requestParameters, options?): Promise<AxiosResponse<OnboardingApplication, any>>
Retrieves an onboarding application.

Summary
Get an Onboarding Application

Throws

Memberof
OnboardingApi
Parameters
- requestParameters: OnboardingApiGetOnboardingApplicationRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<OnboardingApplication, any>>
- Defined in api/onboarding-api.ts:1018

regenerateSigningLinks

regenerateSigningLinks(requestParameters, options?): Promise<AxiosResponse<SigningLink[], any>>
Returns an array of Signing Links if the merchant signature has not been acquired yet.

Summary
Regenerate Signing Links

Throws

Memberof
OnboardingApi
Parameters
- requestParameters: OnboardingApiRegenerateSigningLinksRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<SigningLink[], any>>
- Defined in api/onboarding-api.ts:1030

resendEsignatureDocumentEmail

resendEsignatureDocumentEmail(requestParameters, options?): Promise<AxiosResponse<void, any>>
Resend an Esignature Document email to a specific Esignature Signer.

Summary
Resend Esignature Document email

Throws

Memberof
OnboardingApi
Parameters
- requestParameters: OnboardingApiResendEsignatureDocumentEmailRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
- Defined in api/onboarding-api.ts:1042

submitMerchantApplication

submitMerchantApplication(requestParameters, options?): Promise<AxiosResponse<object, any>>
Submits a merchant application for processing. If there are any validation errors, they must be corrected before re-submitting. Once successfully submitted, the application is no longer accessible.

Summary
Submit a Merchant Application

Deprecated

Throws

Memberof
OnboardingApi
Parameters
- requestParameters: OnboardingApiSubmitMerchantApplicationRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<object, any>>
- Defined in api/onboarding-api.ts:1055

submitOnboardingApplication

submitOnboardingApplication(requestParameters, options?): Promise<AxiosResponse<SubmitApplicationResponse, any>>
Submits an onboarding application to be processed. If any validation errors exist, they must be corrected before re-submitting. Returns an array of Signing Links if a merchant signature is required.

Summary
Submit an Onboarding Application

Throws

Memberof
OnboardingApi
Parameters
- requestParameters: OnboardingApiSubmitOnboardingApplicationRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<SubmitApplicationResponse, any>>
- Defined in api/onboarding-api.ts:1067

updateMerchantApplication

updateMerchantApplication(requestParameters, options?): Promise<AxiosResponse<MerchantApplication, any>>
Updates a merchant application by overwriting all properties.

Summary
Update a Merchant Application

Deprecated

Throws

Memberof
OnboardingApi
Parameters
- requestParameters: OnboardingApiUpdateMerchantApplicationRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<MerchantApplication, any>>
- Defined in api/onboarding-api.ts:1080

updateOnboardingApplication

updateOnboardingApplication(requestParameters, options?): Promise<AxiosResponse<OnboardingApplication, any>>
Updates an onboarding application by overwriting all properties. You must pass the entire payload each time.

Summary
Update an Onboarding Application

Throws

Memberof
OnboardingApi
Parameters
- requestParameters: OnboardingApiUpdateOnboardingApplicationRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<OnboardingApplication, any>>
- Defined in api/onboarding-api.ts:1092

Class OnboardingApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns OnboardingApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

getEsignatureSigner

Summary

Throws

Memberof

Parameters

requestParameters: OnboardingApiGetEsignatureSignerRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<EsignatureSigner, any>>

getMccDescriptions

Summary

Throws

Memberof

Parameters

requestParameters: OnboardingApiGetMccDescriptionsRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<MccDescription[], any>>

getMerchantApplication

Summary

Deprecated

Throws

Memberof

Parameters

requestParameters: OnboardingApiGetMerchantApplicationRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<MerchantApplication, any>>

getOnboardingApplication

Summary

Throws

Memberof

Parameters

requestParameters: OnboardingApiGetOnboardingApplicationRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<OnboardingApplication, any>>

regenerateSigningLinks

Summary

Throws

Memberof

Parameters

requestParameters: OnboardingApiRegenerateSigningLinksRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<SigningLink[], any>>

resendEsignatureDocumentEmail

Summary

Throws

Memberof

Parameters

requestParameters: OnboardingApiResendEsignatureDocumentEmailRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

submitMerchantApplication

Summary

Deprecated

Throws

Memberof

Parameters

requestParameters: OnboardingApiSubmitMerchantApplicationRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<object, any>>

submitOnboardingApplication

Summary

Throws

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>