Hosted Payment Page API

{
 
    "token": "authToken",   //Example: "f0bed899539742309eebd8XXXX7edcf615888XXXXXXXX"
 
    "content-type": "application/json"
 
};
 
Post body request
 
{
 
        "merchantAuthentication": {
 
                 "merchantId": "TPN_NUMBER",
 
                 "transactionReferenceId": "Transaction Reference Id"  
 
        },
 
        "transactionRequest": {
 
               "transactionType": 1/2,
 
               "amount": "Amount-value"   //Example 1000 for 10$ i.e. 10x100
 
               "calculateFee": true/false,
 
               "tipsInputPrompt": true/false,
 
               "calculateTax": true/false,
 
               "feeAmount": "FEE-Amount-value",   //Example 1000 for 10$ i.e. 10x100
 
               "feeLabel": "Fee Label",
 
                             "lTaxAmount": "L-TAX-Amount-value",   //Example 1000 for 10$ i.e. 10x100
 
               "lTaxLabel": "Local-Tax-Label",
 
               "gTaxAmount": "G-TAX-Amount-value",   //Example 1000 for 10$ i.e. 10x100
 
               "gTaxLabel":  “State Tax label",
 
               "txReferenceTag1": {
 
                     "tagLabel": "Tag-label-1",  // Example “Vehicle Number”
 
                     "tagValue": "Tag-1 value",  // Example “TN43AA445”
 
                     "isTagMandate": true/false
 
                }
 
              "txReferenceTag2": {
 
                    "tagLabel": "Tag-label-2",
 
                    "tagValue": "Tag-2 value", 
 
                    "isTagMandate": true/false
 
           },
 
            "txReferenceTag3": {
 
                  "tagLabel": "Tag-label-3",
 
                  "tagValue": "Tag-3 value"
 
                  "isTagMandate": true/false
 
        }
 
},
 
    "notificationOption": {
 
           "notificationBySMS": false,
 
           "mobileNumber": "",
 
    "notifyByPOST": false,
 
          "authHeader": "", 
 
          "postAPI": "",  
 
     "notifyByRedirect": true,
 
           "returnUrl": "<return url>",  // Example https://www.merchanturl.com/thankyou/success.php
 
           "failureUrl": "<failure url>",  // Example https://www.merchanturl.com/thankyou/failure.php 
 
          "cancelUrl": "<cancel url>",  // // Example https://www.merchanturl.com/checkout.php
 
  },
 
  "preferences": {
 
        "integrationType": "HPP integration type", 
 
        "avsVerification": true/false,    
 
       "eReceipt": true/false,
 
       "eReceiptInputPrompt": true/false,
 
       "customerName": "Customer_Name",    
 
       "customerEmail": "Customer_Email",    
 
       "customerMobile": "Customer_mobile_number_with_ISD_code",
 
       "requestCardToken": true/false
 
       "shortenURL": true/false
 
       “sendPaymentLink”: true/false
 
       “integrationVersion” : “v2”
 
  },
 
  "personalization": {
 
       "merchantName": "Merchant / DBS Name"
 
      "logoUrl": "http or https image url"  //Eg., "https://merchanturl.com/logo/images/logo-name.png",
 
      "themeColor": "theme colour",    //Example #808080
 
      "description": "Merchant given description",
 
      "payNowButtonText": "pay now button text"    //Example "Pay Now"
 
      "buttonColor": "pay button colour",    //Example #808080
 
      "cancelButtonText": "cancel button text"  //Example "Go to merchant site"
 
      "disclaimer": "Disclaimer information can be placed here",  //Example "Only VISA card accepted"
 
  },
 
}

{
 
    "token": "authToken",   //Example: "f0bed899539742309eebd8XXXX7edcf615888XXXXXXXX"
 
    "content-type": "application/json"
 
};
 
 
Post body request
 
