Create Payment Session
Request a windowed time of payment session
Method and URL
POST [BASE_URL]/v2/payments
Request
Payment UI
Card Payment Method
E-Wallet Payment Method
Virtual Account Payment Method
QR Payment Method
Detail Parameter Request
clientReferenceId
Alphanumeric
1-100
M
Unique Payment Reference from Merchant's Request
paymentType
String
-
O
Default to SINGLE
Payment Type possible values are:
SINGLE
MULTIPLE
Definition:
SINGLE: Payment Session can only be charged onceMULTIPLE: Payment Session can be charged multiple times, and Payment Session Status is alwaysActive
Applicable only for Payment Method Type QR and VIRTUAL_ACCOUNT
saveForFutureUse
Boolean
-
O
Store Payment Information detail in Token format in Customer Object for CARD & EWALLET Payment method whenever the charge is SUCCESS
Default to false Possible values are:
true
false
showSavedPayment
Boolean
-
O
Show saved Payment Information for CARD & EWALLET Payment method in Payment Redirection
Default to false, applicable only for REDIRECT mode
Possible values are:
true
false
mode
String
-
O
Default to REDIRECT
Payment Session mode. Possible values are:
REDIRECT will return redirectUrl
API
customerId
String
0-255
O
Auto generated based on email as the unique identifier *Choose either to send customerId or customer Object
customer
Object
-
C
Customer Object Customer information *Choose either to send customerId or customer Object
autoConfirm
Boolean
-
O
Default to true
If the confirmation method is set to false. Then clients need to hit the /confirm endpoint
statementDescriptor
String
0-20
O
Default = Merchant’s short name
Statement descriptors allow a maximum 20 characters for all the concatenated characters (including space).
It will be shown on invoice, receipt, and for payment methods that support custom descriptors, it will be shown on the customer's bank statement.
expirationMode
String
-
O
Default to LOOSE
Payment Type possible values are:
LOOSE
STRICT
Definition:
LOOSE: Expiry depends on processor rulesSTRICT: Expiry depends on merchant rules
Applicable only for Payment Method Type CARD and EWALLET
expiryAt
String
-
O
Session expired time set by merchant with format YYYY-MM-DDTHH:MM:SSZ. The default expiration time is 15 mins.
For Payment Type = MULTIPLE, don't necessarily send the Expiry At value
metadata
Object
-
O
Free object for merchant to store any extra information about the payment session
Response
Payment UI
Card Payment Method
E-Wallet Payment Method
Virtual Account Payment Method
QR Payment Method
Detail Parameter Response
Last updated