Skip to main content
POST

Prerequisites

Store eWallet Account

Configure credentials for Apple Pay, Google Pay, PayPal, etc.

PSP Setup

Configure your Payment Gateway Account for processing.

Stored Cards

For returning customers, the request can include storedCards: up to 3 previously tokenized cards, each with its token and display details (brand, lastDigits, expirationMonth, expirationYear, nameOnCard). The card entry page then shows a “Pay by {brand} ****{last 4}” button per card, and the payer only enters the CVV; the charge runs against the real card resolved from the token.
Stored cards are not allowed with the TOKENIZE operation. Each token must belong to your account, and expired cards are rejected. The display details are shown to the payer exactly as provided - persist them from the tokenAndMaskedCardModel.bankCard returned at tokenization time, as they cannot be retrieved later. A stored-card payment in a CHARGE_AND_TOKENIZE or PREAUTH_AND_TOKENIZE session is not tokenized again. See CardPay: Stored Cards for the full guide.

Payments Library Setup Guide

Complete guide with session configuration and payment button setup

Authorizations

X-Api-Key
string
header
required

Please enter ApiKey into field

Body

application/json

Start Session Request

operation
enum<string>
Available options:
CHARGE,
TOKENIZE,
CHARGE_AND_TOKENIZE,
PREAUTH_AND_TOKENIZE
paymentGatewayAccountId
string | null
paymentGatewayCertName
string | null
allowedeWalletAccountIds
string[] | null
customerName
string | null
customerPhone
string | null
customerEmail
string | null
storedCards
object[] | null
mode
enum<string>
Available options:
TEST,
LIVE
currencyCode
enum<string>
Available options:
AFN,
EUR,
ALL,
DZD,
USD,
AOA,
XCD,
ARS,
AMD,
AWG,
AUD,
AZN,
BSD,
BHD,
BDT,
BBD,
BYR,
BZD,
XOF,
BMD,
BTN,
INR,
BOB,
BOV,
BAM,
BWP,
NOK,
BRL,
BND,
BGN,
BIF,
KHR,
XAF,
CAD,
CVE,
KYD,
CLF,
CLP,
CNY,
COP,
COU,
KMF,
CDF,
NZD,
CRC,
HRK,
CUC,
CUP,
ANG,
CZK,
DKK,
DJF,
DOP,
EGP,
SVC,
ERN,
ETB,
FKP,
FJD,
XPF,
GMD,
GEL,
GHS,
GIP,
GTQ,
GBP,
GNF,
GYD,
HTG,
HNL,
HKD,
HUF,
ISK,
IDR,
XDR,
IRR,
IQD,
ILS,
JMD,
JPY,
JOD,
KZT,
KES,
KPW,
KRW,
KWD,
KGS,
LAK,
LBP,
LSL,
ZAR,
LRD,
LYD,
CHF,
LTL,
MOP,
MKD,
MGA,
MWK,
MYR,
MVR,
MRO,
MUR,
XUA,
MXN,
MXV,
MDL,
MNT,
MAD,
MZN,
MMK,
NAD,
NPR,
NIO,
NGN,
OMR,
PKR,
PAB,
PGK,
PYG,
PEN,
PHP,
PLN,
QAR,
RON,
RUB,
RWF,
SHP,
WST,
STD,
SAR,
RSD,
SCR,
SLL,
SGD,
XSU,
SBD,
SOS,
SSP,
LKR,
SDG,
SRD,
SZL,
SEK,
CHE,
CHW,
SYP,
TWD,
TJS,
TZS,
THB,
TOP,
TTD,
TND,
TRY,
TMT,
UGX,
UAH,
AED,
USN,
UYI,
UYU,
UZS,
VUV,
VEF,
VND,
YER,
ZMW,
ZWL,
XBA,
XBB,
XBC,
XBD,
XTS,
XXX,
XAU,
XPD,
XPT,
XAG
countryCode
string | null
amount
number<double>
paymentNote
string | null
allowedBrands
enum<string>[] | null
Available options:
Unspecified,
AMEX,
BC,
CartaSi,
Dankort,
Delta,
DinersClub,
Discover,
Electron,
Elo,
enRoute,
Hipercard,
JCB,
Maestro,
MasterCard,
MC_Alaska,
MC_Canada,
Switch,
Troy,
UATP,
UnionPay,
Visa
threeDsBrands
enum<string>[] | null
Available options:
Unspecified,
AMEX,
BC,
CartaSi,
Dankort,
Delta,
DinersClub,
Discover,
Electron,
Elo,
enRoute,
Hipercard,
JCB,
Maestro,
MasterCard,
MC_Alaska,
MC_Canada,
Switch,
Troy,
UATP,
UnionPay,
Visa
fallbackUpgs
object[] | null
publicKey
string | null

Response

OK

token
string | null