{
   "merchantAuthentication": {
 
         "merchantId": "TPN_NUMBER",
 
         "transactionReferenceId": "Transaction Reference Id"  
 
    },
 
   "transactionRequest": {
 
        "transactionType": 1,
 
        "amount": "Amount-value" // example 1000 for 10$ i.e. 10x100
 
        "calculateFee": true/false,
 
        "tipsInputPrompt": true/false,
 
       "calculateTax": true/false,
 
       "feeAmount": "FEE-Amount-value",   //Example 1000 for 10$ i.e. 10x100
 
       "feeLabel": "Fee Label",
 
       "lTaxAmount": "L-TAX-Amount-value",   //Example 1000 for 10$ i.e. 10x100
 
       "lTaxLabel": "Local-Tax-Label",
 
       "gTaxAmount": "G-TAX-Amount-value",   //Example 1000 for 10$ i.e. 10x100
 
       "gTaxLabel":  “State Tax label",
 
       "txReferenceTag1": {
 
            "tagLabel": "Tag-label-1",  // Example “Vehicle Number”
 
            "tagValue": "Tag-1 value"  // Example “TN43AA445”
 
           "isTagMandate": true/false
 
      }
 
      "txReferenceTag2": {
 
           "tagLabel": "Tag-label-2",
 
           "tagValue": "Tag-2 value" 
 
           "isTagMandate": true/false
 
     },
 
     "txReferenceTag3": {
 
         "tagLabel": "Tag-label-3",
 
         "tagValue": "Tag-3 value"
 
         "isTagMandate": true/false
 
    }
},
 
"notificationOption": {
 
     "notificationBySMS": true,
 
     "mobileNumber": "Merchant Mobile Number Ex +17878787878",
 
     "notifyByPOST": false,
 
     "authHeader": "", 
 
     "postAPI": "",  
 
 
     "notifyByRedirect": false,
 
     "returnUrl": "",   
 
     "failureUrl": "",      
 
     "cancelUrl": "",
 
},
 
"preferences": {
 
    "integrationType": "HPP integration type",   //Example for e-commerce value is 1
 
    "avsVerification": true/false,    
 
    "eReceipt": true/false,
 
    "eReceiptInputPrompt": true/false,
  
    "customerName": "Customer_Name",    
 
    "customerEmail": "Customer_Email",    
 
    "customerMobile": "Customer_mobile_number_with_ISD_code",
 
    "requestCardToken": true/false
 
    ""shortenURL": true/false
 
},
"personalization": {
 
     "merchantName": "Merchant / DBS Name"   //Example "walmart"
 
     "logoUrl": "http or https image url"  // Eg., "https://merchanturl.com/logo/images/logo-name.png",
 
     "themeColor": "theme colour",     //Example #808080
 
     "description": "Merchant given description",
 
    "payNowButtonText": "pay now button text"  //Example "Pay Now"
 
    "buttonColor": "pay button colour",    //Example #808080
 
     "cancelButtonText": "cancel button text"    //Example "Go to merchant site"
   
     "disclaimer": "Disclaimer information can be placed here",  //Example "Only VISA card accepted"
     },
 
}

{
 
    "token": "authToken",   //Example: "f0bed899539742309eebd8XXXX7edcf615888XXXXXXXX"
 
    "content-type": "application/json"
 
};
 
 
 
Post body request
 
{
 
        "merchantAuthentication": {
 
"merchantId": "TPN_NUMBER",
 
"transactionReferenceId": "Transaction Reference Id"  
 
        },
 
        "transactionRequest": {
 
"transactionType": 1/2,
 
"amount": "Amount-value" // example 1000 for 10$ i.e. 10x100
 
"calculateFee": true/false,
 
"tipsInputPrompt": true/false,
 
"calculateTax": true/false,
 
"feeAmount": "FEE-Amount-value",   //Example 1000 for 10$ i.e. 10x100
 
"feeLabel": "Fee Label",
 
"lTaxAmount": "L-TAX-Amount-value",   //Example 1000 for 10$ i.e. 10x100
 
"lTaxLabel": "Local-Tax-Label",
 
"gTaxAmount": "G-TAX-Amount-value",   //Example 1000 for 10$ i.e. 10x100
 
"gTaxLabel":  “State Tax label",
 
"txReferenceTag1": {
 
        "tagLabel": "Tag-label-1",  // Example “Vehicle Number”
 
"tagValue": "Tag-1 value"  // Example “TN43AA445”
 
"isTagMandate": true/false
 
}
 
"txReferenceTag2": {
 
        "tagLabel": "Tag-label-2",
 
"tagValue": "Tag-2 value" 
 
"isTagMandate": true/false
 
},
 
"txReferenceTag3": {
 
        "tagLabel": "Tag-label-3",
 
"tagValue": "Tag-3 value"
 
"isTagMandate": true/false
 
}
 
        },
 
        "notificationOption": {
 
"notificationBySMS": false,
 
"mobileNumber": "",
 
"notifyByPOST": true,
 
"authHeader": "API Access token", 
 
"postAPI": "Merchant post API Url",  Example https://www.merchanturl.com/getResponse.api
 
"notifyByRedirect": false,
 
"returnUrl": "",   
 
"failureUrl": "",      
 
"cancelUrl": "",
 
        },
 
        "preferences": {
 
"integrationType": "HPP integration type",  // Example for e-commerce value is 1
 
"avsVerification": true/false,    
 
"eReceipt": true/false,
 
"eReceiptInputPrompt": true/false,
 
"customerName": "Customer_Name",    
 
"customerEmail": "Customer_Email",    
 
"customerMobile": "Customer_mobile_number_with_ISD_code",
 
"requestCardToken": true/false
 
"shortenURL": true/false
 
        },
 
        "personalization": {
 
"merchantName": "Merchant / DBS Name",    //Example "walmart"
 
"logoUrl": "http or https image url”  //Ex., https://merchanturl.com/logo/images/logo-name.png",
 
"themeColor": "theme colour",     //Example #808080
 
"description": "Merchant given description",
 
"payNowButtonText": "pay now button text”,    //Example "Pay Now"
 
"buttonColor": "pay button colour",     //Example #808080
 
"cancelButtonText": "<cancel button text>"     //Example "Go to merchant site"
 
"disclaimer": "Disclaimer information can be placed here",  //Example "Only VISA card accepted" 
 
        },
 
}

