How to use this site?

API Docs · Quick guide

How to use this documentation

Test endpoints from the page, copy working code and connect your AI assistant. Here is what each tool does and when to use it.

In this guide:Try itCode samplesEnvironmentsExport to PostmanMCP

What you will find on every endpoint page

Every endpoint page has the same structure. The markers on the sample page match the list below.

api-docs.kushkipagos.com/…/request-a-card-tokenMCP7

Card Payments / TokensCopy Page ▾1

Request a card token

EnvironmentUAT Testing Env ▾

POST/card/v1/tokensTry it2▷ Run in Apidog3

Body ParamsGenerate schema code5

cardobjectrequired

totalAmountnumberrequired

currencystringrequired

ShellJavaScriptJava4

Request sample

LLMs.txtCloneExport6

Copy Page, Markdown and AI

Copy the page as Markdown, view it as plain text, or open it in ChatGPT or Claude to ask questions about it.

Use it · When you want an AI assistant to explain an endpoint or write code from it.

Try it

Send a real request to the testing environment from the page, without writing code.

Use it · To check that your keys and request work before you code.

Run in Apidog

Open the endpoint in the Apidog app to keep testing it there.

Use it · When you want to save requests and build your own collection.

Code samples

Ready-to-copy requests in several languages: Shell, JavaScript, Java and more.

Use it · As the starting point of your integration.

Generate schema code

Generate the data model of the request or response in the language you choose, for example TypeScript.

Use it · To get typed models instead of writing them by hand.

Export, Clone and LLMs.txt

Export downloads the documentation as OpenAPI (3.1, 3.0 or Swagger 2.0), HTML, Markdown or Apidog format. Clone copies it into your own Apidog project. LLMs.txt is the index of the whole documentation for AI tools.

Use it · Use Export to import the API into Postman or another tool.

MCP

Connect your AI assistant (Claude, Cursor, VS Code and others) to the official Kushki documentation, so it answers with the current endpoints. See MCP Integration.

Use it · If you build with an AI assistant. It needs no Kushki credentials.

Choose the right environment

The selector above the endpoint defines where Try it sends the request. It changes with the product and each environment has its own credentials: pick the one that matches the page you are on.

UAT Testing EnvTesting

Testing for Online Payments and most Kushki APIs. This is the default.

https://api-uat.kushkipagos.com

API — ProducciónReal money

Real transactions. Use it only after certification, with production credentials.

https://api.kushkipagos.com

Kushki ONE Cloud — UATTesting

Testing for Kushki ONE (terminals) through the cloud.

https://uat-cloudt.kushkipagos.com

Kushki ONE Cloud — ProducciónReal money

Kushki ONE in production, through the cloud.

https://cloudt.kushkipagos.com

Kushki ONE LocalTesting

Talks to a terminal on your local network. Replace {{terminalIp}} and {{port}} with your terminal's values.

http://{{terminalIp}}:{{port}}

Appian — UATTesting

Testing for the Appian endpoints.

https://core-uat-us-east-1.kushkipagos.com

Billpocket — Legacy v2 / E-commerce FlexTesting

Billpocket products. They have their own credentials: Kushki keys do not work here.

Check the environment before you press Send

If the endpoint belongs to Kushki ONE, Appian or Billpocket, the selector must show its own environment. A request sent to the wrong environment fails or never reaches the product.

Try the API with Try it in 4 steps

Check the environment

Make sure the selector shows the testing environment for your product. For Online Payments it is UAT Testing Env: no real money moves.

Add your credentials

Paste your Public Key in the Public-Merchant-Id header. Endpoints that charge or refund use your Private Key in Private-Merchant-Id; the page tells you which one it needs.

Review the body and press Send

The sample body already contains test data. Edit it or send it as it is.

Read the response

A successful request returns 201 and the response body, for example a token. Errors show their code and message so you can fix the request.

Where do I find my keys?

In your Kushki Console, inside the Credentials section. They are labeled Public Key and Private Key. Use testing credentials in Try it, and never share your Private Key or a screen where it is visible.

Use the API in Postman

Click Export at the bottom of any endpoint page.

Choose OpenAPI Spec (version 3.1 or 3.0) and click Export.

In Postman, choose Import and select the downloaded file.

Read any page as Markdown

Add .md to the end of the address of any page to get its content as plain text. The full index is at /llms.txt.

I want to…

Try a request without writing codeTry it

Get a working snippetCode samples

Ask an AI about the APICopy PageOpen in ClaudeMCP

Use the API in Postman or another toolExport (OpenAPI)

Integrate with a libraryLibraries (SDKs)

Need help?

Our team supports you at every step of your integration.

See MCP Integration Support Center ↗

What you will find on every endpoint page#

Choose the right environment#

Try the API with Try it in 4 steps#

Use the API in Postman#

Read any page as Markdown#

I want to…#

What you will find on every endpoint page

Choose the right environment

Try the API with Try it in 4 steps

Use the API in Postman

Read any page as Markdown

I want to…