Method: unlinkUserAccount

  • This API endpoint facilitates the unlinking of a Google User account from a Partner User account, using a POST request to the specified URL.

  • The request body requires a requestHeader object and a linkUserAccountRequestId string, which references the requestId from a previous LinkUserAccountRequest.

  • Successful unlinking operations return an UnlinkUserAccountResponse with a responseHeader and a result object indicating success, whereas errors return an ErrorResponse with appropriate HTTP status codes.

  • The unlinking operation is idempotent, meaning that if a request is sent again for an already unlinked account, it will still return a successful response.

  • The response object contains a mandatory response header and a result field, and the type of response can vary depending on whether the request was successful or not.

Unlinks a Google User account from a Partner (Payment Integrator) User account.

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"
}

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/unlinkUserAccount

Request body

The request body contains data with the following structure:

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

object (RequestHeader)

REQUIRED: Common header for all requests.

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

object (ErrorResponse)

UnlinkUserAccountResponse

Response object for the unlinkUserAccount method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (UnlinkUserAccountResult)

REQUIRED: Contains the result of the request.

UnlinkUserAccountResult

Details corresponding to the result.

JSON representation 
{

  // Union field result can be only one of the following:
  "success": {
    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)

Unlinking of the user account was successfully processed. If a request is sent again for a previously unlinked account, success will be returned to respect idempotency.