API message formats

Bud’s platform is made available through Application Programming Interface (API) endpoints, all of which adhere to RESTful principles where possible. Standard HTTP verbs and status codes are used for requests and response statuses. Request and response payloads are JSON encoded data formatted. Communication with the Bud Platform is handled over HTTPS protocol only.

Data TypeStandard
Strings encodingUTF-8
DatetimeISO 8601
Currency codesISO 4217

HTTP Verbs

VerbUsage Context
GETUsed to retrieve the resource representation or metadata
POSTUsed to create a new resource on the server
PUTUsed to update the resource state
PATCHUsed to partially update a resource
DELETEUsed to delete the resource

HTTP Response Codes

Code ClassDescription
1XXInformational - provisional response from the server
2XXSuccess - the request has been processed successfully by the server
4XXClient Error - the request has not been processed due to client-side issue with the request
5XXServer Error - the request has not been processed due to server-side issue

If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.