3. Initiate Pay

After validating the merchant request, This API is used to process payment requests securely by encrypting card data using AES and RSA encryption.

API Endpoints

Direct Pay Production Base URL /InitiatePay

Direct Pay Sandbox Base URL /InitiatePay

Sample Request & Response

The request body should include the following fields:

 "Initiate pay request{
     "ReferenceId" : "xxxxxxxxx",//15-digit reference id received in the validate requet response
     "MerchantId": xxxxxx, //merchant code
     "ECardData" = "encryptedCard", //card data encrypted using AES Encryption 
     "ECardKey" = "encryptedKey", // Encrypt the 32 digit AES key using the public key
     "ACS_CallbackURL"= "call back url for 3DS"+ReferenceId   //optional
     }
     
 };

{
  "authentication": {
    "3ds1": {
      "veResEnrolled": "Y"
    },
    "3ds2": {
      "directoryServerId": "DS12345",
      "methodCompleted": true,
      "methodSupported": "true",
      "protocolVersion": "2.1.0",
      "requestorId": "REQ12345",
      "requestorName": "Merchant",
      "3dsServerTransactionId": "3DSTX12345",
      "acsTransactionId": "ACSTX12345",
      "dsTransactionId": "DSTX12345",
      "transactionStatus": "Success"
    },
    "acceptVersions": "2.1.0",
    "channel": "Browser",
    "purpose": "Authentication",
    "redirect": {
      "customized": {
        "3DS": {
          "methodPostData": "data",
          "methodUrl": "https://acs.bank.com/3ds-method",
          "acsUrl": "https://acs.bank.com/acs-url",
          "cReq": "creq12345",
          "transactionId": "12345"
        }
      },
      "domainName": "https://merchant.com",
      "html": "<html>...3DS Authentication...</html>"
    },
    "redirectHtml": "<html>...3DS Authentication...</html>",
    "version": "2.1.0",
    "3ds": {
      "methodPostData": "data",
      "methodUrl": "https://acs.bank.com/3ds-method",
      "acsUrl": "https://acs.bank.com/acs-url",
      "cReq": "creq12345"
    },
    "method": "Redirect",
    "payerInteraction": "Active"
  },
  "correlationId": "corr-12345",
  "device": {
    "browser": "Chrome",
    "ipAddress": "192.168.1.1"
  },
  "error": null,
  "merchant": "98765",
  "order": {
    "orderId": "ORD12345",
    "amount": "100.00",
    "currency": "USD"
  },
  "response": {
    "status": "Success",
    "message": "Authentication successful"
  },
  "result": "Success",
  "sourceOfFunds": {
    "type": "CreditCard",
    "cardBrand": "Visa"
  },
  "timeOfLastUpdate": "2024-12-26T10:00:00Z",
  "timeOfRecord": "2024-12-26T10:00:00Z",
  "transaction": {
    "transactionId": "TX12345",
    "amount": "100.00",
    "currency": "USD",
    "status": "Completed"
  },
  "version": "1.0"
}

Field Name

Type

Description

ReferenceId

string

15-digit reference id received in the validate requet response

MerchantId

string

Merchant code

ECardData

string

The encrypted card data encrypted using AES encryption with a 32-bit key. Explained below

ECardKey

string

The AES encryption key, encrypted using an RSA public key generated at here

ACS_CallbackURL

string

Explained here

Explanation of the `ECardData` Encryption Object

The ECardData field in the request is an encrypted representation of the sensitive card details. The following explains the object that is encrypted using AES encryption before being included in the API request:

{
    "CardNumber": "xxxxxxxxxxxxxxxx",//16-digit card number
    "CardName": "John Doe", //Name mentioned on card
    "CardExpiry": "mm/yy", //month/year format
    "CardCVV": "xxx" //3 decimal number
}

ACS_CallbackURL

If empty, the 3D Secure callback will be handled by the provider, and the user will be redirected to call back url provided in the step 1. For more info about redirection refer here.
If provided, the 3D Secure callback will be sent to the merchant's specified URL, and the merchant must call the API at here for further processing.

Previous2. Validate Request Next4. Process Payment

Last updated 1 month ago

Was this helpful?