Method: payment-integrator-authenticated-card-fop-api.getAuthenticateResult

Stay organized with collections Save and categorize content based on your preferences.

Gets the result of a completed authentication. This is used for REDIRECT_URL authentications after the user's browser uses the callback URL to return to Google.

Sometimes the authentication is successful, but the callback URL is unsuccessful or slow. Therefore, the payment integrator should also use the authenticateResultNotification to send the status to Google when it is known. The status from both this method and the authenticateResultNotification must be the same.

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": 1
    },
    "requestId": "ak31kzZk3l19",
    "requestTimestamp": {
      "epochMillis": "1481899949606"
    },
    "paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR"
  },
  "authenticateRequestId": "G112YZH4XPDV88J"
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1481899949611"
    }
  },
  "result": {
    "success": {}
  }
}

HTTP request

POST https://www.integratorhost.example.com/v1/payment-integrator-authenticated-card-fop-api/getAuthenticateResult

Request body

The request body contains data with the following structure:

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

object (RequestHeader)

REQUIRED: Common header for all requests.

authenticateRequestId

string

REQUIRED: The requestId from the authenticate call in question.

Response body

If successful, the response body contains data with the following structure:

Response object for the payment integrator hosted getAuthenticateResult method.

JSON representation
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (AuthenticateResultCode)
  },
  "eci": string
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

object (AuthenticateResultCode)

REQUIRED: The final result of the request to payment-integrator-authenticated-card-fop-api.authenticate the user.

eci

string

OPTIONAL: The Electronic Commerce Indicator returned for the request. It should be returned if available.

AuthenticateResultCode

Result codes for the authenticate request that this getAuthenticateResult is referencing.

JSON representation
{

  // Union field authenticate_result_code can be only one of the following:
  "success": {
    object (Empty)
  },
  "unableToAuthenticate": {
    object (Empty)
  },
  "attempted": {
    object (Empty)
  }
  // End of list of possible types for union field authenticate_result_code.
}
Fields
Union field authenticate_result_code. Result codes for the authenticate request that this getAuthenticateResult is referencing. authenticate_result_code can be only one of the following:
success

object (Empty)

A successful authentication. A payment can now be made with a reserveFunds or capture request.

unableToAuthenticate

object (Empty)

The attempt to authenticate the user failed.

attempted

object (Empty)

An attempt was made to authenticate the user. The results are inconclusive. Since the results are inconclusive, Google will attempt a reserveFunds or capture request.