Skip to main content
POST
/
api
/
v3
/
deposit
/
bank
/
checkout
Deposit via bank checkout
curl --request POST \
  --url https://sandbox-api.kotanipay.com/api/v3/deposit/bank/checkout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fullName": "John Doe",
  "paymentMethod": "PAYBYBANK",
  "currency": "eg ZAR",
  "amount": 10,
  "phoneNumber": "+245XXXXXXXXX",
  "country": "<string>",
  "referenceId": "5f9b2c7b9c9d6b0017b4e6b1",
  "callbackUrl": "https://example.com",
  "customerRedirectUrl": "https://example.com/success",
  "idNumber": "9001010000084",
  "forceDefaultMethod": false
}
'
{
  "success": true,
  "message": "Checkout Created successfully created.",
  "data": {
    "fullName": "John Doe",
    "paymentMethod": "PAYBYBANK",
    "currency": "eg ZAR",
    "amount": 10,
    "phoneNumber": "+245XXXXXXXXX",
    "country": "<string>",
    "referenceId": "5f9b2c7b9c9d6b0017b4e6b1",
    "callbackUrl": "https://example.com",
    "customerRedirectUrl": "https://example.com/success",
    "idNumber": "9001010000084",
    "forceDefaultMethod": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.kotanipay.com/llms.txt

Use this file to discover all available pages before exploring further.

Customer completed transaction using checkout URL. This endpoint allows customers to deposit funds via bank checkout.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
fullName
string
required

full name

Example:

"John Doe"

​
paymentMethod
enum<string>
required

Payment Method

Available options:
PAYBYBANK,
CARD,
CAPITECPAY
Example:

"PAYBYBANK"

​
currency
enum<string>
required

Transaction currency

Available options:
KES,
GHS,
NGN,
ZAR,
ZAR,
USD,
XOF,
ZMW,
XAF,
SLE,
CDF,
TZS,
UGX,
EGP,
MWK,
RWF,
ETB,
MZN,
LSL,
GNF,
USDT,
BTC,
ETH,
USDC
Example:

"eg ZAR"

​
amount
number
required

amount to deposit

Example:

10

​
phoneNumber
string

Customer Phone Number

Example:

"+245XXXXXXXXX"

​
country
string

Country where the wallet is used (optional if derivable from currency) - Cards are accepted globally

​
referenceId
string

reference id

Example:

"5f9b2c7b9c9d6b0017b4e6b1"

​
callbackUrl
string

callback url

Example:

"https://example.com"

​
customerRedirectUrl
string

customer redirect url

Example:

"https://example.com/success"

​
idNumber
string

Customer national ID number (required for Capitec Pay in South Africa - 13 digit SA ID)

Example:

"9001010000084"

​
forceDefaultMethod
boolean

When true, force the payment method specified in paymentMethod to be the only option presented to the customer (no switching allowed). Passed to the provider as forceDefaultMethod where supported.

Example:

false

Response

​
success
boolean
Example:

true

​
message
string
Example:

"Checkout Created successfully created."

​
data
object