API Reference

This reference section furnishes a thorough and precise elucidation of the Payment Platform API, delineating its functionalities and technical intricacies.

Hosts

https://staging.logibiztech.com:8777/

Security/ Authentication

All requests must be sent over SSL. All requests are authenticated against an Authorization Bearer header with an access token. All the other data parameters are sent as body parameters.

HTTP Response Body

HTTP response body is following JSON format. Please process the HTTP response properly and please expect new fields being added to the JSON structure at any time in the future. See an example of what response message could look like:

This reference section furnishes a thorough and precise elucidation of the Payment Platform API, delineating its functionalities and technical intricacies.

Copy Code

{
    "responseMessage": "PaymentSuccessful",
    "status": "SUCCESS",
    "merchantRefId": "6566666666",
    "token": "",
    "paymentId": "823203499820001",
    "txnTime": "2023-07-2201:53:02PM",
    "amount": "200.0",
    "authCode": "000000",
    "responseCode": "00",
    "rrn": "139022961549"
}

Encoding

Our system requires data to be sent in UTF-8 encoding. You can use the following Content-Type header to ensure compatibility: application/x-www-form-urlencoded; charset=UTF-8

Error Code		Error Description
LOG-1		INVALID_TRAN_PORTAL_ID
LOG-2		BRAND_NOT_FOUND
LOG-3		INVALID_TERMINAL_PASSWORD
LOG-4		INVALID_METHOD_ARGUMENT
LOG-6		INVALID_PAYMENT_ID
LOG-7		DUPLICATE_MERCHANT_REF_ID
LOG-8		INVALID_CURRENCY
LOG-10		PAYMENT_ID_DECRYPTION_ERROR
LOG-11		TERMINAL_INFO_NOT_FOUND
LOG-13		TXN_EXPIRED
LOG-14		INVALID_LANGUAGE_ID
LOG-15		INVALID_TRANSACTION_REQUEST
LOG-16		INVALID_TERMINAL_ID
LOG-100		PROCESSING_ERROR
LOG-24		INVALID_TERMINAL_BRAND
LOG-25		CHECKOUT_NOT_ALLOWED_AGAINST_TERMINAL
LOG-26		ACTION_CODE_NOT_ALLOWED_AGAINST_TERMINAL
LOG-28		PAYMENT_ALREADY_PROCESSED
LOG-29		INVALID_UDF
LOG-30		PAYMENT_EXPIRED
LOG-31		SQL_ERROR
LOG-33		NO_ACTION_CODE_FOUND
LOG-5	RULE_ENGINE_ERROR
LOG-9	AUTH_PAYMENT_FAILED
LOG-10	PAYMENT_ID_DECRYPTION_ERROR
LOG-12	CARD_ENCRYPTION_ERROR
LOG-18	INVALID_CHALLENGE_RESPOSNE
LOG-20	INVALID_CARD_NUMBER
LOG-21	RISK_FAILED
LOG-22	INVALID_CARD_EXPIRY
LOG-23	EXPIRY_ENCRYPTION_ERROR
LOG-27	NULL_RRN_IN_AUTH_RESPONSE
LOG-38	THREEDS_FAILED
LOG-39	CARD_DECRYPTION_ERROR_FROM_MVC
LOG-40	ERROR_IN_FETCHING_AUTH_DETAILS_WITH_INST
LOG-41	ERROR_IN_FETCHING_RISK_DETAILS
LOG-42	ERROR_IN_FETCHING_3DS_DETAILS
LOG-43	ERROR_IN_FETCHING_CARD_DETAILS_BY_TOKEN
LOG-300	APPLICATION_ERROR
LOG-600	INVALID_METHOD_ARGUMENT
LOG-400	BAD_CREDENTIALS_ERROR
LOG-117	DATA_INTEGRITY_ERROR
LOG-404	RRESOURCE_NOT_FOUND
LOG-401	JWT_EXPIRED
LOG-44	ERROR_IN_FETCHING_BATCH_FILE_DETAILS
LOG-45	EMPTY_SAVE_CARD_DETAILS
LOG-46	EMPTY_CARD_OR_TOKEN_DETAILS
LOG-47	CVV_REQUIRED
LOG-48	CARD_HOLDER_NAME_IS_REQUIRED
LOG-49	MOBILE_AND_EMAIL_IS_REQUIRED
LOG-50	INVALID_CVV
LOG-51	INVALID_CARD_AND_CUSTOMER_TOKEN
200	Success
401	Unauthorized
500	Internal Server Error

