Request Method :: POST

Description: This API allows merchants to place a hold on a customer’s funds without immediately capturing them.

Headers

requestTimestamp : 123432553255

transactionid: 100170

merchantId:1234

orderId:100156
clientId:  To be shared during integration by ISU Team
hmacSecret::  To be shared during integration by ISU Team
Content-Type: application/json

Header Parameters

Parameters Max Length Data types Mandatory/Optional Parameter Description
requestTimestamp 13 String Mandatory Epoch timestamp in milliseconds
transactionid 20 String Mandatory Unique Transaction ID
merchantId 15 String Mandatory Merchant identifier
orderId 20 String Mandatory Order Reference ID
clientId 64 String Mandatory Client authentication key
hmacSecret 64 String Mandatory HMAC Signature key
Content-Type - String Mandatory Must be application/json

Request Body Parameters

Parameters Max Length Data types Mandatory/Optional/conditional Parameter Description with samples
apiOperation 10 String Mandatory Must be PURCHASE
authzTxnId 19 String Mandatory Authorization ID.E.g.-100180
authentication - Object Conditional Authentication Details
  • authcTxnId
 19 String Conditional 3DS transaction ID.E.g.-1300
  • skip3ds
 - Boolean Conditional Bypass 3DS if true.E.g.-false
  • 3dsProvider
 - String Conditional 3DS provider name.E.g.Others
sourceOfFunds - Object Mandatory Payment Source
gpayTokenDetails - Object Mandatory Google Pay token details
  • pan
 16 String Mandatory Device Primary Account Number(DPAN).E.g.3456785593568727
  • expirationMonth
 2 String Mandatory Expiry month(MM),E.g.02
  • expirationYear
 2 String Mandatory Expiry year(YY),E.g.-28
  • authMethod
 - String Mandatory PAN_ONLY or CRYPTOGRAM_3DS
  • cryptogram
 - String Conditional Required for CRYPTOGRAM_3DS
  • cardNetwork
 - String Mandatory Card network(e.g.,MC,VISA)
apayTokenDetails - Object Mandatory Apple Pay token details
  • applicationPrimaryAccountNumber
 - String Mandatory Application Primary Account Number.E.g.3456785593568727
  • applicationExpirationDate
 - String Mandatory Expiry in YYYYMM format.E.g.-2a2802
  • deviceManufacturerIdentifier
 - String OPtional Device manufacturer ID.Eg.040010030273
paymentDataType - String Mandatory Payment data type.E.g.3DSecure
paymentData - Object Mandatory Payment data
  • onlinePaymentCryptogram
 - String Mandatory Online cryptogram value,E.g.Af9x7AABAAACZCjB3mPUAAAAAAA
transactionIdentifier - String Mandatory Transaction identifier.E.g.5e269e9fe8b1bb382fdd99a93c33e3bcf6e3
token - String Conditional Token for recurring payments.E.g.4AJefQkUj1BRb+bpzwqms1ER+nRqmbG04yDen/DTu2Q=
provided - Object Mandatory Provided Data
card - Object Mandatory Card Details
  • number
 16 String Mandatory Card number.E.g.3456785593568727
expiry 2 Object Mandatory Expiry month(MM)& year(YY).
  • month
 2 String Mandatory Expiry month(MM)E.g.-02
  • year
 2 String Mandatory Expiry year(YY)E.g.-28
nameOnCard - String Mandatory Name on the card.E.g.santosh
securityCode 3-4 String Mandatory Card CVV.E.g.-123
coftConsent - Boolean Conditional Tokenization consent(false here)
type - String Mandatory Card
order - Object Mandatory Transaction Details
  • currency
 3 String Mandatory Currency code.E.g.-AED
  • amount
 - String Mandatory Transaction amount.E.g.-100

Sample Request Body

Response Body Parameters

Parameters Data Type Parameter description
apiOperation String Confirms the operation type(purchase)
order Object Order details
  • id
 String order ID
  • amount
 String Transaction amount
  • currency
 String Currency(may differ from request)
payment Object Payment Status
  • id
 String Payment ID
  • entity
 String Payment Entity type
  • amount
 String Transaction Amount
  • currency
 String Currency(may differ from request)
  • status
 String SUCCESS or FAILED
  • method
 String Card
  • description
 String Description Message
  • international
 String YES if international card
  • refundStatus
 String Status of refund if applicable
  • amountRefunded
 String Total Amount Refunded
  • captured
 String YES(immediate settlement)
  • email
 String Customer Email
  • contact
 String Customer Contact
  • cardid
 String Card ID
  • wallet
 String Wallet
  • notes
 String Transaction Notes
  • created_date
 String Date of transaction creation
cardDetails Object Masked card info
  • id
 String Card entity ID
  • entity
 String Payment entity type
  • name
 String Card holder name
  • last4
 String Last 4 digits(e.g.,8727)
  • network
 String Card network
  • type
 String Card type
  • issuer
 String Card issuer
  • emi
 String EMI details if applicable
  • suType
 String Sub Type of card
acquirerData Object Bank processing details
  • rrn
 String Retrieval Reference Number
  • authenticationReferenceNumber
 String 3DS auth reference(if applicable)
  • bankTransactionId
 String Bank’s transaction ID
  • stan
 String System trace audit number
  • merchantID
 String Merchant ID
  • terminalID
 String Terminal ID
  • merchantName
 String Name of the Merchant
isMoto Boolean Indicates if it was a Mail Order/Telephone Order
success Object Success
  • responseMsg
 String Response Message
  • responseCode
 String Response Code

Sample Response Body