Responses

HTTP Status Codes

Walapay API calls return HTTP status codes. Some API calls also return JSON response bodies that include information about the resource, including one or more contextual HATEOAS links. Use these links to request more information about and construct an API flow that is relative to a specific request. Each REST API request returns an HTTP status code.

Successful Requests

For successful requests, Walapay returns HTTP 2XX status codes.

Status Code	Description
200 OK	The request succeeded.
201 Created	A `POST` method successfully created a resource. If the resource was already created by a previous execution of the same method, for example, the server returns the HTTP `200 OK` status code.
202 Accepted	The server accepted the request and will execute it later.
204 No Content	The server successfully executed the method but returns no response body.

Failed Requests

For failed requests, Walapay returns HTTP 4XX status codes if something passed in the request has an error or 5XX status codes when something is wrong on our end with a server or service.

HTTP 4XX Status Codes

Status Code	Description	Possible Causes and Solutions
400 Bad Request	INVALID_REQUEST*. Request is not well-formed, syntactically incorrect, or violates schema.	The server could not understand the request. Indicates one of these conditions: • The API cannot convert the payload data to the underlying data type. • The data is not in the expected data format. • A required field is not available. • A simple data validation error occurred.
401 Unauthorized	INVALID_REQUEST*. API Key is missing from request header.	API Key is missing from request header.
403 Forbidden	ACCESS_DENIED*. The specified resource does not belong to you.	The request requires access to a resource that does not belong to the requestor.
404 Not Found	RESOURCE_NOT_FOUND*. The specified resource does not exist.	The server did not find anything that matches the request URI. Either the URI is incorrect or the resource is not available. For example, no data exists in the database at that key.
406 Not Acceptable	MEDIA_TYPE_NOT_ACCEPTABLE*. The server does not implement the media type acceptable to the client.	The server cannot use the client-request media type to return the response payload. For example, this error occurs if the client sends an `Accept: application/xml` request header but the API can generate only an `application/json` response.
409 Conflict	RESOURCE_CONFLICT*. Request cannot be processed as it conflicts with another request.	The API cannot complete the requested action as it conflicts with another request that is currently being processed. Retry the request later.
415 Unsupported Media Type	UNSUPPORTED_MEDIA_TYPE*. The server does not support the request payload's media type.	The API cannot process the media type of the request payload. For example, this error occurs if the client sends a `Content-Type: application/xml` request header but the API can only accept `application/json` request payloads.
422 Unprocessable Entity	UNPROCESSABLE_ENTITY*. The API cannot complete the requested action, or the request action is semantically incorrect or fails business validation.	The API cannot complete the requested action and might require interaction with APIs or processes outside of the current request. No systemic problems limit the API from completing the request. For example, this error occurs for any business validation errors, including errors that are not usually of the `400` type.
429 Too Many Requests	RATE_LIMIT_REACHED*. Too many requests. Blocked due to rate limiting.	The rate limit for the user, application, or token exceeds a predefined value.

HTTP 5XX Status Codes

Status Code	Description	Possible Causes and Solutions
500 Internal Server Error	INTERNAL_SERVER_ERROR. An internal server error has occurred.	A system or application error occurred. Although the client appears to provide a correct request, something unexpected occurred on the server.
503 Service Unavailable	SERVICE_UNAVAILABLE. Service Unavailable.	The server cannot handle the request for a service due to temporary maintenance.