Method: transactionInitiatedNotification

This API is used by Google to notify the integrator that a payment transaction has been initiated within the Google system. The integrator will inform Google of the transaction's final result by calling the CaptureResultNotification API.

The requestId within the header is the idempotency key and uniquely identifies this transaction.

If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type ErrorResponse.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 2
    },
    "requestId": "requestId123",
    "requestTimestamp": {
      "epochMillis": "1502220196077"
    },
    "paymentIntegratorAccountId": "JUSPAY_1"
  },
  "transactionUri": "upi://pay?mode=04&purpose=14&orgid=000000&tid=Gtxn4686someTransactionId&tr=Gtxn4686someTransactionId&tn=Test for Imali&pa=googletest2@okaxis&pn=Google&mc=5399&am=500.00&cu=INR"
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1581900013178"
    }
  },
  "result": {
    "acknowledged": {}
  }
}

HTTP request

POST https://www.integratorhost.example.com/integrator-base-path/e-wallets-v2/transactionInitiatedNotification

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestHeader": {
    object (RequestHeader)
  },

  // Union field fop_details can be only one of the following:
  "transactionUri": string
  // End of list of possible types for union field fop_details.
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.
Union field fop_details. REQUIRED: Details regarding the form of payment being used to initiate the transaction. fop_details can be only one of the following:
transactionUri

string

This is a URI which contains the essential information about the transaction including transaction identifier, amount, and currency. This will be the same URL used to generate a QR code or redirect a user for the transaction.

Response body

This method supports multiple return types. For additional information about what 4XX or 5XX HTTP status code to return with an ErrorResponse, consult the ErrorResponse object and HTTP status codes documentation.

Possible response messages
HTTP 200 Status

object (TransactionInitiatedNotificationResponse)
HTTP 4XX / 5XX Status

object (ErrorResponse)

TransactionInitiatedNotificationResponse

Response object for the transaction initiated notification method.

JSON representation 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (TransactionInitiatedNotificationResult)
  }
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (TransactionInitiatedNotificationResult)

REQUIRED: The result of the transaction initiated notification call.

TransactionInitiatedNotificationResult

Result codes for transactionInitiatedNotification method call.

JSON representation 
{

  // Union field result can be only one of the following:
  "acknowledged": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}
Fields
Union field result. REQUIRED: The result must contain exactly one of these messages. result can be only one of the following:
acknowledged

object (Empty)

The transaction inititation notification has been successfully processed and the integrator will do additional steps to determine if the payment transaction was successful or declined. Once the integrator knows the result of the transaction, they will inform Google of the result by calling the captureResultNotification API.