- Source:
Classes
- AddPaymentMethod
- Address
- AuthorizationResponse
- BankAccountDetails
- Checkpoint
- CreditCardDetail
- General
- Launch
- Login
- Payment
- Register
- RiskForCheckPointResponse
- Transaction
- User
Members
(static, readonly) CheckPointStatus :string
usually for updating transaction
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
APPROVED |
string | checkpoint was approved by the application / application server |
DENIED |
string | checkpoint was denied / blocked by the application / application server |
CANCELLED |
string | checkpoint was canceled by the user |
- Source:
(static, readonly) CheckpointType :string
type of checkpoint
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
LAUNCH |
string | |
REGISTER |
string | |
LOGIN |
string | |
TRANSACTION |
string | |
UPDATE_DETAILS |
string | |
ADD_PAYMENT_METHOD |
string | |
GENERAL |
string |
- Source:
(static, readonly) CurrencyCode :string
ISO 4217 3 letter currency codes
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
AFN |
string | Afghan Afghani |
EUR |
string | Euro |
ALL |
string | Albanian Lek |
DZD |
string | Algerian Dinar |
USD |
string | US Dollar |
AOA |
string | |
XCD |
string | |
ARS |
string | Argentine Peso |
AMD |
string | Armenian Dram |
AWG |
string | |
AUD |
string | Australian Dollar |
AZN |
string | Azerbaijani Manat |
BSD |
string | |
BHD |
string | Bahraini Dinar |
BDT |
string | Bangladeshi Taka |
BBD |
string | |
BYN |
string | |
BZD |
string | Belize Dollar |
XOF |
string | CFA Franc BCEAO |
BMD |
string | |
INR |
string | Indian Rupee |
BTN |
string | |
BOB |
string | Bolivian Boliviano |
BOV |
string | |
BAM |
string | Bosnia-Herzegovina Convertible Mark |
BWP |
string | Botswanan Pula |
NOK |
string | Norwegian Krone |
BRL |
string | Brazilian Real |
BND |
string | Brunei Dollar |
BGN |
string | Bulgarian Lev |
BIF |
string | Burundian Franc |
CVE |
string | Cape Verdean Escudo |
KHR |
string | Cambodian Riel |
XAF |
string | CFA Franc BEAC |
CAD |
string | Canadian Dollar |
KYD |
string | |
CLP |
string | Chilean Peso |
CLF |
string | |
CNY |
string | Chinese Yuan |
COP |
string | Colombian Peso |
COU |
string | |
KMF |
string | Comorian Franc |
CDF |
string | Congolese Franc |
NZD |
string | New Zealand Dollar |
CRC |
string | Costa Rican Colón |
HRK |
string | Croatian Kuna |
CUP |
string | |
CUC |
string | |
ANG |
string | |
CZK |
string | Czech Republic Koruna |
DKK |
string | Danish Krone |
DJF |
string | Djiboutian Franc |
DOP |
string | Dominican Peso |
EGP |
string | Egyptian Pound |
SVC |
string | |
ERN |
string | Eritrean Nakfa |
ETB |
string | Ethiopian Birr |
FKP |
string | |
FJD |
string | |
XPF |
string | |
GMD |
string | |
GEL |
string | Georgian Lari |
GHS |
string | Ghanaian Cedi |
GIP |
string | |
GTQ |
string | Guatemalan Quetzal |
GBP |
string | British Pound Sterling |
GNF |
string | Guinean Franc |
GYD |
string | |
HTG |
string | |
HNL |
string | Honduran Lempira |
HKD |
string | Hong Kong Dollar |
HUF |
string | Hungarian Forint |
ISK |
string | Icelandic Króna |
IDR |
string | Indonesian Rupiah |
XDR |
string | |
IRR |
string | Iranian Rial |
IQD |
string | Iraqi Dinar |
ILS |
string | Israeli New Sheqel |
JMD |
string | Jamaican Dollar |
JPY |
string | Japanese Yen |
JOD |
string | Jordanian Dinar |
KZT |
string | Kazakhstani Tenge |
KES |
string | Kenyan Shilling |
KPW |
string | |
KRW |
string | South Korean Won |
KWD |
string | Kuwaiti Dinar |
KGS |
string | |
LAK |
string | |
LBP |
string | Lebanese Pound |
LSL |
string | |
ZAR |
string | South African Rand |
LRD |
string | |
LYD |
string | Libyan Dinar |
CHF |
string | Swiss Franc |
MOP |
string | Macanese Pataca |
MKD |
string | Macedonian Denar |
MGA |
string | Malagasy Ariary |
MWK |
string | |
MYR |
string | Malaysian Ringgit |
MVR |
string | |
MRU |
string | |
MUR |
string | Mauritian Rupee |
XUA |
string | |
MXN |
string | Mexican Peso |
MXV |
string | |
MDL |
string | Moldovan Leu |
MNT |
string | |
MAD |
string | Moroccan Dirham |
MZN |
string | Mozambican Metical |
MMK |
string | Myanma Kyat |
NAD |
string | Namibian Dollar |
NPR |
string | Nepalese Rupee |
NIO |
string | Nicaraguan Córdoba |
NGN |
string | Nigerian Naira |
OMR |
string | Omani Rial |
PKR |
string | Pakistani Rupee |
PAB |
string | Panamanian Balboa |
PGK |
string | |
PYG |
string | Paraguayan Guarani |
PEN |
string | Peruvian Nuevo Sol |
PHP |
string | Philippine Peso |
PLN |
string | Polish Zloty |
QAR |
string | Qatari Rial |
RON |
string | Romanian Leu |
RUB |
string | Russian Ruble |
RWF |
string | Rwandan Franc |
SHP |
string | |
WST |
string | |
STN |
string | |
SAR |
string | Saudi Riyal |
RSD |
string | Serbian Dinar |
SCR |
string | |
SLL |
string | |
SGD |
string | Singapore Dollar |
XSU |
string | |
SBD |
string | |
SOS |
string | Somali Shilling |
SSP |
string | |
LKR |
string | Sri Lankan Rupee |
SDG |
string | Sudanese Pound |
SRD |
string | |
SZL |
string | |
SEK |
string | Swedish Krona |
CHE |
string | |
CHW |
string | |
SYP |
string | Syrian Pound |
TWD |
string | New Taiwan Dollar |
TJS |
string | |
TZS |
string | Tanzanian Shilling |
THB |
string | Thai Baht |
TOP |
string | Tongan Paʻanga |
TTD |
string | Trinidad and Tobago Dollar |
TND |
string | Tunisian Dinar |
TRY |
string | Turkish Lira |
TMT |
string | |
UGX |
string | Ugandan Shilling |
UAH |
string | Ukrainian Hryvnia |
AED |
string | United Arab Emirates Dirham |
USN |
string | |
UYU |
string | Uruguayan Peso |
UYI |
string | |
UYW |
string | |
UZS |
string | Uzbekistan Som |
VUV |
string | |
VES |
string | |
VND |
string | Vietnamese Dong |
YER |
string | Yemeni Rial |
ZMW |
string | |
ZWL |
string | |
XBA |
string | |
XBB |
string | |
XBC |
string | |
XBD |
string | |
XTS |
string | |
XXX |
string | |
XAU |
string | |
XPD |
string | |
XPT |
string | |
XAG |
string |
- Source:
(static, readonly) PaymentMethodType :string
Type of payment method
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
CREDIT_CARD |
string | |
BANK_ACCOUNT |
string | |
ECHECK |
string | |
UNKNOWN |
string |
- Source:
(static, readonly) ScreenListenerType :string
Type of screen for ScreenListener
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
REGISTRATION_FORM |
string | |
LOGIN_FORM |
string | |
MAIN_SCREEN |
string | |
CATALOG_SCREEN |
string | |
SEARCH_SCREEN |
string | |
PRODUCT_SCREEN |
string | |
GENERAL_FORM |
string | |
PINCODE |
string | |
TRANSACTION_DETAILS |
string | |
CONTACTS |
string | |
PAYMENT_SCREEN |
string | |
EMULATOR_CHECK |
string | |
GENERAL |
string | |
ADD_PAYMENT_SCREEN |
string | |
WITHDRAW_SCREEN |
string |
- Source:
(static, readonly) TransactionType :string
type of transaction
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
PURCHASE |
string | payment for goods |
MONEY_TRANSFER |
string | money transfer to another payee |
DEPOSIT |
string | money deposit to store |
WITHDRAW |
string | money withdraw from store |
- Source:
(static, readonly) VerificationType :string
Type of verification
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
VERIFIED |
string | |
NOT_VERIFIED |
string | |
UNKNOWN |
string |
- Source:
Methods
(static) arriveToCheckPoint(checkPoint) → {Promise.<Any>}
Sends info to Paygilant server that user has arrived to check point
Parameters:
| Name | Type | Description |
|---|---|---|
checkPoint |
Paygilant.Checkpoint |
- Source:
Returns:
- Type
- Promise.<Any>
(static) getRiskForCheckpoint(checkPoint) → {Promise.<RiskForCheckPointResponse>}
Gets risk for checkpoint
Parameters:
| Name | Type | Description |
|---|---|---|
checkPoint |
Paygilant.Checkpoint |
- Source:
Returns:
risk score
- Type
- Promise.<RiskForCheckPointResponse>
(static) init(serverUrl, userIdopt) → {Promise.<Any>}
Initializes Paygilant service. This function must be invoked before any other Paygilant function
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
serverUrl |
string | url address of Paygilant server | |
userId |
string |
<optional> |
userId or username (can be omitted if unknown) |
- Source:
Returns:
- Type
- Promise.<Any>
(static) onRequestPermissionsResult(permissionName, permissionResult) → {Promise.<Any>}
Sends the result of asking user for permission
Parameters:
| Name | Type | Description |
|---|---|---|
permissionName |
string | |
permissionResult |
boolean | true if user allowed permission, false otherwise |
- Source:
Returns:
- Type
- Promise.<Any>
(static) pauseListenToSensors() → {Promise.<Any>}
Sends information that app is paused (standby, user switched to other app).
Unless init() is invoked with skipPauseResumeHandling = true, this gets called automatically with Cordova's onpause event.
- Source:
Returns:
- Type
- Promise.<Any>
(static) resumeListen() → {Promise.<Any>}
Sends information that app is resumed (wake, user switched from other app).
Unless init() is invoked with skipPauseResumeHandling = true, this gets called automatically with Cordova's onresume event.
- Source:
Returns:
- Type
- Promise.<Any>
(static) setUserId(user_id) → {Promise.<Any>}
Sets user's id/username after it is known
Parameters:
| Name | Type | Description |
|---|---|---|
user_id |
string |
- Source:
Returns:
- Type
- Promise.<Any>
(static) startScreenListener(screenListenerType) → {Promise.<Any>}
Start screen listener
Parameters:
| Name | Type | Description |
|---|---|---|
screenListenerType |
Paygilant.ScreenListenerType | type of screen listener |
- Source:
Returns:
- Type
- Promise.<Any>
(static) updateCheckPointStatus(checkPointType, requestId, checkPointStatus, transactionIdopt) → {Promise.<Any>}
Updates checkpoint
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
checkPointType |
Paygilant.CheckpointType | type of checkpoint | |
requestId |
string | request id | |
checkPointStatus |
Paygilant.CheckPointStatus | status of checkpoint | |
transactionId |
string |
<optional> |
transaction id |
- Source:
Returns:
- Type
- Promise.<Any>