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",
  "phoneNumber": "+233542885317",
  "paymentMethod": "CARD",
  "currency": "eg ZAR",
  "referenceId": "gHjvySSAbZSX69Ux0455xqUpenREK3245223452zi",
  "amount": 10,
  "callbackUrl": "https://example.com/webhook",
  "successUrl": "https://example.com/success",
  "cancelUrl": "https://example.com/cancel",
  "errorUrl": "https://example.com/error",
  "customerRedirectUrl": "https://example.com/success",
  "country": "NG"
}
'
{
  "success": true,
  "message": "Checkout Created successfully created.",
  "data": {
    "fullName": "Patrick Oduro",
    "phoneNumber": "+233542885317",
    "paymentMethod": "CARD",
    "currency": "eg ZAR",
    "referenceId": "gHjvySSAbZSX69Ux0455xqUpenREK3245223452zi",
    "amount": 10,
    "callbackUrl": "https://example.com/webhook",
    "successUrl": "https://example.com/success",
    "cancelUrl": "https://example.com/cancel",
    "errorUrl": "https://example.com/error",
    "customerRedirectUrl": "https://example.com/success",
    "country": "NG"
  }
}
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"

​
phoneNumber
string
required

Customer Phone Number

Example:

"+233542885317"

​
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

​
callbackUrl
string

callback url for webhook notifications

Example:

"https://example.com/webhook"

​
successUrl
string

success redirect url where customer is redirected after successful payment

Example:

"https://example.com/success"

​
cancelUrl
string

cancel redirect url where customer is redirected if payment is cancelled

Example:

"https://example.com/cancel"

​
errorUrl
string

error redirect url where customer is redirected on payment error

Example:

"https://example.com/error"

​
customerRedirectUrl
string

customer redirect url

Example:

"https://example.com/success"

​
country
string

Country code

Example:

"NG"

Response

​
success
boolean
Example:

true

​
message
string
Example:

"Checkout Created successfully created."

​
data
object