Request Method :: POST

Description: This API allows merchants to securely accept payments from customers using Apple devices.

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 for initial transaction.E.g.88596592212899114
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
  • eci
 - String Mandatory Electronic Commerce indicator.E.g.-99
sourceOfFunds - Object Mandatory Payment Source
apayTokenDetails - Object Mandatory Apple Pay Token Details
  • applicationPrimaryAccountNumber
 16 String Mandatory APAYPAN.E.g.3456785593568727
applicationExpirationDate 2 String Mandatory ExpiryinYYYYMMformat.E.g.202802
  • deviceManufacturerIdentifier
 2 String Optional Device manufacturer ID.E.g.040010030273
  • paymentDataType
 2 String Mandatory Payment data type.E.g.3DSecure
paymentData - Object Mandatory PaymentData
  • onlinePaymentCryptogram
 - String Mandatory Online cryptogram value.E.g.Af9x7AABAAACZCjB3mPUAAAAAAA
transactionIdentifier - String Mandatory Transaction identifier.E.g.5e269e9fe8b1bb382fdd99a93c33e3bcf6e3
type - String Mandatory Type of source(e.g.,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 Operation performed
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
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
  • brand
 String Merchant Brand name
  • merchantName
 String Name of the Merchant
isRefunded Boolean Indicates if transaction was refunded
isVoid Boolean Indicates if transaction was voided
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