Payment Options Response Parameters
Data Attribute Reference
Data Type
- A: Alphabet
- AN: Alphanumeric
- C: Characters
- B: Boolean
- D: Decimal
- N: Numeric
Mandatory attributes
- M: Mandatory
- C: Conditional
- O: Optional
|
Parameter |
Data Type |
Mandatory |
Description |
|||||
|---|---|---|---|---|---|---|---|---|
|
paymentToken |
C 255 |
M |
Payment token ID |
|||||
|
merchantDetails |
|
M |
Merchant details |
|||||
|
|
id |
AN 25 |
M |
Merchant id |
||||
|
|
name |
A 50 |
M |
Merchant name |
||||
|
|
address |
C 255 |
O |
Merchant address |
||||
|
|
|
C 50 |
O |
Merchant email |
||||
|
|
logoUrl |
C 255 |
O |
Merchant logo URL |
||||
|
|
bannerUrl |
C 255 |
O |
Merchant promotion banner URL |
||||
|
channelCategories |
- |
M |
Merchant enabled payment channel categoies |
|||||
|
|
sequenceNo |
N 5 |
M |
Sequence no of list |
||||
|
|
name |
C 50 |
M |
Payment channel title |
||||
|
|
code |
AN 6 |
M |
Payment channel category code |
||||
|
|
iconUrl |
C 255 |
M |
Payment option icon url |
||||
|
|
default |
B |
M |
Default selected payment option |
||||
|
|
groups |
- |
M |
Merchant enabled payment channel groups |
||||
|
|
|
sequenceNo |
N 5 |
M |
Sequence no of list |
|||
|
|
|
name |
C 50 |
M |
Payment channel title |
|||
|
|
|
code |
AN 1-6 |
M |
Payment channel group code |
|||
|
|
|
iconUrl |
C 255 |
M |
Payment option icon url |
|||
|
|
|
default |
B |
M |
Default selected payment option |
|||
|
transactionDetails |
- |
M |
Transaction details |
|||||
|
|
amount |
D (12,5) |
M |
Transaction amount |
||||
|
|
currencyCode |
A 3 |
M |
Transaction currency Code Based on ISO 4217 - A3 |
||||
|
|
invoiceNo |
C 20 |
M |
Transaction invoice number |
||||
|
|
description |
C 255 |
M |
Transaction product description |
||||
|
|
recurring |
- |
C |
Recurring Detail |
||||
|
|
|
amount |
D (12,5) |
M |
Recurring amount |
|||
|
|
|
interval |
N 3 |
C |
Recurring interval in days |
|||
|
|
|
count |
N 5 |
C |
Recurring total count allowed |
|||
|
|
|
chargeNextDate |
N 8 |
O |
The next date of recurring payment for transaction |
|||
|
|
|
chargeOnDate |
N 4 |
C |
Recurring charge on specific date every month |
|||
|
configuration |
- |
M |
Merchant admin portal configuration |
|||||
|
|
payment |
- |
M |
Payment related configuration |
||||
| immediatePayment | B | C | Payment with immediate without user input | |||||
|
|
|
tokenize |
B |
C |
Tokenization for credit card payment |
|||
|
|
|
tokenizeOnly |
B |
C |
Tokenization for Credit Card as card token without perform transaction. |
|||
|
|
|
cardTokenOnly |
B |
O |
Enforce use card token only |
|||
|
|
|
fx |
- |
O |
Exchange rate |
|||
|
|
|
|
mcp |
- |
C |
Exchange rate Multiple currency pricing |
||
|
|
|
|
|
active |
B |
M |
MCP’s feature active status |
|
|
|
|
|
|
terms |
C 255 |
M |
MCP’s term and condition |
|
|
|
|
|
dcc |
- |
C |
Exchange rate Dynamic currency conversion |
||
|
|
|
|
|
active |
B |
M |
DCC’s feature active status |
|
|
|
|
|
|
terms |
C 255 |
M |
DCC’s term and condition |
|
|
|
notification |
- |
M |
Payment notification platform configuration |
||||
|
|
|
|
B |
C |
Facebook subscription view visibility based on admin portal configuration. |
|||
|
|
|
|
B |
C |
WhatsApp subscription view visibility based on admin portal configuration. |
|||
|
|
|
line |
B |
C |
Line subscription view visibility based on admin portal configuration. |
|||
|
respCode |
N 4 |
M |
Response code Refer to API Response Code List |
|||||
|
respDesc |
C 255 |
M |
Response Code Description |
|||||
Updated 5 months ago