Kutanapay Merchant API
  1. Merchant Checkout
Kutanapay Merchant API
  • Merchant API Keys
    • Create Api Key
      POST
    • Get Api Keys
      GET
    • Revoke Api Key
      DELETE
  • Merchant Wallet
    • Get All Wallets
      GET
    • Get Wallet Transactions
      GET
    • Process Refund
      POST
    • Get Settlement Batches
      GET
    • Update Wallet Status
      PATCH
    • Get Wallet By Currency
      GET
  • Merchant Customer Transactions
    • Get Merchant Transactions
      GET
    • Get Merchant Transaction
      GET
  • Merchant Checkout
    • Create Checkout
      POST
    • List Checkouts
      GET
    • Get Checkout
      GET
  • Merchant Webhooks
    • Create Webhook
      POST
    • Get Webhooks
      GET
    • Update Webhook
      PUT
    • Delete Webhook
      DELETE
  • Merchant Branding
    • Get Branding
      GET
    • Update Branding
      PUT
  • Merchant Payment Accounts
    • Add Payment Account
      POST
    • Get Payment Accounts
      GET
    • Get Payment Account
      GET
    • Update Payment Account
      PUT
    • Delete Payment Account
      DELETE
  • Merchant Withdrawals
    • Initiate Withdrawal
    • Get Withdrawal History
    • Cancel Withdrawal
    • Get Withdrawal
  • Merchant Payouts
    • Initiate Payout
    • Get Payout History
    • Cancel Payout
    • Get Payout
  1. Merchant Checkout

List Checkouts

GET
/api/v1/merchants/checkouts
Get merchant checkouts

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Query Params

Header Params

Responses

🟢200OK
application/json
Successful Response
Body

