Class Satim

Hierarchy

SatimConfig
- Satim

Constructors

constructor

new Satim(
credentials: SatimCredentials,
httpClientService?: HttpClientOptions | HttpClientService,
): Satim
Parameters
- credentials: SatimCredentials
- OptionalhttpClientService: HttpClientOptions | HttpClientService
Returns Satim
Overrides SatimConfig.constructor
- Defined in src/Satim.ts:59

Properties

`Protected`httpClientService

httpClientService: HttpClientService

`Protected`testMode

testMode: boolean = false

`Protected`_language

_language: Language = "FR"

`Protected`_currency

_currency: CurrencyCode = "012"

`Protected` `Optional`_amount

_amount?: number

`Protected` `Optional`_failUrl

_failUrl?: string

`Protected` `Optional`_returnUrl

_returnUrl?: string

`Protected` `Optional`_dynamicCallbackUrl

_dynamicCallbackUrl?: string

`Protected` `Optional`_description

_description?: string

`Protected` `Optional`_orderNumber

_orderNumber?: string

`Protected` `Optional`_sessionTimeoutSecs

_sessionTimeoutSecs?: number

`Protected` `Optional`_idempotencyKey

_idempotencyKey?: string

`Protected`_userDefinedFields

_userDefinedFields: Record<string, string> = {}

`Protected`_allowPrivateUrls

_allowPrivateUrls: boolean = false

Accessors

`Protected`username

get username(): string
Returns string
Inherited from SatimConfig.username
- Defined in src/config.ts:33

`Protected`password

get password(): string
Returns string
Inherited from SatimConfig.password
- Defined in src/config.ts:35

`Protected`terminalId

get terminalId(): string
Returns string
Inherited from SatimConfig.terminalId
- Defined in src/config.ts:37

Methods

setTestMode

setTestMode(isEnabled: boolean): this
Parameters
- isEnabled: boolean
Returns this
Overrides SatimConfig.setTestMode
- Defined in src/Satim.ts:79

`Protected`clone

clone(): this
Returns this
Overrides SatimConfig.clone
- Defined in src/Satim.ts:99

register

register(): Promise<RegisterResponse>
Returns Promise<RegisterResponse>
- Defined in src/Satim.ts:107

registerPreAuth

registerPreAuth(): Promise<RegisterResponse>
Returns Promise<RegisterResponse>
- Defined in src/Satim.ts:111

confirm

confirm(orderId: string, expectedAmount: number): Promise<ConfirmResponse>
Parameters
- orderId: string
- expectedAmount: number
Returns Promise<ConfirmResponse>
- Defined in src/Satim.ts:115

status

status(orderId: string): Promise<ConfirmResponse>
Parameters
- orderId: string
Returns Promise<ConfirmResponse>
- Defined in src/Satim.ts:151

statusAll

statusAll(orderIds: string[]): Promise<ConfirmResponse[]>
Parameters
- orderIds: string[]
Returns Promise<ConfirmResponse[]>
- Defined in src/Satim.ts:166

warmup

warmup(): Promise<void>
Returns Promise<void>
- Defined in src/Satim.ts:170

refund

refund(orderId: string, amount: number): Promise<ConfirmResponse>
Parameters
- orderId: string
- amount: number
Returns Promise<ConfirmResponse>
- Defined in src/Satim.ts:185

reverseOrder

reverseOrder(orderId: string): Promise<ConfirmResponse>
Parameters
- orderId: string
Returns Promise<ConfirmResponse>
- Defined in src/Satim.ts:207

deposit

deposit(orderId: string, amount?: number): Promise<ConfirmResponse>
Parameters
- orderId: string
- Optionalamount: number
Returns Promise<ConfirmResponse>
- Defined in src/Satim.ts:223

decline

decline(orderId: string, orderNumber: string): Promise<ConfirmResponse>
Parameters
- orderId: string
- orderNumber: string
Returns Promise<ConfirmResponse>
- Defined in src/Satim.ts:246

statusExtended