{
    "message": "Url generated Successful",
    "information": "https://payment.ipospays.tech/api/v1/externalPay?t=< token-value >"
}

{
    "message": "URL generated successfully",
    "information": "https://api.denovosystem.tech/v1/sl/344r0Cd101101T312"
}

{
 
    "errors": [
        {
            "field": "merchantAuthentication.merchantId",
            "message": "Invalid Merchant Id"
        },
	{
            "field": "transactionRequest.transactionType",
            "message": "Invalid Transaction Type"
        }, ...
    ]
}

{
 
        "iposHPResponse": {
 
                     "responseCode": "iPOS-HP response code like 200, 400,...",
 
                     "responseMessage": "Successful/Declined/Cancelled By Customer/Rejected By Customer",
 
                     "errResponseCode": "Error response code", 
 
                     "errResponseMessage": "Error response message",
 
                     "transactionReferenceId": "merchant unique transaction reference id sent on request",
 
                     "transactionType": "1-sale/ 2-card validation",
 
                     "transactionId": "Unique transaction Id of iPOS-HPP"
 
                     "transactionNumber": "4 digits of transaction number from processor",
 
                     "batchNumber": "3 digits of batch number from processor",
 
                     "cardType": "VISA/MASTERCARD/etc...",
 
                     "cardLast4Digit": "last 4 digit of credit/debit card",
 
                     "amount": "base amount or total amount charged",
 
                     "tips": "tip amount",
 
                     "customFee": "custom fee",
 
                     "localTax": "local tax",
 
                     "stateTax": "state tax",
 
                     "totalAmount": "total amount charged",
 
                     "responseApprovalCode": "response approval code from processor ex: TAS164",
 
                     "rrn": "retrieval reference number from processor #219313501821",
 
                     "CardToken": "card-token-value", 
 
                     "avsRespMeg" : "ADDRESS MATCH", 
 
                     "avs" : {
                      "Zip": "100004",
                      "StreetNo" : “15205  North  Kierland  Blvd.  Suite  100"
                            } 
    
 
        }
 
}
 

{
import { Component, OnInit } from '@angular/core';
import { HttpClient, HttpHeaders } from '@angular/common/http';
 
//Import HttpClientModule  and add Providers : [HttpClient] in your module.ts file
 
export interface Payload {
  merchantAuthentication: MerchantAuthentication;
  transactionRequest: TransactionRequest;
  personalization: Personalization;
  notificationOption: NotificationOption;
  preferences: Preferences;
}
export interface MerchantAuthentication {
  merchantId: string;
  transactionReferenceId: string;
}
export interface TransactionRequest {
  transactionType: number;
  amount: number;
  calculateFee: boolean;
  invoiceNumber: string;
}
export interface Personalization {
  logo: string;
  themeColor: string;
  description: string;
  payNowButtonText: string;
  buttonColor: string;
  cancelButtonText: string;
}
export interface NotificationOption {
  returnUrl: string;
  failureUrl: string;
  authHeader: string;
  cancelUrl: string;
  notifyByRedirect: boolean;
  notifyByPOST: boolean;
  postAPI: string;
  mobileNumber: string;
  notifyBySMS: boolean;
}
export interface Preferences {
  eReceipt: boolean;
  avsVerification: boolean;
  customerName: string;
  customerEmail: string;
  customerMobile: string;
  integrationType: number;
 requestCardToken: boolean;
}
 
export interface PaymentSuccessResponse {
  information: string  // this will be the redirect url,
  message: string
}
 
export interface PaymentFailureResponse {
  errors?: (ErrorsEntity)[] | null;
}
export interface ErrorsEntity {
  field: string;
  message: string;
}
 
 
@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})
 
