Skip to main content
POST
/
payment
/
status
Check payment status
curl --request POST \
  --url https://sandbox.kulmipay.com/api/v1/payment/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invoice_id": "<string>",
  "checkout_id": "<string>",
  "signature": "<string>"
}
'
{
  "invoice": {
    "value": "<string>",
    "invoice_id": "<string>",
    "charges": "<string>",
    "net_amount": "<string>",
    "currency": "<string>",
    "account": "<string>",
    "api_ref": "<string>",
    "clearing_status": "<string>",
    "mpesa_reference": "<string>",
    "host": "<string>",
    "retry_count": -1,
    "failed_reason": "<string>",
    "failed_code": "<string>",
    "failed_code_link": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "customer": {
      "customer_id": "<string>",
      "phone_number": "<string>",
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "last_name": "<string>",
      "country": "<string>",
      "zipcode": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "payment_link": {
      "title": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_active": true,
      "redirect_url": "<string>",
      "amount": 0,
      "usage_limit": 0,
      "qrcode_file": "<string>",
      "url": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_comment": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

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

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

Authorizations

Authorization
string
header
default:ISSecretKey_test_xxxxxxxxxxxxxxxx
required

Use your KulmiPay secret key as the Bearer token.

Body

application/json
invoice_id
string
required
Minimum string length: 1
checkout_id
string | null
signature
string | null

Response

200 - application/json
invoice
object
required
meta
object
required