🟠422Parameter Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/merchants/checkouts?limit=10&offset=0' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Success
{
    "data": [
        {
            "id": "5e70bd2a-1d15-4e47-a54e-aeb395ddb2a8",
            "merchant_id": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
            "customer_email": "reject.fixed@test.com",
            "customer_name": "Reject Fix Test",
            "customer_phone": null,
            "amount": 30.0,
            "currency_code": "GHS",
            "description": "Testing rejection fix",
            "status": "failed",
            "payment_method": "bank_transfer",
            "payment_reference": "PAY-AWVE0CRD8KZ3",
            "expires_at": "2025-11-17T16:20:14.066282",
            "paid_at": "2025-11-17T16:10:30.125422",
            "completed_at": null,
            "checkout_url": "http://localhost:3000/public/checkouts/PAY-AWVE0CRD8KZ3",
            "redirect_url": null,
            "meta_data": null,
            "approval_status": "rejected",
            "approved_by_admin_id": null,
            "approved_at": null,
            "rejection_reason": "Invalid payment proof - image blurry and unverifiable",
            "admin_notes": "Customer provided screenshot instead of bank receipt",
            "created_at": "2025-11-17T17:10:14.062559",
            "updated_at": "2025-11-17T16:10:34.165921"
        },
        {
            "id": "5aba3db5-c12c-45d2-bf79-91e6407eaba7",
            "merchant_id": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
            "customer_email": "test.ghs@example.com",
            "customer_name": "John Doe GHS",
            "customer_phone": "+233241234567",
            "amount": 100.0,
            "currency_code": "GHS",
            "description": "Test GHS bank transfer payment",
            "status": "completed",
            "payment_method": "bank_transfer",
            "payment_reference": "PAY-6T4DD2NSUOE8",
            "expires_at": "2025-11-17T16:06:18.424713",
            "paid_at": "2025-11-17T15:56:37.261574",
            "completed_at": "2025-11-17T15:57:12.011764",
            "checkout_url": "http://localhost:3000/public/checkouts/PAY-6T4DD2NSUOE8",
            "redirect_url": null,
            "meta_data": {
                "test_phase": "2",
                "payment_type": "bank_transfer"
            },
            "approval_status": "approved",
            "approved_by_admin_id": null,
            "approved_at": "2025-11-17T15:57:12.011759",
            "rejection_reason": null,
            "admin_notes": "Test approval - Phase 2 GHS bank transfer",
            "created_at": "2025-11-17T16:56:18.420602",
            "updated_at": "2025-11-17T15:57:12.011765"
        },
        {
            "id": "2871e8e1-c6be-45bb-854a-311ea6b10879",
            "merchant_id": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
            "customer_email": "webhook.test@example.com",
            "customer_name": "Webhook Test",
            "customer_phone": null,
            "amount": 15.0,
            "currency_code": "GHS",
            "description": "Testing checkout.created webhook",
            "status": "pending",
            "payment_method": null,
            "payment_reference": "PAY-6YFMTRDABEWU",
            "expires_at": "2025-11-17T16:24:11.622202",
            "paid_at": null,
            "completed_at": null,
            "checkout_url": "http://localhost:3000/public/checkouts/PAY-6YFMTRDABEWU",
            "redirect_url": null,
            "meta_data": null,
            "approval_status": "pending_approval",
            "approved_by_admin_id": null,
            "approved_at": null,
            "rejection_reason": null,
            "admin_notes": null,
            "created_at": "2025-11-17T17:14:11.621095",
            "updated_at": "2025-11-17T17:14:11.621095"
        },
        {
            "id": "137bcdbf-87cb-47d8-9808-be255cde04c9",
            "merchant_id": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
            "customer_email": "test.ghs.momo@example.com",
            "customer_name": "Jane Smith GHS",
            "customer_phone": "+233241234568",
            "amount": 50.0,
            "currency_code": "GHS",
            "description": "Test GHS mobile money payment",
            "status": "completed",
            "payment_method": "mobile_money",
            "payment_reference": "PAY-6JZJG1L3Y4OL",
            "expires_at": "2025-11-17T16:07:49.185147",
            "paid_at": "2025-11-17T15:58:01.901378",
            "completed_at": "2025-11-17T15:58:08.400524",
            "checkout_url": "http://localhost:3000/public/checkouts/PAY-6JZJG1L3Y4OL",
            "redirect_url": null,
            "meta_data": {
                "test_phase": "3",
                "payment_type": "mobile_money"
            },
            "approval_status": "approved",
            "approved_by_admin_id": null,
            "approved_at": "2025-11-17T15:58:08.400520",
            "rejection_reason": null,
            "admin_notes": "Test approval - Phase 3 GHS mobile money",
            "created_at": "2025-11-17T16:57:49.184282",
            "updated_at": "2025-11-17T15:58:08.400525"
        },
        {
            "id": "0d2cfd92-c57f-4816-b499-26cc748cea09",
            "merchant_id": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
            "customer_email": "created.webhook@test.com",
            "customer_name": "Created Webhook Test",
            "customer_phone": null,
            "amount": 20.0,
            "currency_code": "GHS",
            "description": "Testing checkout.created webhook after fix",
            "status": "pending",
            "payment_method": null,
            "payment_reference": "PAY-9F4295SQJUHL",
            "expires_at": "2025-11-17T16:25:10.489958",
            "paid_at": null,
            "completed_at": null,
            "checkout_url": "http://localhost:3000/public/checkouts/PAY-9F4295SQJUHL",
            "redirect_url": null,
            "meta_data": null,
            "approval_status": "pending_approval",
            "approved_by_admin_id": null,
            "approved_at": null,
            "rejection_reason": null,
            "admin_notes": null,
            "created_at": "2025-11-17T17:15:10.486941",
            "updated_at": "2025-11-17T17:15:10.486941"
        },
        {
            "id": "59a4daf2-e4fd-47b4-abdb-9ba0fdcba50f",
            "merchant_id": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
            "customer_email": "test.usd@example.com",
            "customer_name": "Bob USD Test",
            "customer_phone": "+12025551234",
            "amount": 75.0,
            "currency_code": "USD",
            "description": "Test USD payment - mobile money should fail",
            "status": "completed",
            "payment_method": "bank_transfer",
            "payment_reference": "PAY-8J549YTLIWBD",
            "expires_at": "2025-11-17T16:11:03.424699",
            "paid_at": "2025-11-17T16:01:26.042483",
            "completed_at": "2025-11-17T16:01:28.904800",
            "checkout_url": "http://localhost:3000/public/checkouts/PAY-8J549YTLIWBD",
            "redirect_url": null,
            "meta_data": {
                "test_phase": "4",
                "validation_test": true
            },
            "approval_status": "approved",
            "approved_by_admin_id": null,
            "approved_at": "2025-11-17T16:01:28.904788",
            "rejection_reason": null,
            "admin_notes": "Test USD approval",
            "created_at": "2025-11-17T17:01:03.422779",
            "updated_at": "2025-11-17T16:01:28.904804"
        },
        {
            "id": "491fbb10-9bc1-48de-8395-ad22ac685914",
            "merchant_id": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
            "customer_email": "debug.webhook@test.com",
            "customer_name": "Debug Test",
            "customer_phone": null,
            "amount": 5.0,
            "currency_code": "USD",
            "description": "Debug webhook test",
            "status": "pending",
            "payment_method": null,
            "payment_reference": "PAY-NRRJFNII1DP5",
            "expires_at": "2025-11-17T16:25:44.211683",
            "paid_at": null,
            "completed_at": null,
            "checkout_url": "http://localhost:3000/public/checkouts/PAY-NRRJFNII1DP5",
            "redirect_url": null,
            "meta_data": null,
            "approval_status": "pending_approval",
            "approved_by_admin_id": null,
            "approved_at": null,
            "rejection_reason": null,
            "admin_notes": null,
            "created_at": "2025-11-17T17:15:44.210210",
            "updated_at": "2025-11-17T17:15:44.210210"
        },
        {
            "id": "16bf6799-bcd1-4493-a57e-2b59904be3cc",
            "merchant_id": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
            "customer_email": "test.ngn@example.com",
            "customer_name": "Chidi NGN Test",
            "customer_phone": "+2348012345678",
            "amount": 200.0,
            "currency_code": "NGN",
            "description": "Test NGN bank transfer",
            "status": "completed",
            "payment_method": "bank_transfer",
            "payment_reference": "PAY-D784S00MWZNP",
            "expires_at": "2025-11-17T16:11:45.287495",
            "paid_at": "2025-11-17T16:02:01.247576",
            "completed_at": "2025-11-17T16:02:02.007406",
            "checkout_url": "http://localhost:3000/public/checkouts/PAY-D784S00MWZNP",
            "redirect_url": null,
            "meta_data": {
                "test_phase": "5"
            },
            "approval_status": "approved",
            "approved_by_admin_id": null,
            "approved_at": "2025-11-17T16:02:02.007403",
            "rejection_reason": null,
            "admin_notes": "Test NGN approval",
            "created_at": "2025-11-17T17:01:45.286769",
            "updated_at": "2025-11-17T16:02:02.007407"
        },
        {
            "id": "9b487f81-5a9f-4796-9820-1a496c6eecaa",
            "merchant_id": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
            "customer_email": "ratelimit@test.com",
            "customer_name": "Rate 1",
            "customer_phone": null,
            "amount": 1.0,
            "currency_code": "GHS",
            "description": "Test 1",
            "status": "pending",
            "payment_method": null,
            "payment_reference": "PAY-MHMCENKXYA6A",
            "expires_at": "2025-11-17T16:13:57.796555",
            "paid_at": null,
            "completed_at": null,
            "checkout_url": "http://localhost:3000/public/checkouts/PAY-MHMCENKXYA6A",
            "redirect_url": null,
            "meta_data": null,
            "approval_status": "pending_approval",
            "approved_by_admin_id": null,
            "approved_at": null,
            "rejection_reason": null,
            "admin_notes": null,
            "created_at": "2025-11-17T17:03:57.795007",
            "updated_at": "2025-11-17T17:03:57.795007"
        },
        {
            "id": "9e0fc3da-e44b-4046-bd9c-d53bfb98f5b4",
            "merchant_id": "7bb54443-6fc9-4a1d-ab46-d787ec90c87f",
            "customer_email": "reject@test.com",
            "customer_name": "Reject Test",
            "customer_phone": null,
            "amount": 25.0,
            "currency_code": "GHS",
            "description": "Rejection test",
            "status": "pending",
            "payment_method": null,
            "payment_reference": "PAY-QUPTF3ED36XX",
            "expires_at": "2025-11-17T16:14:37.068431",
            "paid_at": null,
            "completed_at": null,
            "checkout_url": "http://localhost:3000/public/checkouts/PAY-QUPTF3ED36XX",
            "redirect_url": null,
            "meta_data": null,
            "approval_status": "pending_approval",
            "approved_by_admin_id": null,
            "approved_at": null,
            "rejection_reason": null,
            "admin_notes": null,
            "created_at": "2025-11-17T17:04:37.066862",
            "updated_at": "2025-11-17T17:04:37.066862"
        }
    ],
    "message": "Checkouts retrieved successfully",
    "status": "success"
}
Modified at 2025-11-19 15:12:11
Previous
Create Checkout
Next
Get Checkout
Built with