export class AppComponent implements OnInit {
 
  generatedTpn: string = ''
  generatedToken: string = ''
  routeUrl: string = 'Your Route Url Here'
  paymentUrl: string = 'Your Route URL'
 
  // All the urls should be trimmed. No trailing and leading white spaces 
 
  payload: Payload = {
    merchantAuthentication: {
      merchantId: this.generatedTpn,
      transactionReferenceId: Math.random().toString(36).slice(2)
    },
    transactionRequest: {
      transactionType: 1,
      amount: 100, // Amount (eg : 100 = 1$)
      calculateFee: true,
      invoiceNumber: ""
    },
    personalization: {
      logo: "https://www.example.com/image/img.jpg",  // Logo image url
      themeColor: "#80DEEA",
      description: "Your Description Here",
      payNowButtonText: "Pay Now",
      buttonColor: "#80DEEA",
      cancelButtonText: "Reset"
    },
    notificationOption: {
      returnUrl: this.routeUrl,
      failureUrl: "",
      authHeader: "",
      cancelUrl: "",
      notifyByRedirect: true,
      notifyByPOST: false,
      postAPI: "",
      mobileNumber: "",
      notifyBySMS: false
    },
    preferences: {
      eReceipt: false,
      avsVerification: true,
      customerName: "",
      customerEmail: "",
      customerMobile: "",
      integrationType: 1
      requestCardToken: true
    }
  }
 
  constructor(private httpClient: HttpClient) { }
 
  async ngOnInit() {
 
    try {
      const result = await this.getPaymentForm(this.payload) as PaymentSuccessResponse
      const redirectUrl = result.information
      window.open(redirectUrl, '_self')
    }
    catch (err) {
      // handle error here
    }
  }
 
  getPaymentForm(payload: Payload) {
    const httpOptions = {
      headers: new HttpHeaders({ 'token': this.generatedToken, 'withCredentials': 'false' })
    };
 
    return new Promise((resolve, reject) => {
      this.httpClient.post(this.paymentUrl, payload, httpOptions).subscribe(
        (data: PaymentSuccessResponse | any) => {
          resolve(data)
        },
        (error: PaymentFailureResponse) => {
          reject(error)
        }
      )
 
    })
  }
 
}
}

{
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://payment.ipospays.tech/api/v1/external-payment-transaction',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>' {
        "merchantAuthentication": {
            "merchantId": "",
            "transactionReferenceId": ""
        },
        "transactionRequest": {
            "transactionType": 1,
            "amount": "400",
            "calculateFee": true,
            "txReferenceTag1": {
                "tagLabel": "TEST",
                "tagValue": "TAG"
            },
            "txReferenceTag2": {
                "tagLabel": "TEST1",
                "tagValue": "TAG1"
            },
            "txReferenceTag3": {
                "tagLabel": "TEST2",
                "tagValue": "TAG2"
            }
        },
        "personalization": {
            "logoUrl": "",
            "themeColor": "",
            "description": "",
            "payNowButtonText": "",
            "buttonColor": "",
            "cancelButtonText": ""
        },
        "notificationOption": {
            "postAPI": "",
            "failureUrl": "",
            "returnUrl":"",
            "notifyByRedirect": false,
            "notifyBySMS": false,
            "notifyByPOST": false,
            "authHeader": "",
            "cancelUrl": "",
            "mobileNumber": ""
        },
        "preferences": {
            "integrationType": 1,
            "eReceipt": true,
            "avsVerification": true,
            "eReceiptInputPrompt": true,
            "customerName": "",
            "customerEmail": "",
            "customerMobile": ""
            "requestCardToken":true
        }
    }
',
  CURLOPT_HTTPHEADER => array(
    'token: ',
    'Content-Type: application/json'
  ),
));
 
$response = curl_exec($curl);
 
