Skip to main content
POST
/
api
/
v3
/
deposit
/
bank
/
checkout
Deposit via bank checkout
curl --request POST \
  --url https://sandbox-api.kotanipay.io/api/v3/deposit/bank/checkout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fullName": "Patrick Oduro",
  "paymentMethod": "CARD",
  "currency": "eg ZAR",
  "referenceId": "gHjvySSAbZSX69Ux0455xqUpenREK3245223452zi",
  "amount": 10,
  "phoneNumber": "+233542885317",
  "callbackUrl": "https://example.com",
  "customerRedirectUrl": "https://example.com/success",
  "idNumber": "9001010000084",
  "forceDefaultMethod": false
}
'
{
  "success": true,
  "message": "Checkout Created successfully created.",
  "data": {
    "fullName": "Patrick Oduro",
    "paymentMethod": "CARD",
    "currency": "eg ZAR",
    "referenceId": "gHjvySSAbZSX69Ux0455xqUpenREK3245223452zi",
    "amount": 10,
    "phoneNumber": "+233542885317",
    "callbackUrl": "https://example.com",
    "customerRedirectUrl": "https://example.com/success",
    "idNumber": "9001010000084",
    "forceDefaultMethod": false
  }
}
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:

"Patrick Oduro"

​
paymentMethod
enum<string>
required

Payment Method (PAYBYBANK, CARD, MASTERPASS)

Available options:
PAYBYBANK,
CARD,
MASTERPASS
Example:

"CARD"

​
currency
enum<string>
required

ZAR is currently supported

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"

​
referenceId
string
required

reference id

Example:

"gHjvySSAbZSX69Ux0455xqUpenREK3245223452zi"

​
amount
number
required

amount to deposit

Example:

10

​
phoneNumber
string

Customer Phone Number

Example:

"+233542885317"

​
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