Testing

Credit Card Test Accounts

You can utilize these test cards for the transaction.

Brand	Number	CVV	Expiry Date
VISA	4111 1111 1111 1111 (3D Enrolled) 4242 4242 4242 4242 (No 3D)	Any 3/4 digits	Any date after today
MASTERCARD	5555 5555 5555 4444 (3D Enrolled)	Any 3/4 digits	Any date after today

Payment Basic Parameters

Parameter	Value	Description	Parameter Type	Data Type
currency	840	ISO 4217 three-digit currency code	body	Numeric
instId	Inst1	Valid Institution ID	body	Alphanumeric
merchantId	Merchant1	Valid Merchant ID	body	Alphanumeric
tranPortalId	EdfaTerminal	Valid Tranportal Id	body	String
password	P@ssw0rd@123	Valid Password of Tranportal	body	String
paymentInstrument	CARD		Body	Alphabetic
terminalId	Terminal1	A valid terminal value	body	string
tranRefType		• PAYMENT_ID • RRN • MERCHANT_REF_ID • TRANSACTION_ID	body	Alphabetic
tranRefValue		Valid value	body
amount	840.00	Valid Amount	body – R	Numeric
actionCode	5	• 1 = Purchase • 2 = Reversal • 3 = Pre Auth • 4 = Credit • 5 = Inquiry • 6 = Void Authorization • 7 = Void Capture • 8 = Void Purchase • 9 = Void Credit • 10 = Notification	body	Numeric

Authentication

Header	Description	Format	Required
Authorization Bearer <access-token>	To access, use the Authorization header with Bearer authentication.	Header	Required

Card Account

The card data structure holds all information regarding a credit or debit card account.

Parameter	Value	Description	Parameter Type	Data Type
cardHolderName	Tester	Valid Card Holder Name	body	String
cardNumber	4111111111111111	Valid Card Number	body	String
expiryMonth	10	Valid Card Expiry Month	body	String
expiryYear	2025	Valid Card Expiry Year	body	String
cvv	123	Valid Card CVV	body	number

Customer

The customer data structure includes essential information like name, ID documents, and contact details. These details serve both for storing customer information and meeting requirements for risk management and certain payment providers, as specified in parameter descriptions.

Parameter	Value	Description	Parameter Type	Data Type
cardHolderName	Tester	Valid Card Holder Name	body	string
custId		Valid Cust Id	body	string
email	[email protected]	Valid email address	body	string
javaScriptEnabled	true		body	boolean
browserJavaScriptEnabled	true		body	boolean
browserJavaEnabled	true		body	boolean
browserLanguage	en-PK		body	string
browserColorDepth	24	• 1 = 1 bit • 4 = 4 bits • 8 = 8 bits • 15 = 15 bits • 16 = 16 bits • 24 = 24 bits • 32 = 32 bits • 48 = 48 bits	body	string
browserScreenHeight	706		body	string
browserScreenWidth	1536		body	string
browserTimeZone	-300	Value is returned from the getTimezoneOffset() method. Example time zone offset values in minutes: If UTC -5 hours: • 300 • +300 If UTC +5 hours: • -300	body	string
browserAgent		Exact content of the HTTP user-agent header.	body	string
httpAccept		Browser Acceptor header	body	string

Server to Server/ Apple Pay Request & Response

Checkout API

