General Payment Links

Checkout general payment link

Changed on Nov 3, 2026

Starts a payment against a general link by collecting the customer email and chosen currency, returning a checkout URL for that specific payment.

post/v1/pay/general/verify/{code}

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/verify/:code/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

codestring required

Code returned when the resource was created.

Request body

localCurrency'NGN' | 'KES' | 'ZAR' | 'GHS' | 'XOF' | 'USD' required

redirectUrlstring required

Example request

{
  "localCurrency": "NGN",
  "customer": {
    "email": "dom@yopmail.com",
    "firstName": "Dom",
    "lastName": "Aba"
  },
  "redirectUrl": "https://merchant.example.com/payments/return"
}

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
  added to the request property allOf list
- breaking
  the request property became required
- breaking
  the request property type changed from object to no type
- breaking
  the response's body type changed from object to no type for status
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- 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