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/integrator-base-path/v1/payment-integrator-authenticated-card-fop-api/getAuthenticateResult
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"requestHeader": {
object ( |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
authenticate |
REQUIRED: The |
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 |
|
HTTP 4XX / 5XX Status |
|
GetAuthenticateResultResponse
Response object for the payment integrator hosted getAuthenticateResult
method.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
result |
REQUIRED: The final result of the request to india-cards-v1.authenticate the user. |
eci |
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 |
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 |
A successful authentication. A payment can now be made with a |
unable |
The attempt to authenticate the user failed. |
attempted |
An attempt was made to authenticate the user. The results are inconclusive. Since the results are inconclusive, Google will attempt a |