POST api/Link

Use this method to authorize a link between a user and your service, allowing your service to post data on their behalf.

Request Information

URI Parameters

None.

Body Parameters

The Authorization Code provided by the user and the App Id supplied by your service.

Link
NameDescriptionTypeAdditional information
AuthorizationCode

The Authorization Code the user supplies to the provider authorizing them to post transactional information on their behalf. The user generates this code from the main website, not through the API.

globally unique identifier

Required

AppId

The App Id supplied by the provider. This must match an app that belongs to the account that is used to get an authorization token.

globally unique identifier

Required

Request Formats

application/json, text/json

Sample:
{
  "authorizationCode": "a5383f3c-1169-4f55-8d3e-27140d5fb714",
  "appId": "8e66a100-ec2e-4951-b169-eae68e649d79"
}

application/xml, text/xml

Sample:
<Link xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API">
  <AppId>8e66a100-ec2e-4951-b169-eae68e649d79</AppId>
  <AuthorizationCode>a5383f3c-1169-4f55-8d3e-27140d5fb714</AuthorizationCode>
</Link>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The link created, if successful

Link
NameDescriptionTypeAdditional information
AuthorizationCode

The Authorization Code the user supplies to the provider authorizing them to post transactional information on their behalf. The user generates this code from the main website, not through the API.

globally unique identifier

Required

AppId

The App Id supplied by the provider. This must match an app that belongs to the account that is used to get an authorization token.

globally unique identifier

Required

Response Formats

application/json, text/json

Sample:
{
  "authorizationCode": "f79052a4-78ee-47d1-972e-019b917341af",
  "appId": "bbf76533-0c93-4ff2-a87e-02531db57827"
}

application/xml, text/xml

Sample:
<Link xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API">
  <AppId>bbf76533-0c93-4ff2-a87e-02531db57827</AppId>
  <AuthorizationCode>f79052a4-78ee-47d1-972e-019b917341af</AuthorizationCode>
</Link>