Workflow of Blue-Pay Hosted Payment

Owned by Sagar Alat
Sept 04, 2020

This page contains the overall workflow of the Hosted payment forms that explain each step involved in the hosted payment transaction. 

The process involves two major steps that are:

Hosted Payment Request Data Workflow

The information given below explains the workflow of processing hosted payment gateway response. 

Whenever a payment request is made using hosted payment forms, the gateway performs the transaction and responds us back by posting the response data to the return URL that was provided while generating the hosted payment form request URL. 

We then use this response data validates it and creates/updates payment information into the GE that has requested the payment. 

Below is the workflow diagram for the reference:

Below are the details of steps involved in the process:

  1. After performing the requested transaction, For Aptify the payment gateway sends the response back to us on the Return URL that we provided in the payment request, For smart client since it is a connected architecture the under line GE is present with us.
  2. For Aptify Web We then Parse the Response data and extracts the GE that requested the payment (Referred to as GEREquestingPayment). For Smart Client we have the GE present with us.
  3. Cast the GERequestingPayment into IRemotePaymentEntityService interface.
  4. If the casting of GERequestingPayment to IRemotePaymentEntityService fails then we exit the process and throw an error.
  5. If the casting of GERequestingPayment to IRemotePaymentEntityService is successful then we call the interface method PostRemotePaymentResponseData on the casted GE.
  6. This will validate the payment response and updated the Remote Payment Record associated with the current transaction with transaction details and on success will create/update the payment information on the GERequestingPayment else will throw an error.

Hosted Payment Request Data Workflow

The information given below explains explains the workflow of the Hosted Payment Form whenever a payment request is made in our Aptify System. 

When a Hosted Payment request is made we generate the request data in our system based on the payment gateway that's responsible for processing the transaction and that data is used for navigating to the secure payment form which is hosted by the payment gateway. (The payment request data could either be a URL or JSON etc. that will be used for navigating to the hosted payment form) 

Below is the workflow diagram for the reference:

Below are the details of steps involved in the process:

  1. User Chooses payment type that supports hosted payment and clicks Make Payment. 
  2. Identifies the underlying GE that is requesting payment (e.g. Orders/Payments/PersonSPM/CompanySPM etc. referred as GERequestingPayment). 
  3. Cast the GERequestingPayment into IRemotePaymentEntityService interface.
  4.  If the casting of GERequestingPayment to IRemotePaymentEntityService is successful then continue to step 6. 
  5. If the casting of GERequestingPayment to IRemotePaymentEntityService fails then we exit the process and throw an error. 
  6. Call the interface method GenerateAndGetRemotePaymentRequestData on the casted GE. 

  7. On success, this will return the payment request data(URL/JSON data, etc.) as a string that will be used to navigate to secure payment form hosted by the payment gateway navigate to the secure hosted payment form in the browser or Iframe using the request data generated payment gateway plugin.

    On failure will return an error message.