Authentication

Request Header

Including The API Key In The Request Header

This is the recommended approach:

GET /rest/v2/transactions HTTP 1.1
Host: gateway-sb.clearent.net
Accept: application/xml
api-key: YOURAPIKEYHERE

Request Element

Including The API Key In The Request Element

Optionally, you may authenticate by including an API Key element inside the main object in the request body.

XML

JSON

Response

XML

JSON

Request Failed

Response to expect if authentication fails.

XML

JSON