> ## Documentation Index
> Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman Collections

> Download Cashfree Postman collections for payments, payouts, and verification APIs to test endpoints with preconfigured requests and sample data.

Cashfree provides comprehensive Postman collections for all API products, making it easy to test and integrate APIs. Each collection includes pre-configured requests, sample data, and environment variables to get you started.

## Available collections

<CardGroup cols={2}>
  <Card title="Payment Gateway APIs" icon="credit-card" href="https://www.postman.com/cashfreedevelopers/cashfree-apis-v2025-01-01/overview">
    Complete collection for payment processing, orders, refunds, settlement, and subscription APIs.
  </Card>

  <Card title="Payouts APIs" icon="building-columns" href="https://gocashassets.s3.ap-south-1.amazonaws.com/repostmancollection/Cashfree_Payouts_Collection.json.zip">
    Transfer funds and manage company finances through payout APIs.
  </Card>

  <Card title="Secure ID APIs" icon="shield-check" href="https://www.postman.com/cashfreedevelopers/cashfree-secure-id/collection/40140981-e0241e2f-d2f4-4800-b3ae-558275ae7254">
    Identity verification APIs for PAN, Aadhaar, and other document verification services.
  </Card>
</CardGroup>

<Frame>
  <iframe width="100%" height="400" src="https://www.youtube.com/embed/OkzoR7K3yxw?enablejsapi=1" title="Testing in Postman" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen style={{ maxWidth: '100%', aspectRatio: '16/9' }} />
</Frame>

<p style={{ textAlign: 'center', fontSize: '14px', marginTop: '8px', color: '#666' }}>
  Testing APIs in Postman
</p>

## Getting started

To import a Postman collection, choose your preferred method:

<Tabs>
  <Tab title="Fork Collection (Recommended)">
    1. Click on any collection link above.
    2. Click the **Fork** button in Postman.
    3. Choose your workspace.
    4. The collection will be available in your workspace with automatic updates.
  </Tab>

  <Tab title="Download and Import">
    1. Download the collection JSON file from the workspace.
    2. Open Postman.
    3. Click **Import** → **Upload Files**.
    4. Select the downloaded JSON file.
  </Tab>
</Tabs>

To configure your environment variables:

1. Create a new environment in Postman.
2. Add the following variables:
   * `base_url`: Set to `https://sandbox.cashfree.com` (sandbox) or `https://api.cashfree.com` (production)
   * `client_id`: Your Cashfree Client ID
   * `client_secret`: Your Cashfree Client Secret
   * `x-api-version`: API version (for example, `2025-01-01`)

<Warning>
  Never share your production credentials. Use sandbox credentials for testing and development.
</Warning>

The following examples show the environment variable configuration for both environments:

Sandbox:

```json theme={"dark"}
{
  "base_url": "https://sandbox.cashfree.com",
  "client_id": "your_sandbox_client_id",
  "client_secret": "your_sandbox_client_secret",
  "x-api-version": "2025-01-01"
}
```

Production:

```json theme={"dark"}
{
  "base_url": "https://api.cashfree.com",
  "client_id": "your_production_client_id",
  "client_secret": "your_production_client_secret",
  "x-api-version": "2025-01-01"
}
```

To test your first request:

1. Select your environment from the dropdown in the top-right corner.
2. Choose a simple request like "Get Order" or "Create Order."
3. Review the request parameters and body.
4. Click **Send** to execute the request.

## Features and best practices

Each Postman collection includes the following features:

* Pre-configured requests with correct HTTP methods and headers.
* Sample request bodies with placeholder data.
* Environment variables for dynamic URLs and authentication.
* Example data including test card numbers and mock account details.
* Test scripts for automatic response validation.

Collections automatically handle authentication using your credentials. Tokens are generated and refreshed as needed, so you don't need to manually manage authorisation headers.

Use environment variables for dynamic data, update placeholder values with real test data, and keep sensitive information in environment variables rather than in requests.

Review response status codes and error messages, check the **Tests** tab for automated validations, and use the **Console** view to debug request/response details.

## Troubleshooting common issues

The following are common Postman collection errors and solutions:

<Accordion title="Authentication Failed (401)">
  * Verify your `client_id` and `client_secret` are correct.
  * Ensure you're using the right environment (sandbox vs production).
  * Check that your credentials are active and not expired.
</Accordion>

<Accordion title="Invalid API Version (400)">
  * Confirm the `x-api-version` header is set correctly.
  * Use `2025-01-01` for the latest API version.
  * Check the API documentation for supported versions.
</Accordion>

<Accordion title="Environment Variables Not Working">
  * Ensure you've selected the correct environment.
  * Verify all required variables are defined.
  * Check for typos in variable names (case-sensitive).
</Accordion>

<Accordion title="Request Validation Errors">
  * Review the API documentation for required fields.
  * Check data types and formats in request body.
  * Ensure all mandatory parameters are included.
</Accordion>

## Support

If you need help with Postman collections or API integration, you can use the following resources:

* Documentation: Review the detailed [API documentation](/api-reference/overview).
* Support form: Submit a ticket through the [support form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) for technical assistance.
* Support: Contact the [developer support team](mailto:developers@cashfree.com).
* Community: Join the [developer community](https://discord.gg/ed9VWDnrh7).

<div class="hidden" data-table-of-contents="bottom">
  <p class="mt-4 font-medium flex items-center gap-2 related-docs-heading">
    <svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" class="w-4 h-4">
      <path d="M3 4h7a2 2 0 0 1 2 2v13a2 2 0 0 0-2-2H3z" />

      <path d="M21 4h-7a2 2 0 0 0-2 2v13a2 2 0 0 1 2-2h7z" />
    </svg>

    <span>Related topics</span>
  </p>

  <ul>
    <li><a href="/docs/api-reference/authentication">Authentication Overview</a></li>
    <li><a href="/docs/api-reference/rate-limits">Rate Limits</a></li>
    <li><a href="/docs/api-reference/integration-troubleshooting/overview-ts">Integration Troubleshooting</a></li>
  </ul>
</div>
