Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetAccountLink

Retrieves account link information.

Request Syntax


{
   "LinkedAccountId": "string",
   "LinkId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

LinkedAccountId

The identifier of the account link

Type: String

Pattern: ^\d{12}$

Required: No

LinkId

The identifier of the account to link.

Type: String

Pattern: ^link-.{8,24}$

Required: No

Response Syntax


{
   "AccountLink": { 
      "AccountLinkId": "string",
      "AccountLinkStatus": "string",
      "SourceAccountId": "string",
      "TargetAccountId": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AccountLink

The account link of the account link to retrieve.

Type: AccountLink object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InternalServerException

Unexpected server error occured.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

ValidationException

You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.

HTTP Status Code: 400