/prePaymentUI

Process payment with credit cards (authentication and authorization) as well as other payment methods (e.g., direct debit and APM) through the 2C2P Payment Page. Returns a JOSE response message.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
apiRequest
object
required
string
required
length ≤ 20

Office ID

string
required
length ≤ 40

Order No.

string
required
length ≤ 50

Product Description

string
enum
length ≤ 20

Code of Payment Category:

  • ECOM = E-commerce
  • VEDC = Virtual EDC
  • QUICKPAY = QuickPay
  • RPP = Recurring Payment
Allowed:
string
enum
length ≤ 20

Code of Payment Type:

  • CC = Credit Card
  • IPP = Installment
  • CC-VI = Credit Card (Visa)
  • CC-CA = Credit Card (MasterCard)
  • CC-AX = Credit Card (American Express)
  • CC-UP = Credit Card (UnionPay International)
  • CC-JC = Credit Card (JCB)
  • QR = QR Payment
  • DEEPLINK = Deeplink
  • WALLET = Wallet
  • OTC = Over the Counter
  • SSM = Self Service Machines
  • WEBPAY = Web Payment
  • IMBANK = Internet Mobile Banking
date-time
date-time
string
length ≤ 20

Code of Payment Channel. Only required for Alternative Payment Method (APM).

string
length ≤ 20

Code of Payment Agent. Only required for Alternative Payment Method (APM).

preferredPaymentTypes
array of objects

Hint to Payment Page to show only preferred payment types to customer. The first payment type in this list will be the default one.

  • preferredPaymentTypes will be processed only if paymentType is not available.
preferredPaymentTypes
currencyConversionDetails
object

Currency conversion details for UI payment API.

string

Whether to perform 3DS authentication. N=No 3DS authentication. Y=Perform 3DS authentication in relax mode. Accept successful authentication by both card holder and merchant. Y-Strict=Perform 3DS authentication in strict mode. Accept successful authentication by card holder only. Default value is N.

storedCardList
array of objects

List of storedCardUniqueID. The list supposed to be maintain by merchant who is the only party that can accociated tokenized string with their own customer profile.

storedCardList
installmentPaymentDetails
object
recurringPaymentDetails
object

Defines recurring payment scheduling parameters. This object is used only for registering a recurring queue in the system. Each recurring execution is processed as an independent one-time payment transaction.

transactionAmount
object
required

Transaction amount.

notificationURLs
object
required
number

Number of seconds to show system payment result page before continue with redirection to notificationURLs (confirmationURL or failedURL). Default is 10 seconds. When set to 0 second, it will effectively has no delay in which the system payment result page will entirely skipped.

generalPayerDetails
object
purchaseItemize
array of objects
purchaseItemize
billingAddress
object

Billing address. Data are corresponding to EMV 3-D Secure Protocol and Core Functions Specification

  • This object is required when the airlineData object is present.
airlineData
object
string
length ≤ 20

Dynamic statement description displayed on the customer’s account.

  • Restrictions: cannot contain the following special characters: < > ' " *
  • Note: Feature availability is subject to the acquiring bank
string
length ≤ 1

Identifies who initiated the transaction:

  • C = Customer (default)
  • M = Merchant
string
length ≤ 255

Required when transactionInitiator is set to 'M'.

string
length ≤ 150

For merchants to submit their specific data (No. 1).

string
length ≤ 150

For merchants to submit their specific data (No. 2).

string
length ≤ 150

For merchants to submit their specific data (No. 3).

string
length ≤ 150

For merchants to submit their specific data (No. 4).

string
length ≤ 150

For merchants to submit their specific data (No. 5).

string
length ≤ 150

For merchants to submit their specific data (No. 6).

string
length ≤ 150

For merchants to submit their specific data (No. 7).

string
length ≤ 150

For merchants to submit their specific data (No. 8).

string
length ≤ 150

For merchants to submit their specific data (No. 9).

string
length ≤ 150

For merchants to submit their specific data (No. 10).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/jose