Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kushki Transfer API

Bank-rail transfer charges

Kushki Transfer API is one of 12 APIs that Kushki publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Transfer. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a JSON-LD context, and 2 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 3 base URLs: https://api.kushkipagos.com, https://api-uat.kushkipagos.com, https://api-stg.kushkipagos.com.

3 operations 3 paths 6 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.kushkipagos.com
Authentication
API Key, API Key
Contact
Resource Areas
1

Authentication & Security 2

Kushki Transfer API declares 2 security schemes for authenticating requests. An API key is passed in the header as Public-Merchant-Id (PublicMerchantId). An API key is passed in the header as Private-Merchant-Id (PrivateMerchantId). By default, every request must be authenticated.

  • PublicMerchantId — Client-side merchant key. Used by Kushki.js and mobile SDKs to tokenize cards. Never use server-side for charging.
  • PrivateMerchantId — Server-side merchant key. Required for charge, capture, void, refund, subscription, and payout calls.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Transfer 3

Bank-rail transfer charges

POST
/transfer/v1/init
Kushki Initialize Transfer Charge
initTransferCharge body → 2004XX
POST
/transfer/v1/charge
Kushki Confirm Transfer Charge
confirmTransferCharge body → 200
GET
/transfer/v1/charges/{ticketNumber}
Kushki Get Transfer Charge
getTransferCharge 1 param → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are TransferInitRequest (9 properties), TransferChargeResponse (6 properties), TransferInitResponse (5 properties), Amount (5 properties). Each schema is shown below with its type and property counts.

TransferChargeResponse
object
6 properties
TransferInitRequest
object
9 properties 3 required
Amount
object
5 properties 4 required
TransferInitResponse
object
5 properties
Error
object
2 properties
TransferChargeRequest
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kushki-transfer-api-openapi.yml Raw ↑

Other APIs Kushki publishes across the network.

Kushki Subscriptions API
Kushki Payouts API
Kushki Webhooks
Kushki Branches API
Kushki Card Present Charges API
Kushki Cash API
Kushki Charges API
Kushki Pre-Authorization API
Kushki Terminals API
Kushki Tokens API
Kushki Voids and Refunds API