statusExtended(orderId: string): Promise<ConfirmResponse>
Parameters
- orderId: string
Returns Promise<ConfirmResponse>
- Defined in src/Satim.ts:267

checkCapabilities

checkCapabilities(): Promise<SatimCapabilities>
Returns Promise<SatimCapabilities>
- Defined in src/Satim.ts:282

safeRegister

safeRegister(merchantRef: string): Promise<RegisterResponse>
Parameters
- merchantRef: string
Returns Promise<RegisterResponse>
- Defined in src/Satim.ts:352

safeRegisterPreAuth

safeRegisterPreAuth(merchantRef: string): Promise<RegisterResponse>
Parameters
- merchantRef: string
Returns Promise<RegisterResponse>
- Defined in src/Satim.ts:356

createWebhookHandler

createWebhookHandler(options: WebhookHandlerOptions): WebhookHandler
Parameters
- options: WebhookHandlerOptions
Returns WebhookHandler
- Defined in src/Satim.ts:360

`Protected`initFromCredentials

initFromCredentials(c: SatimCredentials): void
Parameters
- c: SatimCredentials
Returns void
Inherited from SatimConfig.initFromCredentials
- Defined in src/config.ts:39

amount

amount(amount: number): this
Parameters
- amount: number
Returns this
Inherited from SatimConfig.amount
- Defined in src/config.ts:82

description

description(description: string): this
Parameters
- description: string
Returns this
Inherited from SatimConfig.description
- Defined in src/config.ts:87

currency

currency(curr: "DZD" | "USD" | "EUR"): this
Parameters
- curr: "DZD" | "USD" | "EUR"
Returns this
Inherited from SatimConfig.currency
- Defined in src/config.ts:92

failUrl

failUrl(url: string): this
Parameters
- url: string
Returns this
Inherited from SatimConfig.failUrl
- Defined in src/config.ts:98

returnUrl

returnUrl(url: string): this
Parameters
- url: string
Returns this
Inherited from SatimConfig.returnUrl
- Defined in src/config.ts:103

dynamicCallbackUrl

dynamicCallbackUrl(url: string): this
Parameters
- url: string
Returns this
Inherited from SatimConfig.dynamicCallbackUrl
- Defined in src/config.ts:108

orderNumber

orderNumber(orderNumber: string | number): this
Parameters
- orderNumber: string | number
Returns this
Inherited from SatimConfig.orderNumber
- Defined in src/config.ts:113

language

language(lang: Language): this
Parameters
- lang: Language
Returns this
Inherited from SatimConfig.language
- Defined in src/config.ts:122

userDefinedField

userDefinedField(key: string, value: string): this
Parameters
- key: string
- value: string
Returns this
Inherited from SatimConfig.userDefinedField
- Defined in src/config.ts:127

userDefinedFields

userDefinedFields(fields: Record<string, string>): this
Parameters
- fields: Record<string, string>
Returns this
Inherited from SatimConfig.userDefinedFields
- Defined in src/config.ts:132

timeout

timeout(seconds: number): this
Parameters
- seconds: number
Returns this
Inherited from SatimConfig.timeout
- Defined in src/config.ts:138

allowPrivateUrls

allowPrivateUrls(enabled: boolean): this
Parameters
- enabled: boolean
Returns this
Inherited from SatimConfig.allowPrivateUrls
- Defined in src/config.ts:144

idempotencyKey

idempotencyKey(key: string): this
Parameters
- key: string
Returns this
Inherited from SatimConfig.idempotencyKey
- Defined in src/config.ts:148

toJSON

toJSON(): Record<string, unknown>
Returns Record<string, unknown>
Inherited from SatimConfig.toJSON
- Defined in src/config.ts:153

toString

toString(): string
Returns string
Inherited from SatimConfig.toString
- Defined in src/config.ts:175

[toPrimitive]

"[toPrimitive]"(): string
Returns string
Inherited from SatimConfig.[toPrimitive]
- Defined in src/config.ts:179