Method: gsp.carrier-wallets-v1.authenticationResultNotification

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

Completes an authentication request that was triggered by Google in a different context that cannot receive a synchronous response from the vendor. For instance, an authentication based on sending an SMS from the user's device.

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

Responses to this query may be empty if this method does not return an HTTP 200. The response body is empty in situations where an ErrorResponse with a clear description could be used to help an attacker understand the payment integrator account identifier of other integrators. In these situations, where either the signing key doesn't match, the payment integrator identifier was not found, or the encryption key was unknown, this method will return an HTTP 404 with an empty body. If the request signature could be verified, additional information regarding the error will be returned in the response body.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1
    },
    "requestId": "8c700b9e-62d4-11e9-a923-1681be663d3e",
    "requestTimestamp": {
      "epochMillis": "1502545413026"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "authenticationRequestId": "Y382JCD7FK5U1356168QNAJHBTDGADAGGD",
  "result": {
    "success": {}
  }
}

An example response looks like:


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

HTTP request

POST https://vgw.googleapis.com/gsp/carrier-wallets-v1/authenticationResultNotification/:PIAID

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "authenticationRequestId": string,
  "result": {
    object (AuthenticationResult)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

authenticationRequestId

string

REQUIRED: Reflected back to Google by the payment integrator. This is the ID of this particular authentication session. It was originally generated by Google and sent to the payment integrator at the start of the authentication flow.

result

object (AuthenticationResult)

REQUIRED: The result of the authentication attempt.

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 (AuthenticationResultNotificationResponse)

HTTP 4XX / 5XX Status

object (ErrorResponse)

AuthenticationResult

JSON representation
{

  // Union field result can be only one of the following:
  "success": {
    object (Empty)
  },
  "authenticationFailed": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}
Fields

Union field result.

result can be only one of the following:

success

object (Empty)

The user was authenticated successfully.

authenticationFailed

object (Empty)

The user was not authenticated and the current flow should be aborted or authentication should be retried.

AuthenticationResultNotificationResponse

Response object for the authenticationResultNotification method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

object (AuthenticationResultNotificationResult)

REQUIRED: Result of this call.

AuthenticationResultNotificationResult

Result codes for the authenticationResultNotification method.

JSON representation
{
  "success": {
    object (Empty)
  }
}
Fields
success

object (Empty)

The authentication result was successfully processed.