API Responses - Errors

BreadPay™ API returns an error response body with the following error structure for all errors except authorization errors (HTTP Status Code - 403)

   "message":"Error Message",
   "reason":"Reason Code",
   "domain": "Domain",
   "metadata": {        
      "key": "value",
      "key1": "value1"

The reason and the domain helps to uniquely identity the error in the BreadPay™ platform. The metadata is a simple property bag, providing additional contextual information about the error which can help in troubleshooting the issue.

Authorization Errors

BreadPay™ API returns 403 Forbidden when invoked without proper authorization with the following error response body:

RBAC: Access Denied