Transactions

Charge transaction

Changed on Nov 3, 2026

Creates a transaction the customer pays by bank transfer, returning payment instructions instead of a checkout URL. The customer enters the amount themselves, so underpayment and overpayment are possible.

post/v1/transactions/charge

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

Request body

emailstring required

firstNamestring required

lastNamestring required

phoneNumberstring required

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

referencestring required

channelsstring[] required

amountnumber required

amountCurrency'settlement' | 'local'

How to interpret 'amount'. Defaults to 'settlement' for backward compatibility.

metadataobject required

redirectUrlstring required

feeBearer'MERCHANT' | 'CUSTOMER' required

taxChargeable'INCLUSIVE' | 'EXCLUSIVE' required

chargeType'BANK_TRANSFER' required

expiresAtstring required

Example request

{
  "email": "dom@yopmail.com",
  "firstName": "Dom",
  "lastName": "Aba",
  "phoneNumber": "2250734567890",
  "localCurrency": "XOF",
  "reference": "ORDER-100045",
  "channels": [
    "mobile_money"
  ],
  "amount": 1000,
  "amountCurrency": "local",
  "metadata": {
    "orderId": "ORDER-100045",
    "source": "checkout"
  },
  "redirectUrl": "https://merchant.example.com/payments/return",
  "feeBearer": "CUSTOMER",
  "taxChargeable": "EXCLUSIVE",
  "chargeType": "BANK_TRANSFER",
  "expiresAt": "2026-09-30T23:59:59Z"
}

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