Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
Overview
Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
Local Development
http://localhost:8083/
Bodyapplication/jsonrequired
External system identifier for the transaction.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier for the owning organization or tenant.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the related payment resource, if any.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/transaction/{transactionId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/transaction/{transactionId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/transaction/{transactionId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"extensions": {},
"externalId": "123e4567-e89b-12d3-a456-426614174000",
"externalReference": "string",
"integrationName": "string",
"isActive": true,
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"paymentId": "123e4567-e89b-12d3-a456-426614174000",
"status": "declined"
}'Transaction replaced successfully
Timestamp when the transaction record was created.
Example: "2025-01-01T00:00:00.000Z"
External system identifier for the transaction.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier for the owning organization or tenant.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the related payment resource, if any.
Example: "123e4567-e89b-12d3-a456-426614174000"
Current status of the transaction.
Enum"declined""accepted""canceled""captured""initiated""error"
Canonical identifier for the transaction.
Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "externalId": "123e4567-e89b-12d3-a456-426614174000", "externalReference": "string", "integrationName": "string", "isActive": true, "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "paymentId": "123e4567-e89b-12d3-a456-426614174000", "status": "declined", "transactionId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/transaction/{transactionId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/transaction/{transactionId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/transaction/{transactionId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'