Glossary

This section serves as a comprehensive guide to help merchants understand the conventions and terminologies used throughout the API documentation. It aims to clarify the meanings of specific terms, the format of responses, and the conditions under which various HTTP status codes are returned by the server. This page is essential for developers interacting with the Krepling Pay API, as it provides the foundational knowledge needed to effectively parse responses, handle errors, and comprehend the requirements for successfully making requests to the API.

Conventions

This section outlines the standard practices and rules applied in the Krepling Pay API documentation, including how merchants should interpret the API responses, the format of these responses, and the handling of request parameters.

• Client/Merchant: Refers to the client application that interacts with the API.

• Status: Represents the HTTP status code of the response received from the server.

• Responses: Each method has predefined response scenarios, but only one response is issued per request by the server.

• JSON Format: All responses from the API are provided in JSON format.

• Mandatory Parameters: All request parameters are considered mandatory unless marked as [optional].

• Parameter Values: The type of values accepted for a request parameter are specified. For example, [10|<any number>] indicates either the number 10 or any other number. [optional] parameters will have their default values highlighted in blue bold text.

Status Codes

This section categorizes and explains the HTTP status codes that the Krepling Pay API might return. This includes success codes (2XX), merchant error codes (4XX), and server error codes (5XX), each indicating different outcomes or issues encountered during the API request and response cycle.

Status codes follow standard HTTP status codes to indicate the outcome of an API request:

• 2XX: Indicates success of some kind.

• 4XX: Indicates an error occurred on the client’s part.

• 5XX: Indicates an error occurred on the server’s part.

200 OK	The request was successful.
201 Created	A new resource has been created successfully.
202 Accepted	The request has been accepted and queued for execution.
400 Bad Request	The server could not understand the request due to invalid syntax.
401 Authentication Failure	The request has not been applied because it lacks valid authentication credentials for the target resource.
403 Forbidden	The server understood the request but refuses to authorize it.
404 Resource Not Found	The server can't find the requested resource.
405 Method Not Allowed	The request method is known by the server but has been disabled and cannot be used.
409 Conflict	The request could not be completed due to a conflict with the current state of the target resource.
412 Prediction Failure	The server does not meet one of the preconditions that the requester put on the request.
413 Request Entity Too Large	The request is larger than the server is willing or able to process.
500 Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request.
501 Not Implemented	The server does not support the functionality required to fulfill the request.
503 Service Unavailable	The server is not ready to handle the request, often due to maintenance or overload.