---
title: "Check Payment Status"
method: POST
path: "/api/v1/payment/status/"
tags: ["Payment Collection"]
---

# Check Payment Status

`POST /api/v1/payment/status/`

Check payment status using invoice or checkout ID.

## Request body

- PaymentStatus
  - `invoice_id` string, required
  - `checkout_id` string, nullable
  - `signature` string, nullable

## Response `200`

- PaymentResults
  - `invoice` InvoicesSer, required
    - `invoice_id` string, required
    - `state` 'PENDING' | 'PROCESSING' | 'FAILED' | 'CANCELED' | 'PARTIAL' | 'COMPLETE' | 'RETRY' — * `PENDING` - PENDING * `PROCESSING` - PROCESSING * `FAILED` - FAILED * `CANCELED` - CANCELED * `PARTIAL` - PARTIAL * `COMPLETE` - COMPLETE * `RETRY` - RETRY
    - `provider` 'M-PESA' | 'PESALINK' | 'CARD-PAYMENT' | 'GOOGLE-PAY' | 'APPLE-PAY' | 'BITCOIN' | 'BANK-ACH' | 'COOP_B2B', required — * `M-PESA` - M-Pesa * `PESALINK` - PesaLink(Bank KE) * `CARD-PAYMENT` - Card * `GOOGLE-PAY` - Google pay * `APPLE-PAY` - Apple pay * `BITCOIN` - Bitcoin * `BANK-ACH` - Bank ACH * `COOP_B2B` - COOP-Bank Agent
    - `charges` string, decimal
    - `net_amount` string, required
    - `currency` string, required
    - `value` string, decimal, required
    - `account` string, nullable — Depositing account, email or phone number
    - `api_ref` string, nullable — API tracking reference number
    - `clearing_status` string, required
    - `mpesa_reference` string, required
    - `host` string, nullable — Payment origin host i.e domain making the payment
    - `card_info` string, required
    - `retry_count` integer
    - `failed_reason` string, nullable
    - `failed_code` string, nullable
    - `failed_code_link` string, required
    - `created_at` string, date-time, nullable, required
    - `updated_at` string, date-time, nullable, required
  - `meta` PaymentSessionsMinSer, required
    - `id` string, uuid
    - `customer` PaymentCustomersSer, required
      - `customer_id` string, required
      - `phone_number` string, nullable
      - `email` string, email, nullable
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `country` string, nullable
      - `zipcode` string, nullable
      - `provider` union
        - 'M-PESA' | 'PESALINK' | 'CARD-PAYMENT' | 'GOOGLE-PAY' | 'APPLE-PAY' | 'BITCOIN' | 'BANK-ACH' | 'COOP_B2B' — * `M-PESA` - M-Pesa * `PESALINK` - PesaLink(Bank KE) * `CARD-PAYMENT` - Card * `GOOGLE-PAY` - Google pay * `APPLE-PAY` - Apple pay * `BITCOIN` - Bitcoin * `BANK-ACH` - Bank ACH * `COOP_B2B` - COOP-Bank Agent
        - ''
        - unknown
      - `created_at` string, date-time, nullable, required
      - `updated_at` string, date-time, nullable, required
    - `payment_link` PaymentLinksSer, required
      - `id` string, uuid
      - `title` string, required — Payment link title
      - `is_active` boolean
      - `redirect_url` string, uri, nullable — Optional website URL to redirect the client after a successful payment
      - `amount` integer
      - `usage_limit` integer
      - `qrcode_file` string, uri, nullable, required
      - `url` string, required
      - `currency` 'KES' | 'GHS' | 'NGN' | 'UGX' | 'TZS' | 'XAF' | 'XOF' — Supported currencies: - `KES` - Kenyan Shilling (KE) - `GHS` - Ghanaian Cedi (GH) - `NGN` - Nigerian Naira (NG) - `UGX` - Ugandan Shilling (UG) - `TZS` - Tanzanian Shilling (TZ) - `XAF` - Central African CFA Franc (CM) - `XOF` - West African CFA Franc (BF, CI)
      - `mobile_tarrif` 'BUSINESS-PAYS' | 'CUSTOMER-PAYS' — * `BUSINESS-PAYS` - Business Pay Charges * `CUSTOMER-PAYS` - Customer Pay Charges
      - `card_tarrif` 'BUSINESS-PAYS' | 'CUSTOMER-PAYS' — * `BUSINESS-PAYS` - Business Pay Charges * `CUSTOMER-PAYS` - Customer Pay Charges
      - `created_at` string, date-time, nullable, required
      - `updated_at` string, date-time, nullable, required
    - `customer_comment` string, nullable
    - `created_at` string, date-time, nullable, required
    - `updated_at` string, date-time, nullable, required

---

[API](https://skmtc.dev/intasend/apis/intasend-api.md) · [All operations](https://skmtc.dev/intasend/apis/intasend-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/intasend/intasend-api/revisions/9fd63286a2c8/schema)