Parameter	Value	Description	Parameter Type	Data Type
tranPortalId	t2	A valid tranportal value	body	string
merchantRefId	0000ABC	Unique Alphanumeric value	body	Alphanumeric
password	password	Terminal password	body	string
amount	1300.00	A valid non negative decimal number	body	Decimal
trackId	Bc234	Unique Alphanumeric value	body	Alphanumeric
langId	EN	3 character Language Code	body	Alphanumeric
actionCode	1	• 1 = Purchase • 2 = Reversal • 3 = Pre Auth • 4 = Credit • 5 = Inquiry • 6 = Void Authorization • 7 = Void Capture • 8 = Void Purchase • 9 = Void Credit • 10 = Notification	body	Numeric
currency	840	ISO 4217 three-digit currency code	body	Numeric
successUrl	https://www.abc.com/success	Fully Qualified URL of system that receives success response message	body	string
errorUrl	https://www.abc.com/error	Fully Qualified URL of system that receives error response message	body	string
javaScriptEnabled	true		body	boolean
browserJavaScriptEnabled	true		body	boolean
browserJavaEnabled	true		body	boolean
browserLanguage	en-PK		body	string
browserColorDepth	24	• 1 = 1 bit • 4 = 4 bits • 8 = 8 bits • 15 = 15 bits • 16 = 16 bits • 24 = 24 bits • 32 = 32 bits • 48 = 48 bits	body	string
browserScreenHeight	706		body	string
browserScreenWidth	1536		body	string
browserTimeZone	-300	Value is returned from the getTimezoneOffset() method. Example time zone offset values in minutes: If UTC -5 hours: • 300 • +300 If UTC +5 hours: • -300	body	string
browserAgent		Exact content of the HTTP user-agent header.	body	string
httpAccept		Browser Acceptor header	body	string
udf	[“”]	Custom fields	body	list
udf2	0b4d4878-c5ae-4cb7-a99a-a45d9121984d	Custom field 2 – to process transaction with saved cards	body	Element of udf-list

Payment Gateway API

Parameter	Value	Description	Parameter Type	Data Type
cardHolderName	abc	Valid cardholder name	body	Alphabetic
cardNumber	4111111111111111	Format represented ISO 7812	Null/Mentioned values	Numeric
cvv	123		Null/Value	Numeric
expiryMonth	08		Null/Value	Numeric
expiryYear	2029			Numeric
saveFlag	true	In case of tokenization	Null/Valid value	boolean
mobileNumber	009911223344	In case of tokenization	Null/Value	Numeric
email	[email protected]	In case of tokenization	Null/Value	Valid email format

Response

Parameter	Value	Description	Parameter Type	Data Type
responseMessage	Reason of error/ success		body	string
status	Code of status	• 1 = Error • 0 = Success	body	string
merchantRefId	0000ABC	A valid merchant reference Id provided in request	body	string
paymentId	823202379870001	Generated payment ID through transaction flow	body	string
txnTime	2023-07-2201:53:02	Transaction processing end time	body	string
amount	1300.00	Responded back amount that is processed	body	string
responseCode	RISK-001/00	Error/Success code	body	string
rrn	139022961549	Auth generated response value in success	body	Numeric
authCode	000000	Auth generated code	body	string
token	0b4d4878-c5ae-4cb7-a99a-a45d9121984d	Token returned in case of tokenization	body	string

Merchant Hosted Request & Response

Purchase

Request

Parameter	Value	Description	Parameter Type	Data Type	Constraints	Length
tranPortalId	EdfaTerminal	A valid tranPortalId value	body	string	Required	Min: 1 Max: 20
password	P@ssw0rd@123	Valid password against tranPortal	body	string	Required	Min: 1 Max: 50
trackId	0000123	Unique Alphanumeric value	body	Alphanumeric	Required	Min: 1 Max: 16
amount	1300.00	A valid non negative decimal number	body	Decimal	Required	Min: 1 Max: 16
actionCode	1	• 1 = Purchase	body	Numeric	Required	Min: 1 Max: 1
currency	840	ISO 4217 three-digit currency code	body	Numeric	Required	Min: 3 Max: 3
cardNumber	41111111111111111	Format represented ISO 7812	body	Numeric	Conditional (New Transaction: Required, Saved cardToken: Not required)	Min: 1 Max: 26
cvv	123		body	Numeric	Required	Min: 3 Max: 4
expiryMonth	08		body	Numeric	Conditional (New Transaction: Required, Saved cardToken: Not required)	Min: 2 Max: 2
expiryYear	2029		body	Numeric	Conditional (New Transaction: Required, Saved cardToken: Not required )	Min: 4 Max: 4
saveFlag	false	Flag to save card for next time	body	Boolean	Optional
mobileNumber	090000000000	12 digit numeric value	body	Numeric	Conditional (Required if saveFlag is true)	Min: 12 Max: 15
email	[email protected]	Valid email address	Body	string	Conditional (Required if saveFlag is true)
cardHolderName	Mark John		body	Alphabetic	Conditional (New Transaction: Required, Saved cardToken: Not required )
custToken	0b4d4878-c5ae-4cb7-a99a-a45d9121984d	Unique value for customer to get saved cards	body	string	Conditional (Required: To add new card in saved card list, Required: To process transaction with already saved card)	Max: 100
cardToken	4111**********11	Masked value of saved card	body	string	Conditional (Required: To process transaction with already saved card)	Max: 25
udf	[“”]	Array of 20 Custom fields	body	list		Max: 255
javaScriptEnabled	true		body	boolean	Required
browserJavaScriptEnabled	true		body	boolean	Required
browserJavaEnabled	true		body	boolean	Required
browserLanguage	en-PK		body	string	Required
browserColorDepth	24	• 1 = 1 bit • 4 = 4 bits • 8 = 8 bits • 15 = 15 bits • 16 = 16 bits • 24 = 24 bits • 32 = 32 bits • 48 = 48 bits	body	string	Required
browserScreenHeight	706		body	string	Required
browserScreenWidth	1536		body	string	Required
browserTimeZone	-300	Value is returned from the getTimezoneOffset() method. Example time zone offset values in minutes: If UTC -5 hours: • 300 • +300 If UTC +5 hours: • -300	body	string	Required

