README.md

@xcoobee/payment-sdk

@xcoobee/payment-sdk

Index

Enumerations

• FlexPaymentActions

Classes

• NodeXcooBeePaymentSDK
• XcooBeePaymentSDK

Interfaces

• QrGeneratorInterface

Type aliases

• DefaultPayUrlConfigType
• FlexItemHumanizedType
• FlexItemType
• FlexLogicType
• ListPayUrlConfigType
• ListWithCostPayUrlConfigType
• ListWithCostType
• LogicReferenceOptionType
• LogicReferenceType
• PaymentSdkConfigType
• QrType
• SimpleListType

Variables

• defaultQrSize
• maxAmount
• maxDataPackageSize
• maxDeviceIdLength
• maxRefSize
• maxSourceLength
• minAmount
• optionsLimit
• urlMaxLength

Object literals

• qrGenerator

Type aliases

DefaultPayUrlConfigType

Ƭ DefaultPayUrlConfigType: object

Defined in types.ts:52

Type declaration:

• amount? : number

• reference? : string

• tax? : number

---

FlexItemHumanizedType

Ƭ FlexItemHumanizedType: DefaultPayUrlConfigType & object

Defined in types.ts:41

---

FlexItemType

Ƭ FlexItemType: object

Defined in types.ts:34

Type declaration:

• 0-3? : number

• 0-5? : number

• 0-6? : string

• l? : FlexLogicType | FlexLogicType[]

---

FlexLogicType

Ƭ FlexLogicType: object

Defined in types.ts:26

Type declaration:

• M? : number

• a: FlexPaymentActions

• m? : number

• o? : number

• r? : LogicReferenceType

---

ListPayUrlConfigType

Ƭ ListPayUrlConfigType: DefaultPayUrlConfigType & object

Defined in types.ts:58

---

ListWithCostPayUrlConfigType

Ƭ ListWithCostPayUrlConfigType: DefaultPayUrlConfigType & object

Defined in types.ts:60

---

ListWithCostType

Ƭ ListWithCostType: [string, number][]

Defined in types.ts:46

---

LogicReferenceOptionType

Ƭ LogicReferenceOptionType: string | [string, number]

Defined in types.ts:22

---

LogicReferenceType

Ƭ LogicReferenceType: string | SimpleListType | ListWithCostType

Defined in types.ts:24

---

PaymentSdkConfigType

Ƭ PaymentSdkConfigType: object

Defined in types.ts:14

Type declaration:

• campaignId: string

• deviceId? : string

• formId? : string

• source? : string

• xcoobeeDeviceId? : string

---

QrType

Ƭ QrType: string | Promise‹string›

Defined in types.ts:64

---

SimpleListType

Ƭ SimpleListType: string[]

Defined in types.ts:45

Variables

Const defaultQrSize

• defaultQrSize: 450 = 450

Defined in config.ts:24

---

Const maxAmount

• maxAmount: 9999.99 = 9999.99

Defined in config.ts:17

---

Const maxDataPackageSize

• maxDataPackageSize: 1800 = 1800

Defined in config.ts:20

---

Const maxDeviceIdLength

• maxDeviceIdLength: 200 = 200

Defined in config.ts:22

---

Const maxRefSize

• maxRefSize: 40 = 40

Defined in config.ts:18

---

Const maxSourceLength

• maxSourceLength: 10 = 10

Defined in config.ts:23

---

Const minAmount

• minAmount: 0.05 = 0.05

Defined in config.ts:16

---

Const optionsLimit

• optionsLimit: 25 = 25

Defined in config.ts:19

---

Const urlMaxLength

• urlMaxLength: 2048 = 2048

Defined in config.ts:21

Object literals

Const qrGenerator

▪ qrGenerator: object

Defined in node.ts:12

Implements node version of QrGeneratorInterface to generate QRs

implements QrGeneratorInterface

generate

▸ generate(url: string, size: number): Promise‹string›

Defined in node.ts:13

Parameters:

Name	Type
url	string
size	number

Returns: Promise‹string›