Skip to main content
POST
/
EWalletOperations
Start an eWallet session
curl --request POST \
  --url https://api.orchestrasolutions.com/EWalletOperations \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "operation": "CHARGE",
  "paymentGatewayAccountId": "<string>",
  "paymentGatewayCertName": "<string>",
  "allowedeWalletAccountIds": [
    "<string>"
  ],
  "customerName": "<string>",
  "customerPhone": "<string>",
  "customerEmail": "<string>",
  "storedCards": [
    {
      "token": "<string>",
      "expirationYear": 123,
      "expirationMonth": 123,
      "nameOnCard": "<string>",
      "lastDigits": "<string>",
      "brand": "Unspecified",
      "ownerId": "<string>"
    }
  ],
  "mode": "TEST",
  "currencyCode": "AFN",
  "countryCode": "<string>",
  "amount": 123,
  "paymentNote": "<string>",
  "allowedBrands": [
    "Unspecified"
  ],
  "threeDsBrands": [
    "Unspecified"
  ],
  "fallbackUpgs": [
    {
      "paymentGatewayAccountId": "<string>",
      "paymentGatewayCertName": "<string>",
      "pass3DSData": true
    }
  ],
  "publicKey": "<string>"
}
'
{
  "token": "<string>"
}

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