Response

Parameter	Value	Description	Parameter Type	Data Type
responseMessage	Reason of error/ success		Redirect Attribute	string
status	SUCCESS/FAIL		Redirect Attribute	string
merchantRefId	0000123	Reference Id for merchant	Redirect Attribute	string
paymentId	823202379870001	Generated payment ID through transaction flow	Redirect Attribute	string
txnTime	2023-07-2201:53:02	Transaction processing end time	Redirect Attribute	string
amount	1300.00	Responded back amount that is processed	Redirect Attribute	string
responseCode	RISK-001/00	Error/Success code	Redirect Attribute	string
authCode	000000	Auth generated response		string
rrn	139022961549	Auth generated response value in success	Redirect Attribute	string
currencyCode	840	3 digit currency code	Redirect Attribute	string
token	0b4d4878-c5ae-4cb7-a99a-a45d9121984d	Unique customer token provided as a result of success in saved card	Redirect Attribute	string
cardToken	4111**********11	Masked value of card that is saved	Redirect Attribute	string

Reversal Transaction

Request

Parameter	Value	Description	Parameter Type	Data Type
tranPortalId	T2	Valid Transaction Portal ID	body – R	Alphanumeric
password	Password	Corresponding valid password of Transaction Portal	body – R	string
actionCode	2	• 2 = Reversal	body – R	Numeric
Amount	840.00	ISO 4217 three-digit currency code	body – R	Numeric
tranRefType	TRANSACTION_ID	• PAYMENT_ID • RRN • MERCHANT_REF_ID • TRANSACTION_ID	body – R	Alphabetic
tranRefValue	923186715530001	Valid value against tranRefType	body- R	string

Response

Parameter	Value	Description	Parameter Type	Data Type
responseMessage	success		body	string
merchantRefId	6566666666	A valid merchant reference Id provided in request	body	string
paymentId	823203499820001	Generated payment ID through transaction flow	body	string
txnTime	2023-07-2201:53:02	Transaction processing end time	body	Time YYYY-MM-DDhh:mm:ss
amount	1300.00	Responded back amount that is processed	body	Numeric
rrn	139022961549	Auth generated response value in success	body	Numeric
originalTxnId	183035212860	Original transaction Id against reversal	body	Numeric
errorCode	LOG-300	Error code in case of error	body	string
errorDesc	Invalid Reversal Amount	Error cause	body	string

Inquiry Transaction

Request

Parameter	Value	Description	Parameter Type		Data Type
actionCode	5	• 1 = Purchase • 2 = Reversal • 3 = Pre Auth • 4 = Credit • 5 = Inquiry • 6 = Void Authorization • 7 = Void Capture • 8 = Void Purchase • 9 = Void Credit • 10 = Notification	body		Numeric
currency	840	ISO 4217 three-digit currency code	body		Numeric
instId	Inst1	Valid Institution ID	body		Alphanumeric
merchantId	Merchant1	Valid Merchant ID	body		Alphanumeric
paymentInstrument	CARD			Body	Alphabetic
terminalId	Terminal1	A valid terminal value		body	string
tranRefType		• PAYMENT_ID • RRN • MERCHANT_REF_ID • TRANSACTION_ID		body	Alphabetic
tranRefValue		Valid value		body

