session | Ingenico Connect JavaScript SDK

Hierarchy

session

Constructors

constructor

new session(sessionDetails: SessionDetails, paymentProduct?: PaymentProductJSON | PaymentProductGroupJSON): session

Parameters
- sessionDetails: SessionDetails
- Optional paymentProduct: PaymentProductJSON | PaymentProductGroupJSON
Returns session

Properties

Readonly assetUrl

assetUrl: string

Readonly clientApiUrl

clientApiUrl: string

Readonly convertAmount

convertAmount: (amount: number, source: string, target: string) => Promise<ConvertAmountJSON>

Type declaration

- (amount: number, source: string, target: string): Promise<ConvertAmountJSON>
- Parameters
  - amount: number
  - source: string
  - target: string
  Returns Promise<ConvertAmountJSON>

Readonly createApplePayPayment

createApplePayPayment: (context: PaymentDetails, paymentProductSpecificInput: ApplePaySpecificInput, networks: string[]) => Promise<ApplePayInitResult>

Type declaration

- (context: PaymentDetails, paymentProductSpecificInput: ApplePaySpecificInput, networks: string[]): Promise<ApplePayInitResult>
- Parameters
  - context: PaymentDetails
  - paymentProductSpecificInput: ApplePaySpecificInput
  - networks: string[]
  Returns Promise<ApplePayInitResult>

Readonly createPaymentProductSession

createPaymentProductSession: (paymentProductId: number, paymentDetails: PaymentProductSessionContext) => Promise<CreatePaymentProductSessionResponseJSON>

Type declaration

- (paymentProductId: number, paymentDetails: PaymentProductSessionContext): Promise<CreatePaymentProductSessionResponseJSON>
- Parameters
  - paymentProductId: number
  - paymentDetails: PaymentProductSessionContext
  Returns Promise<CreatePaymentProductSessionResponseJSON>

Readonly getBasicPaymentItems

getBasicPaymentItems: (paymentDetails: PaymentDetails, useGroups: boolean, paymentProductSpecificInputs?: PaymentProductSpecificInputs) => Promise<BasicPaymentItems>

Type declaration

- (paymentDetails: PaymentDetails, useGroups: boolean, paymentProductSpecificInputs?: PaymentProductSpecificInputs): Promise<BasicPaymentItems>
- Parameters
  - paymentDetails: PaymentDetails
  - useGroups: boolean
  - Optional paymentProductSpecificInputs: PaymentProductSpecificInputs
  Returns Promise<BasicPaymentItems>

Readonly getBasicPaymentProductGroups

getBasicPaymentProductGroups: (paymentDetails: PaymentDetails) => Promise<BasicPaymentProductGroups>

Type declaration

- (paymentDetails: PaymentDetails): Promise<BasicPaymentProductGroups>
- Parameters
  - paymentDetails: PaymentDetails
  Returns Promise<BasicPaymentProductGroups>

Readonly getBasicPaymentProducts

getBasicPaymentProducts: (paymentDetails: PaymentDetails, paymentProductSpecificInputs?: PaymentProductSpecificInputs) => Promise<BasicPaymentProducts>

Type declaration

- (paymentDetails: PaymentDetails, paymentProductSpecificInputs?: PaymentProductSpecificInputs): Promise<BasicPaymentProducts>
- Parameters
  - paymentDetails: PaymentDetails
  - Optional paymentProductSpecificInputs: PaymentProductSpecificInputs
  Returns Promise<BasicPaymentProducts>

Readonly getCustomerDetails

getCustomerDetails: (paymentProductId: number, paymentDetails: GetCustomerDetailsRequestJSON) => Promise<GetCustomerDetailsResponseJSON>

Type declaration

- (paymentProductId: number, paymentDetails: GetCustomerDetailsRequestJSON): Promise<GetCustomerDetailsResponseJSON>
- Parameters
  - paymentProductId: number
  - paymentDetails: GetCustomerDetailsRequestJSON
  Returns Promise<GetCustomerDetailsResponseJSON>

Readonly getEncryptor

getEncryptor: () => Encryptor

Type declaration

- (): Encryptor
- Returns Encryptor

Readonly getIinDetails

getIinDetails: (partialCreditCardNumber: string, paymentDetails?: PaymentDetails | null) => Promise<IinDetailsResponse>

Type declaration

- (partialCreditCardNumber: string, paymentDetails?: PaymentDetails | null): Promise<IinDetailsResponse>
- Parameters
  - partialCreditCardNumber: string
  - Optional paymentDetails: PaymentDetails | null
  Returns Promise<IinDetailsResponse>

Readonly getPaymentProduct

getPaymentProduct: (paymentProductId: number, paymentDetails?: PaymentDetails, paymentProductSpecificInputs?: PaymentProductSpecificInputs) => Promise<PaymentProduct>

Type declaration

