---
title: "Checkout general payment link"
method: POST
path: "/v1/pay/general/verify/{code}"
tags: ["General Payment Links"]
---

# Checkout general payment link

`POST /v1/pay/general/verify/{code}`

## Request

- Base URL: `https://api.kyshi.co`
- URL: `https://api.kyshi.co/v1/pay/general/verify/{code}`
- 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)

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

## Path parameters

- `code` string, required

## Request body

- GeneralPaymentLinkCheckoutDto
  - `localCurrency` 'NGN' | 'KES' | 'ZAR' | 'GHS' | 'XOF' | 'USD', required
  - `customer` GeneralCustomerInput, required
    - `email` string, required
    - `firstName` string, required
    - `lastName` string, required
  - `redirectUrl` string, required

## Response `201`

Success.

- object
  - `status` boolean, required: `true` on success.
  - `message` string, required
  - `code` number, required: Mirrors the HTTP status code.
  - `data` object, required: The endpoint-specific payload.
    - `authorizationUrl` string, required
    - `reference` string, required
    - `hostedCheckout` boolean
    - `feeBreakdown` PublicFeeBreakdownDto
      - `fee` number, required
      - `vat` number, required
      - `processorFee` number, required
      - `stampDuty` number, required
      - `allInclusiveKyshiFee` number, required
      - `totalFees` number, required
      - `others` object, required

## Other responses

- `400`: Missing or invalid request parameter.
- `401`: No valid API key provided.
- `403`: The API key lacks permission for this request.
- `404`: Resource not found. A 404 on an object you just created is usually a test/live mode mismatch.
- `422`: Business rule failure, such as an unsupported currency or insufficient balance.
- `500`: Something went wrong on Kyshi’s end.

## Changes

- **2026-11-03** `4aed77604588`: 4 breaking, 8 warning, 8 info
  - added `#/components/schemas/GeneralCustomerInput` to the `customer` request property `allOf` list
  - the request property `redirectUrl` became required
  - the `customer` request property type changed from `object` to no type
  - the response's body type changed from `object` to no type for status `201`
  - …16 more

[Operation history](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/changes/v1/pay/general/verify/:code/post.md)

---

[API](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api.md) - [All operations](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/revisions/4aed77604588?raw)