Response

Parameter	Value	Description	Parameter Type	Data Type
toDate	2023-07-20 00:00:11	Timestamp value of transaction end	body	string
pmtStatus	SUCCESS		body	string
merchantRefId	6566666666	A valid merchant reference Id provided in request	body	string
paymentId	823203499820001	Generated payment ID through transaction flow	body	string
txnTime	2023-07-2201:53:02	Transaction processing end time	body	Time YYYY-MM-DDhh:mm:ss
amount	1300.00	Responded back amount that is processed	body	Numeric
responseCode	RISK-001/00	Error/Success code	body	As defined in Chapter 4
rrn	139022961549	Auth generated response value in success	body	Numeric
fromDate	2023-07-20 00:00:11	Timestamp value of transaction initiated	body	string
merchantId	merchant1	Value of merchant ID	body	string
termId	Terminal1	Value of terminal ID	body	string
currencyCode	840	ISO currency code used for Transaction	body	string
instId	Inst1	ID of institution	body	string
threedsFlag	False	3ds indicator flag	body	string
tranPortalId	t2	Tran portal ID against the terminal	body	string
actionCode	PURCHASES	Transaction type indicator	body	string
expiryMonth	0*		body	string
expiryYear	2**9		body	string
cardHolderName	Name		body	string
cardNumberMask	424242******4242	Masked value of card Number	body	string
cardType	INST1VISA	Name of Payment Scheme	body	string
cardBin	31026	Bin of card Number	body	string
currencyName	SAR	Name of the applied currency	body	string
paymentInstrument	CARD		body	string
authCode	000000	Auth code	body	string
transId	923201000240001	Transaction Unique ID	body	string
responseCode	00	Auth generated response code	body	string
riskRespCode	0	Risk response code in case of no issue in risk	body	string
symbol		Symbol of currency representation	body	string
ipAddress	11.99.00	Device ip adress	body	string
batchId	1234	Batch Id value if the transaction is processed for Batch	body	string
customFields		Custom fields if filled any in request	body	string

Card Tokenization

Request

Parameter	Value	Description	Parameter Type	Data Type
tranPortalId	EdfaTerminal	Valid Tranportal Id	body	String
password	P@ssw0rd@123	Valid Password of Tranportal	body	String
actionFlag	N	L = ListN = New CustomerR = RegisterU = UpdateD = DeRegister	body	String
custId		Valid Cust Id	body	String
cardToken		Valid Card Token	body	String
cardNumber	4111111111111111	Valid Card Number	body	String
expiryMonth	10	Valid Card Expiry Month	body	String
expiryYear	2025	Valid Card Expiry Year	body	String
cardHolderName	Tester	Valid Card Holder Name	body	String
emailAddress	[email protected]	Valid Email Address	body	String
mobileNumber	030012345678	Valid Mobile Number	body	String

Response

Parameter	Value	Description	Parameter Type	Data Type
cardToken	411111******1111	Mask Card Number/ Card Token	body	String
cardHolderName	Tester	Valid Card Holder Name provided in request.	body	String
custMobNum	030012345678	Valid Customer Mobile Number provided in request	body	String
custEmail	[email protected]	Valid Customer Email provided in request	body	String
custId	c1b2ee77-0367-49e0-894d-614bd3ee7e04	Valid Customer Id	body	String

Reporting

To access these APIs, users are required to either log in to the portal or complete the onboarding process, ensuring a secure and authenticated access to the provided functionalities.

List Transaction

Count/ List API Request

Parameter	Value	Description	Parameter Type	Data Type
merchantId	Merchant1	Valid Merchant Id	body	string
terminalId	Terminal1	Valid Terminal Id	body	string
pageLength	10	Valid Page Length	body	string
pageSize	0	Valid Page Size	body	string
fromTxnDate	04-Jan-23	Valid From Date	body	string
toTxnDate	01-Feb-24	Valid To Date	body	string

List API Response

