---
title: "List Payment requests"
method: GET
path: "/api/v1/payment-requests/"
tags: ["Payment Requests"]
---

# List Payment requests

`GET /api/v1/payment-requests/`

PayRequests API

## Query parameters

- `archived` boolean
- `checkout__amount` number
- `checkout__currency` string
- `checkout__email` string
- `page` integer
- `reminder_sent` boolean
- `sent_status` 'CLICKED' | 'DELIVERED' | 'FAILED' | 'OPENED' | 'PENDING' | 'SENT'

## Response `200`

- PaginatedPayRequestsSerList
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` PayRequestsSer[], required
    - `request_id` string, required
    - `checkout` CheckoutSer, required
      - `id` string, uuid, required
      - `url` string, required
      - `signature` string, required
      - `methods` string, required
      - `layout` string, required
      - `styles` string, required
      - `merchant_name` string, required
      - `merchant_id` string, required
      - `merchant_origin` string, required
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `phone_number` string, nullable
      - `email` string, email, nullable
      - `country` string, nullable
      - `address` string, nullable
      - `city` string, nullable
      - `state` string, nullable
      - `zipcode` string, nullable
      - `api_ref` string, nullable
      - `wallet_id` string, nullable
      - `method` 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
      - `channel` 'WEBSITE' | 'WOOCOMMERCE' | 'SHOPIFY' | 'WORDPRESS' | 'BUBBLE' | 'MOBILE' — * `WEBSITE` - WEBSITE * `WOOCOMMERCE` - WOOCOMMERCE * `SHOPIFY` - SHOPIFY * `WORDPRESS` - WORDPRESS * `BUBBLE` - BUBBLE * `MOBILE` - MOBILE
      - `host` string, uri, nullable
      - `is_mobile` boolean
      - `version` string, nullable, required
      - `redirect_url` string, uri, nullable
      - `amount` string, decimal
      - `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)
      - `paid` boolean, required
      - `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
      - `bitcoin_tarrif` 'BUSINESS-PAYS' | 'CUSTOMER-PAYS' — * `BUSINESS-PAYS` - Business Pay Charges * `CUSTOMER-PAYS` - Customer Pay Charges
      - `ach_tarrif` 'BUSINESS-PAYS' | 'CUSTOMER-PAYS' — * `BUSINESS-PAYS` - Business Pay Charges * `CUSTOMER-PAYS` - Customer Pay Charges
      - `bank_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
    - `sent_status` 'PENDING' | 'SENT' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'FAILED' — * `PENDING` - Pending * `SENT` - Request sent * `DELIVERED` - Email delivered * `OPENED` - Email opened * `CLICKED` - Paylink clicked * `FAILED` - Failed
    - `reason` string, required — Payment reason
    - `autosend_remider` 0 | 1 | 2 | 3 | 7 — * `0` - Do not send * `1` - After a day * `2` - After two days * `3` - After three day * `7` - After a week
    - `autosend_remider_datetime` string, date-time, nullable
    - `reminder_sent` boolean
    - `archived` boolean
    - `failed_details` 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)