- (paymentProductId: number, paymentDetails?: PaymentDetails, paymentProductSpecificInputs?: PaymentProductSpecificInputs): Promise<PaymentProduct>
- Parameters
  - paymentProductId: number
  - Optional paymentDetails: PaymentDetails
  - Optional paymentProductSpecificInputs: PaymentProductSpecificInputs
  Returns Promise<PaymentProduct>

Readonly getPaymentProductDirectory

getPaymentProductDirectory: (paymentProductId: number, currencyCode: string, countryCode: string) => Promise<DirectoryJSON>

Type declaration

- (paymentProductId: number, currencyCode: string, countryCode: string): Promise<DirectoryJSON>
- Parameters
  - paymentProductId: number
  - currencyCode: string
  - countryCode: string
  Returns Promise<DirectoryJSON>

Readonly getPaymentProductGroup

getPaymentProductGroup: (paymentProductGroupId: string, paymentDetails?: PaymentDetails) => Promise<PaymentProductGroup>

Type declaration

- (paymentProductGroupId: string, paymentDetails?: PaymentDetails): Promise<PaymentProductGroup>
- Parameters
  - paymentProductGroupId: string
  - Optional paymentDetails: PaymentDetails
  Returns Promise<PaymentProductGroup>

Readonly getPaymentProductNetworks

getPaymentProductNetworks: (paymentProductId: number, paymentDetails: PaymentDetails) => Promise<PaymentProductNetworksResponseJSON>

Type declaration

- (paymentProductId: number, paymentDetails: PaymentDetails): Promise<PaymentProductNetworksResponseJSON>
- Parameters
  - paymentProductId: number
  - paymentDetails: PaymentDetails
  Returns Promise<PaymentProductNetworksResponseJSON>

Readonly getPaymentRequest

getPaymentRequest: () => PaymentRequest

Readonly getThirdPartyPaymentStatus

getThirdPartyPaymentStatus: (paymentId: string) => Promise<ThirdPartyStatusResponseJSON>

Type declaration

- (paymentId: string): Promise<ThirdPartyStatusResponseJSON>
- Parameters
  - paymentId: string
  Returns Promise<ThirdPartyStatusResponseJSON>

Readonly transformPaymentProductGroupJSON

transformPaymentProductGroupJSON: (json: PaymentProductGroupJSON) => PaymentProductGroup

Type declaration

- (json: PaymentProductGroupJSON): PaymentProductGroup
- Parameters
  - json: PaymentProductGroupJSON
  Returns PaymentProductGroup

Readonly transformPaymentProductJSON

transformPaymentProductJSON: (json: PaymentProductJSON) => PaymentProduct

Type declaration

- (json: PaymentProductJSON): PaymentProduct
- Parameters
  - json: PaymentProductJSON
  Returns PaymentProduct

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

sessionDetails: SessionDetails

Optional paymentProduct: PaymentProductJSON | PaymentProductGroupJSON

Returns session

Properties

Readonly assetUrl

Readonly clientApiUrl

Readonly convertAmount

Type declaration

Parameters

amount: number

source: string

target: string

Returns Promise<ConvertAmountJSON>

Readonly createApplePayPayment

Type declaration

Parameters

context: PaymentDetails

paymentProductSpecificInput: ApplePaySpecificInput

networks: string[]

Returns Promise<ApplePayInitResult>

Readonly createPaymentProductSession

Type declaration

Parameters

paymentProductId: number

paymentDetails: PaymentProductSessionContext

Returns Promise<CreatePaymentProductSessionResponseJSON>

Readonly getBasicPaymentItems

Type declaration

Parameters

paymentDetails: PaymentDetails

useGroups: boolean

Optional paymentProductSpecificInputs: PaymentProductSpecificInputs

Returns Promise<BasicPaymentItems>

Readonly getBasicPaymentProductGroups

Type declaration

Parameters

paymentDetails: PaymentDetails

Returns Promise<BasicPaymentProductGroups>

Readonly getBasicPaymentProducts

Type declaration

Parameters

paymentDetails: PaymentDetails

Optional paymentProductSpecificInputs: PaymentProductSpecificInputs

Returns Promise<BasicPaymentProducts>

Readonly getCustomerDetails

Type declaration

Parameters

paymentProductId: number

paymentDetails: GetCustomerDetailsRequestJSON

Returns Promise<GetCustomerDetailsResponseJSON>

Readonly getEncryptor

Type declaration

Returns Encryptor

Readonly getIinDetails

Type declaration

Parameters

partialCreditCardNumber: string

Optional paymentDetails: PaymentDetails | null

Returns Promise<IinDetailsResponse>

Readonly getPaymentProduct

Type declaration

Parameters

paymentProductId: number

Optional paymentDetails: PaymentDetails

Optional paymentProductSpecificInputs: PaymentProductSpecificInputs

Returns Promise<PaymentProduct>

Readonly getPaymentProductDirectory

Type declaration

Parameters

paymentProductId: number

currencyCode: string

countryCode: string

Returns Promise<DirectoryJSON>