General Payment Links

Create general payment link

Changed on Nov 3, 2026

Creates a reusable link that many customers can pay, choosing their own currency at checkout. Each payment produces its own transaction, so reconcile per transaction rather than per link.

post/v1/pay/general

Request

Base URL
https://api.kyshi.co
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/docs/v1/pay/general/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

feeBearer'MERCHANT' | 'CUSTOMER' required

taxChargeable'INCLUSIVE' | 'EXCLUSIVE' required

taxEnabledboolean required

Example request

{
  "metadata": [
    {
      "name": "Website design",
      "amount": 100,
      "quantity": 1
    }
  ],
  "feeBearer": "CUSTOMER",
  "taxChargeable": "EXCLUSIVE"
}

Response

Success.

statusboolean required

true on success.

messagestring required

codenumber required

Mirrors the HTTP status code.

Example response

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": {}
}

Changes

Nov 3, 20264aed77604588 Revision changes
- breaking
  the request property became required
- breaking
  the request property became required
- breaking
  the request property became required
- breaking
  the response's body type changed from object to no type for status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  the endpoint scheme security ApiKeyAuth was added to the API
- info
  added subschema #2 to the response body allOf list for the response status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history