Parameter	Value	Description	Parameter Type	Data Type
id	9604	Identifier for the transaction	body	number
transId	924032344370001	Unique transaction ID	body	string
paymentId	824032344360001	Unique payment ID	body	string
instId	null	Installation ID (if applicable)	body	string
instPId	21	Installation Profile ID	body	number
acqInstCode	1234	Acquiring Institution Code	body	string
gmtTxnTime	Feb 01, 2024 02:33:57 PM	GMT Transaction Time	body	string
localTxnTime	Feb 01, 2024 09:33:57 AM	Local Transaction Time	body	string
extConId	null	External Consumer ID (if applicable)	body	string
authCode	000000	Authorization Code	body	string
authTokenEncrCode	null	Encrypted Authorization Token Code	body	string
authTokenRespTx	null	Authorization Token Response Transaction	body	string
hostTokenId	null	Host Token ID (if applicable)	body	string
hostTranId	null	Host Transaction ID (if applicable)	body	string
hostPurRefId	null	Host Purchase Reference ID (if applicable)	body	string
serverHostDetail	null	Server Host Details (if applicable)	body	string
reqSentTime	null	Request Sent Time (if applicable)	body	string
respRcvdTime	null	Response Received Time (if applicable)	body	string
refTranId	847703394538	Reference Transaction ID	body	string
origTranId	null	Original Transaction ID (if applicable)	body	string
sysTrkAuditId	null	System Track Audit ID (if applicable)	body	string
trxnDescription	null	Transaction Description (if applicable)	body	string
merchantId	merchant1	Identifier for the merchant	body	string
mcc	5531	Merchant Category Code	body	string
termId	terminal1	Identifier for the terminal	body	string
merchantRefId	7262527	Merchant Reference ID	body	string
actionCode	1	Action Code for the transaction (e.g., PURCHASES)	body	number
actionCodeDesc	PURCHASES	Description of the Action Code	body	string
cardHolderName	ahmad	Name of the cardholder	body	string
cardNumberEnc	411111******1111	Encrypted Card Number	body	string
expiryMonth	null	Expiry Month of the card (if applicable)	body	string
expiryYear	null	Expiry Year of the card (if applicable)	body	string
cardType	INST1VISA	Type of Card (e.g., INST1VISA)	body	string
cardBin	411111	Bank Identification Number (BIN) of the card	body	string
brandId	101	Brand Identifier	body	string
responseCode	00	Response Code from the transaction (e.g., success)	body	string
paymentInstrument	CARD	Type of Payment Instrument (e.g., CARD)	body	string
amount	229.00	Transaction Amount	body	string
currencyCode	USD	Currency Code of the transaction (e.g., USD)	body	string
langId	EN	Language Identifier (e.g., EN)	body	string
paymentAmnt	null	Payment Amount (if applicable)	body	string
cnvrtRate	0.0	Conversion Rate (if applicable)	body	string
cnvrtPymntAmnt	null	Converted Payment Amount (if applicable)	body	string
savedCard	null	Indicator for Saved Card (if applicable)	body	string
status	0	Status of the transaction (e.g., 0 for pending)	body	number
udf	[]	User-Defined Fields (if applicable)	body	string

Search Transaction

Count/ List API Request

Parameter	Value	Description	Parameter Type	Data Type
actionCode	[“ALL”]	Action Code for the transaction (e.g., PURCHASES)	body	number
amount	“”	Transaction Amount	body	string
batchId	“”	Batch Id	body	string
cardBin	“”	Card Bin	body	string
cardNumber	“”	Card Number	body	number
cardNumberEnc	“”	Encrypted Card Number	body	string
cardType	[“ALL”]	Card Type	body	string
checkds	“both”	Check DS	body	string
currencyCode	[“ALL”]	Currency Code of the transaction (e.g., USD)	body	string
fromDate	“24-Jan-2024 00:00”	From Date	body	string
includeArchived	false	Have to Include Archived Transaction	body	string
merchantId	[“merchant1”]	Merchant Id	body	string
pageLength	“10”	Page Length	body	string
pageSize	“0”	Page Size	body	string
paymentInstrmnt	[“ALL”]	Payment Instrument	body	string
pmtStatus	[“ALL”]	PMT Status	body	string
termId	[“ALL”]	Terminal Id	body	string
toDate	“01-Feb-2024 21:47”	To Date	body	string
tranRefType	“”	Transaction REF Type	body	string
tranRefValue	“”	Transaction REF Value	body	string

Response

