Response Structure

Sample Response Structure

For Successful requests : 200 OK

Sample Response in JSON

{
  "status": true,
  "message": "string",
  "data": T
}

Name	Type	Description
status	bool	The request status
message	string	Successful response message
data	object (optional)	Extra information feedback. For example, a create account request will return the account number and ID

Note: Postings include additional information in the response. Keep in mind that not every successful "OK" message indicates that the transaction was completed. For instance, a posting request might return a 200 OK (indicating technical success), but the posting response code could also indicate an Insufficient Funds error (a technical failure).

For Failed requests : 4XX and 5XX

Sample Response in JSON

{
  "errors": [
    {
      "statusCode": 0,
      "errorCode": "string",
      "errorMessage": "string"
    }
  ]
}

Name	Type	Description
errors	Array	This is an array of errors returned
statusCode	int	The http status code. For example 401, 500 etc
errorCode	string	custom status code.
errorMessage	string	The reason for the error