Introduction

API v2.1.01·[email protected]·Apache 2.0·Terms of service·Download OpenAPI (.yaml)·Markdown docs (AI) 🤖·Postman collection 🚀

New: You can do live tests of our APITests

Welcome to the Payku API. You can use our API to access the different Payku endpoints, where you can generate and manage payments through different methods and get information from them.

The API is organized around REST. It has predictable URLs and resource-oriented, and uses HTTP response codes to indicate the result of the call. All API responses return objects JSON, including errors.

User should look for a 200 result code. If received any result code other than 200, the request, or the response is invalid, which means that the fields did not pass the checks of validation from payku. We use features included in the HTTP protocol, such as authentication, which are supported by the most HTTP clients.

Important — How to tell if an operation failed

Do not rely only on the HTTP status code (for example, 200). In our API, many error responses also return HTTP 200. This is intentional and part of how the API is designed.

Always read the JSON response body and check the status field:

• If status is "success", the operation completed successfully.
• If status is "failed", there was an error (for example, invalid data or a rejected operation). Also check the error message included in the same response.