Parameter	Value	Description	Parameter Type	Data Type
id	0	Identifier for the transaction	body	number
toDate	2024-02-01 11:19:04	Date and time the transaction ends	body	string
fromDate	2024-02-01 11:19:04	Date and time the transaction starts	body	string
merchantId	merchant1	Identifier for the merchant	body	string
termId	AEDTEST	Identifier for the terminal	body	number
currencyCode	784	Numeric code for the currency	body	string
amount	998	Transaction amount	body	string
paymentId	824032407440001	Unique payment ID	body	string
instId	inst1	Installation ID (if applicable)	body	string
instPId	21	Installation Profile ID	body	string
threedsFlag	false	Flag indicating 3DS authentication	body	string
tranPortalId	AEDTEST	Identifier for transaction portal	body	string
merchantSuccessUrl	null	URL for successful transaction	body	string
merchantErrorUrl	null	URL for unsuccessful transaction	body	string
merchantRefId	ea6f64d1-21eb-499e-83ac-1d35e939d870	Reference ID provided by the merchant	body	string
merchantIntegType	null	Integration type for the merchant	body	string
password	null	Password (if applicable)	body	string
actionCode	REVERSAL	Action code for the transaction	body	string
cardHolderName	ahmad	Name of the cardholder	body	string
cardNumberMask	411111****1111	Masked Card Number	body	string
cardExpiryMonth	0*	Expiry Month of the card	body	string
cardExpiryYear	2**9	Expiry Year of the card	body	string
cardType	INST1VISA	Type of Card	body	string
cardBin	17895	Bank Identification Number (BIN) of card	body	string
brandId	null	Brand identifier (if applicable)	body	string
langId	null	Language identifier (if applicable)	body	string
pmtStatus	SUCCESS	Payment Status	body	number
currencyName	AED	Currency Name	body	string
areqData	null	AReq Data (if applicable)	body	string
aresData	null	ARes Data (if applicable)	body	string
creqData	null	CReq Data (if applicable)	body	string
cresData	null	CRes Data (if applicable)	body	string
vreqData	null	VReq Data (if applicable)	body	string
vresData	null	VRes Data (if applicable)	body	string
pareqData	null	PAReq Data (if applicable)	body	string
paresData	null	PARes Data (if applicable)	body	string
authCode	000000	Authorization Code	body	string
paymentInstrmnt	CARD	Type of Payment Instrument	body	string
status	null	Transaction Status	body	string
custMobNum	null	Customer Mobile Number	body	string
custEmail	null	Customer Email	body	string
tranType	null	Type of transaction	body	string
applePayFlag	false	Flag indicating Apple Pay usage	body	string
transId	924032407440002	Unique transaction ID	body	string
extConId	null	External Consumer ID	body	number
responseCode	00	Response Code from the transaction	body	string
riskRespCode	0	Risk Response Code
symbol	\u0000	Symbol (Unicode null character)
ipAddress	11.99.00	IP Address of the transaction
batchId	1234	Batch ID of the transaction
customField1	null	Custom Field 1
customField2	null	Custom Field 2
customField3	null	Custom Field 3
customField4	null	Custom Field 4
customField5	null	Custom Field 5
customField6	null	Custom Field 6
customField7	null	Custom Field 7
customField8	null	Custom Field 8
customField9	null	Custom Field 9
customField10	null	Custom Field 10
customField11	null	Custom Field 11
customField12	null	Custom Field 12
customField13	null	Custom Field 13
customField14	null	Custom Field 14
customField15	null	Custom Field 15
customField16	null	Custom Field 16
customField17	null	Custom Field 17
customField18	null	Custom Field 18
customField19	null	Custom Field 19
customField20	null	Custom Field 20
rrn	600466419600	Retrieval Reference Number (RRN)

Introduction

Tutorials

Reference

FAQs

Hosts

Security/ Authentication

HTTP Response Body

Encoding

Testing

Credit Card Test Accounts

Payment Basic Parameters

Authentication

Card Account

Customer

Server to Server/ Apple Pay Request & Response

Checkout API

Payment Gateway API

Response

Merchant Hosted Request & Response

Purchase

Request

Response

Reversal Transaction

Request

Response

Inquiry Transaction

Request

Response

Card Tokenization

Request

Response

Reporting

List Transaction

Count/ List API Request

List API Response

Search Transaction

Count/ List API Request

Response