curl_close($curl);
echo $response;
 
$reqjson = json_decode($response, true);
//header("Location:". $reqjson['information']);
}

{
        "iposHPResponse": {
              "responseCode": < iPOS-HP response code >,	
              "responseMessage": "Successful/Decined/Cancelled By Customer/Rejected By Customer",
	      "errResponseCode": < Error response code >,
	      "errResponseMessage": < Error response message >,
	      "transactionReferenceId": < merchant transaction reference id >,
      "transactionId": < Unique transaction Id of iPOS-HP >
	      "transactionType": < 1-sale/2-void/3-refund >,
	      "transactionNumber": < 4 digits of transaction number from processor >,
	      "batchNumber": < 3 digits of batch number from processor >,
	      "cardType": < VISA/MASTERCARD/etc...>,
	      "cardLast4Digit": < last 4 digit of credit/debit card >,
	      "amount": < base amount or total amount charged >,
	      "tips": < tip amount >,
	      "customFee": < custom fee >,
	      "localTax": < local tax >,
	      "stateTax": < state tax >,
	      "totalAmount": < total amount charged >,
	      "responseApprovalCode": < ex: TAS164 from processor >,
	      "rrn": < retrieval reference number >
              "cardToken":"card-token-value"	      
        }
}

{

        "merchantAuthentication": {

. . .  //merchant auth key & values

        },

        "transactionRequest": {

"transactionType":1/2    // 1 - Sale / 2 - Card Validation

. . . //other transaction request key & values

        },

        "notificationOption": {

. . . //notification option request key & values

        },

        "preferences": {

"integrationType": "HPP integration type", 

"avsVerification": true/false,    

"eReceipt": true/false,

"eReceiptInputPrompt": true/false,

"customerName": "Customer_Name",    

"customerEmail": "Customer_Email",    

"customerMobile": "Customer_mobile_number_with_ISD_code",

"requestCardToken": true   // value can be true or  false 

        },

        "personalization": {

. . .  //personalization request key & values

        },

}

{
 
        "iposHPResponse": {
 
                     "responseCode": "iPOS-HP response code like 200, 400,...",
 
                     "responseMessage": "Successful/Declined/Cancelled By Customer/Rejected By Customer",
 
      "errResponseCode": "Error response code", 
 
      "errResponseMessage": "Error response message",
 
      "transactionReferenceId": "merchant unique transaction reference id sent on request",
 
      "transactionType": "1-sale/2-card validation",
 
      "transactionId": "Unique transaction Id of iPOS-HPP"
 
      "transactionNumber": "4 digits of transaction number from processor",
 
      "batchNumber": "3 digits of batch number from processor",
 
      "cardType": "VISA/MASTERCARD/etc...",
 
      "cardLast4Digit": "last 4 digit of credit/debit card",
 
      "amount": "base amount or total amount charged",
 
      "tips": "tip amount",
 
      "customFee": "custom fee",
 
      "localTax": "local tax",
 
      "stateTax": "state tax",
 
      "totalAmount": "total amount charged",
 
      "responseApprovalCode": "response approval code from processor ex: TAS164",
 
      "rrn": "retrieval reference number from processor #219313501821",
 
      "responseCardToken": "card-token-value"
 
        }
 
}

 
{
 
        "iposHPResponse": {
 
                     "responseCode": "iPOS-HP response code like 200, 400,...",
 
                     "responseMessage": "Successful/Declined/Cancelled By Customer/Rejected By Customer",
 
      "errResponseCode": "Error response code", 
 
      "errResponseMessage": "Error response message",
 
      "transactionReferenceId": "merchant unique transaction reference id sent on request",   
 
      "transactionType": "1-sale/2-void/3-refund",
 
      "transactionId": "Unique transaction Id of iPOS-HPP"
 
      "transactionNumber": "4 digits of transaction number from processor",
 
      "batchNumber": "3 digits of batch number from processor",
 
      "cardType": "VISA/MASTERCARD/etc...",
 
      "cardLast4Digit": "last 4 digit of credit/debit card",
 
      "amount": "base amount or total amount charged",
 
      "tips": "tip amount",
 
      "customFee": "custom fee",
 
      "localTax": "local tax",
 
      "stateTax": "state tax",
 
      "totalAmount": "total amount charged",
 
      "responseApprovalCode": "response approval code from processor ex: TAS164",
 
      "rrn": "retrieval reference number from processor #219313501821"
 
        }
 
}