Skip to main content
GET
/
api
/
v3
/
deposit
/
bank
/
checkout
/
status
/
{reference_id}
Get Deposit status
curl --request GET \
  --url https://sandbox-api.kotanipay.io/api/v3/deposit/bank/checkout/status/{reference_id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Deposit status retrieved.",
  "data": {
    "id": "5f9b2c7b9c9d6b0017b4e6b1",
    "referenceId": "5f9b2c7b9c9d6b0017b4e6b1",
    "referenceNumber": 1234567890,
    "message": "Deposit request sent successfully",
    "redirectUrl": "https://ozow.co.za/Checkout/...",
    "successUrl": "https://example.com/success",
    "cancelUrl": "https://example.com/cancel",
    "errorUrl": "https://example.com/error",
    "customerKey": "",
    "bankPaymentDetails": {}
  }
}
An integrator can use this endpoint to check the status of a bank checkout deposit transaction.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
reference_id
string
required

Response

​
success
boolean
Example:

true

​
message
string
Example:

"Deposit status retrieved."

​
data
object