cashfree-pg


Namecashfree-pg JSON
Version 4.3.10 PyPI version JSON
download
home_pagehttps://cashfree.com
SummaryCashfree Payment Gateway APIs
upload_time2025-01-09 13:03:16
maintainerNone
docs_urlNone
authorCashfree Payments
requires_pythonNone
licenseApache 2.0
keywords payment gateway cashfree sdk payments cashfree payment gateway apis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Cashfree PG Python SDK
![GitHub](https://img.shields.io/github/license/cashfree/cashfree-pg-sdk-python) ![Discord](https://img.shields.io/discord/931125665669972018?label=discord) ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/cashfree/cashfree-pg-sdk-python/master) ![GitHub release (with filter)](https://img.shields.io/github/v/release/cashfree/cashfree-pg-sdk-python?label=latest) ![GitHub forks](https://img.shields.io/github/forks/cashfree/cashfree-pg-sdk-python) ![Order Create API Order Create API](https://statuspage.cashfree.com/badge/pg-create-order-api/status)

The Cashfree PG Python SDK offers a convenient solution to access [Cashfree PG APIs](https://docs.cashfree.com/reference/pg-new-apis-endpoint) from a server-side Go  applications. 



## Documentation

Cashfree's PG API Documentation - https://docs.cashfree.com/reference/pg-new-apis-endpoint

Learn and understand payment gateway workflows at Cashfree Payments [here](https://docs.cashfree.com/docs/payment-gateway)

Try out our interactive guides at [Cashfree Dev Studio](https://www.cashfree.com/devstudio) !

## Getting Started

### Installation
```bash
pip install cashfree_pg
```
### Configuration

```python
from cashfree_pg.models.create_order_request import CreateOrderRequest
from cashfree_pg.api_client import Cashfree
from cashfree_pg.models.customer_details import CustomerDetails
from cashfree_pg.models.order_meta import OrderMeta

Cashfree.XClientId = "<x-client-id>"
Cashfree.XClientSecret = "<x-client-secret>"
Cashfree.XEnvironment = Cashfree.SANDBOX
x_api_version = "2023-08-01"
```

Generate your API keys (x-client-id , x-client-secret) from [Cashfree Merchant Dashboard](https://merchant.cashfree.com/merchants/login)

### Basic Usage
Create Order
```python
customerDetails = CustomerDetails(customer_id="walterwNrcMi", customer_phone="9999999999")
orderMeta = OrderMeta(return_url="https://www.cashfree.com/devstudio/preview/pg/web/checkout?order_id={order_id}")
createOrderRequest = CreateOrderRequest(order_amount=1, order_currency="INR", customer_details=customerDetails, order_meta=orderMeta)
try:
    api_response = Cashfree().PGCreateOrder(x_api_version, createOrderRequest, None, None)
    print(api_response.data)
except Exception as e:
    print(e)
```

Get Order
```python
try:
    api_response = Cashfree().PGFetchOrder(x_api_version, "order_3242X4jQ5f0S9KYxZO9mtDL1Kx2Y7u", None)
    print(api_response.data)
except Exception as e:
    print(e)
```

## Supported Resources

- [Order](docs/Orders.md)

- [Payment](docs/Payments.md)

- [Refund](docs/Refunds.md)

- [Token Vault](docs/TokenVault.md)

- [Eligiblity](docs/Eligibility.md)

- [PaymentLink](docs/PaymentLink.md)

- [Settlements](docs/Settlements.md)

- [Reconciliation](docs/Reconciliation.md)

- [Webhook](docs/Webhook.md)


## Licence

Apache Licensed. See [LICENSE.md](LICENSE.md) for more details

Raw data

            {
    "_id": null,
    "home_page": "https://cashfree.com",
    "name": "cashfree-pg",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "Payment Gateway, Cashfree, SDK, Payments, Cashfree Payment Gateway APIs",
    "author": "Cashfree Payments",
    "author_email": "developers@cashfree.com",
    "download_url": "https://files.pythonhosted.org/packages/76/f6/980ff9219c7accca3313a08af368af7822730c3027506e98e388acac1865/cashfree_pg-4.3.10.tar.gz",
    "platform": null,
    "description": "# Cashfree PG Python SDK\n![GitHub](https://img.shields.io/github/license/cashfree/cashfree-pg-sdk-python) ![Discord](https://img.shields.io/discord/931125665669972018?label=discord) ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/cashfree/cashfree-pg-sdk-python/master) ![GitHub release (with filter)](https://img.shields.io/github/v/release/cashfree/cashfree-pg-sdk-python?label=latest) ![GitHub forks](https://img.shields.io/github/forks/cashfree/cashfree-pg-sdk-python) ![Order Create API Order Create API](https://statuspage.cashfree.com/badge/pg-create-order-api/status)\n\nThe Cashfree PG Python SDK offers a convenient solution to access [Cashfree PG APIs](https://docs.cashfree.com/reference/pg-new-apis-endpoint) from a server-side Go  applications. \n\n\n\n## Documentation\n\nCashfree's PG API Documentation - https://docs.cashfree.com/reference/pg-new-apis-endpoint\n\nLearn and understand payment gateway workflows at Cashfree Payments [here](https://docs.cashfree.com/docs/payment-gateway)\n\nTry out our interactive guides at [Cashfree Dev Studio](https://www.cashfree.com/devstudio) !\n\n## Getting Started\n\n### Installation\n```bash\npip install cashfree_pg\n```\n### Configuration\n\n```python\nfrom cashfree_pg.models.create_order_request import CreateOrderRequest\nfrom cashfree_pg.api_client import Cashfree\nfrom cashfree_pg.models.customer_details import CustomerDetails\nfrom cashfree_pg.models.order_meta import OrderMeta\n\nCashfree.XClientId = \"<x-client-id>\"\nCashfree.XClientSecret = \"<x-client-secret>\"\nCashfree.XEnvironment = Cashfree.SANDBOX\nx_api_version = \"2023-08-01\"\n```\n\nGenerate your API keys (x-client-id , x-client-secret) from [Cashfree Merchant Dashboard](https://merchant.cashfree.com/merchants/login)\n\n### Basic Usage\nCreate Order\n```python\ncustomerDetails = CustomerDetails(customer_id=\"walterwNrcMi\", customer_phone=\"9999999999\")\norderMeta = OrderMeta(return_url=\"https://www.cashfree.com/devstudio/preview/pg/web/checkout?order_id={order_id}\")\ncreateOrderRequest = CreateOrderRequest(order_amount=1, order_currency=\"INR\", customer_details=customerDetails, order_meta=orderMeta)\ntry:\n    api_response = Cashfree().PGCreateOrder(x_api_version, createOrderRequest, None, None)\n    print(api_response.data)\nexcept Exception as e:\n    print(e)\n```\n\nGet Order\n```python\ntry:\n    api_response = Cashfree().PGFetchOrder(x_api_version, \"order_3242X4jQ5f0S9KYxZO9mtDL1Kx2Y7u\", None)\n    print(api_response.data)\nexcept Exception as e:\n    print(e)\n```\n\n## Supported Resources\n\n- [Order](docs/Orders.md)\n\n- [Payment](docs/Payments.md)\n\n- [Refund](docs/Refunds.md)\n\n- [Token Vault](docs/TokenVault.md)\n\n- [Eligiblity](docs/Eligibility.md)\n\n- [PaymentLink](docs/PaymentLink.md)\n\n- [Settlements](docs/Settlements.md)\n\n- [Reconciliation](docs/Reconciliation.md)\n\n- [Webhook](docs/Webhook.md)\n\n\n## Licence\n\nApache Licensed. See [LICENSE.md](LICENSE.md) for more details\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "Cashfree Payment Gateway APIs",
    "version": "4.3.10",
    "project_urls": {
        "Homepage": "https://cashfree.com"
    },
    "split_keywords": [
        "payment gateway",
        " cashfree",
        " sdk",
        " payments",
        " cashfree payment gateway apis"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "032947899e0bfcf1c23992b00f5497f2998e1f96a3fb330d32fd3386a7e0ba2e",
                "md5": "ca94326ea32b6ba1cc010065d45e68db",
                "sha256": "919d50954ba8501cbf600f847ebc4c9d45f84d97e95e47b9317f0c4708955c2d"
            },
            "downloads": -1,
            "filename": "cashfree_pg-4.3.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ca94326ea32b6ba1cc010065d45e68db",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 411583,
            "upload_time": "2025-01-09T13:03:14",
            "upload_time_iso_8601": "2025-01-09T13:03:14.441706Z",
            "url": "https://files.pythonhosted.org/packages/03/29/47899e0bfcf1c23992b00f5497f2998e1f96a3fb330d32fd3386a7e0ba2e/cashfree_pg-4.3.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "76f6980ff9219c7accca3313a08af368af7822730c3027506e98e388acac1865",
                "md5": "6dae8edeeb4c1e4bd9347b39db1b7005",
                "sha256": "e8d6e7a2ce19e30437defba6482899b6b9a2a9bec7ffaac80cbdb2f9bdc554d9"
            },
            "downloads": -1,
            "filename": "cashfree_pg-4.3.10.tar.gz",
            "has_sig": false,
            "md5_digest": "6dae8edeeb4c1e4bd9347b39db1b7005",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 192552,
            "upload_time": "2025-01-09T13:03:16",
            "upload_time_iso_8601": "2025-01-09T13:03:16.737268Z",
            "url": "https://files.pythonhosted.org/packages/76/f6/980ff9219c7accca3313a08af368af7822730c3027506e98e388acac1865/cashfree_pg-4.3.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-09 13:03:16",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "cashfree-pg"
}
Cashfree Payments
Elapsed time: 1.15449s