Do Payment Request Parameter

📘

Data Attribute Reference

Data Type
A - Alphabet, N - Numeric, AN - AlphaNumeric, C - Characters, D - Decimal, B - Boolean

Mandatory
M - Mandatory, C - Conditional, O - Optional

Parameter

Data Type

Mandatory

Description

paymentToken

C 255

M

Payment token ID

clientID C 255 O

Unique client ID

This ID will be created when UI SDK init and store in app preference.

Formula :
Get UUID

locale C 10 O

Api response localization.

Based on ISO 639

 

Important:
if locale is empty, api will response based on payment token locale.

if locale is exist, api will response with requested locale.

if clientID exist, api will response with user preference locale

Refer to Initialization API for the language code list.

responseReturnUrl C 255 O

Payment response return URL

Only to be used by 3rd party vendor to build payment UI for a Merchant.

For merchant, please use 'frontendReturnUrl' in PaymentToken Request

note: Payment token will be appended at the end of the URL

example:
responseReturnUrl='http://www.website.com/result/'
call back url will be: 'http://www.website.com/result/paymentTokenABCDE'

payment - M Payment required information
  code - M

Payment code information

ref: Payment Channel Matrix table.

    channelCode AN 10 M Payment channel code
    agentCode C 10 C Agent's code
    agentChannelCode C 10 C Agent's channel code
  data - M Payment data
    name C 50 C Customer’s name
    email C 150 C Customer’s email
    mobileNo C 255 O Customer’s mobile number
    accountNo C 255 O Customer’s account number 
    securePayToken C 255 C

SecurePay encrypted token.

A token generated by SecurePay SDK.

Web : Using JS
ref: Encryption of card data

Mobile : Encrypted by SecurePay SDK Lib.

    cardBank C 255 O Credit card issuer bank
    cardCountry C 255 O Credit card issuer country
    cardTokenize BL O Allowing customer to tokenize card info.
    interestType A 1 O Installment interest type
    installmentPeriod N 2 O Installment period in month
    token C 255 O Token from card token id or digital payment
    qrType C 255 O

QR data type.

RAW : Raw data string

BASE64 : Base64 image string

URL : QR image URL

    fxRateID C 255 O Exchange rate id
    paymentExpiry C 19 O

Payment expiry date

Specify payment expiry date/time for payments. Format: yyyy-MM-dd HH:mm:ss

By default, will use expiry date/time from payment token or configured on merchant profile.

    billingAddress1 C 255 C Address line 1
    billingAddress2 C 255 O Address line 2
    billingAddress3 C 255 O Address line 3
    billingCity C 255 C Address city
    billingState C 255 O Address state
    billingPostalCode AN 10 C Address postal code
    billingCountryCode A 2 C Address country in A2 of ISO3166 format
    shippingAddress1 C 255 C Address line 1
    shippingAddress2 C 255 O Address line 2
    shippingAddress3 C 255 O Address line 3
    shippingCity C 255 C Address city
    shippingState C 255 O Address state
    shippingPostalCode AN 10 C Address postal code
    shippingCountryCode A 2 C Address country in A2 of ISO3166 format