Class AuctanePayAPI

Auctane Pay API module - /v1/payments

This module provides access to the Auctane Pay endpoints in ShipEngine API.

Hierarchy

AuctanePayAPI

Index

Constructors

Properties

Methods

createSession getConfig

Constructors

constructor

new AuctanePayAPI(client: AxiosInstance): AuctanePayAPI
Parameters
- client: AxiosInstance
Returns AuctanePayAPI
- Defined in javascript/src/auctane-pay/api.ts:11

Properties

`Private` client

client: AxiosInstance

Methods

createSession

createSession(request: SE.CreateSessionRequest): Promise<AxiosResponse<SE.CreateSessionResponse, any>>
The createSession method creates a new payment session.

Returns
a promise that resolves to the created session
Parameters
- request: SE.CreateSessionRequest
  
  The request object containing the session details
Returns Promise<AxiosResponse<SE.CreateSessionResponse, any>>
- Defined in javascript/src/auctane-pay/api.ts:21

getConfig

getConfig(): Promise<AxiosResponse<SE.ConfigResponse, any>>
The getConfig method get the AuctanePay config, such as the "adyenClientKey"

Returns
a promise that returns the AuctanePay config

Returns Promise<AxiosResponse<SE.ConfigResponse, any>>
- Defined in javascript/src/auctane-pay/api.ts:30

Generated using TypeDoc