Method: initiateAggregatorAuthentication

Re-invokes the authentication between the Partner and the Aggregator. During the partner account linking (i.e. linkUserAccount), aggregatorAccountLinkingId was forwarded to the aggregator by the partner. The partner-user-account-linking-v1.initiateAggregatorAuthentication request is only triggered for re-attempts to associate the eWallet or for eWallets added asynchronously after the initial linking step. Following Google's partner-user-account-linking-v1.initiateAggregatorAuthentication request, the Partner resends the original aggregatorAccountLinkingId to the Aggregator to maintain the context of SAAL account linking.

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": "randomRequestId67890",
    "requestTimestamp": {
      "epochMillis": "1481899949606"
    },
    "paymentIntegratorAccountId": "GoldenPartner123"
  },
  "linkUserAccountRequestId": "qierozie12345",
  "aggregatorAccountLinkingId": "randomAggregatorAccountLinkingId123"
}

An example response looks like:


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

HTTP request

POST https://www.integratorhost.example.com/integrator-base-path/partner-user-account-linking-v1/initiateAggregatorAuthentication

Request body

The request body contains data with the following structure:

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

object (RequestHeader)

REQUIRED: Common header for all requests.
aggregatorAccountLinkingId

string

REQUIRED: An extra account linking ID that is generated for Partners that have an Aggregator between Google and the Partner for 1P e-Wallet payments. The purpose is to keep the real linkUserAccountRequestId private from the Aggregator.

When Google calls the e-Wallet FOP associateAccount method at the Aggregator, Google will pass this ID to the Aggregator instead of the authenticationRequestId because the authentication step was completed by the partner-user-account-linking-v1.linkUserAccount call.

This is a string that has a max length of 100 characters, and contains only the characters "a-z", "A-Z", "0-9", ":", "-", and "_".

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 (InitiateAggregatorAuthenticationResponse)
HTTP 4XX / 5XX Status

object (ErrorResponse)

InitiateAggregatorAuthenticationResponse

Response object for the initiateAggregatorAuthentication method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (InitiateAggregatorAuthenticationResult)

REQUIRED: Contains the result of the request.

InitiateAggregatorAuthenticationResult

Contains the result of the request.

JSON representation 
{

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

object (Empty)

Aggregator authentication for the user account was successfully processed.
userAccountUnlinked

object (Empty)

Declined because the user's account has been unlinked.