decentro-in-collections-python-sdk 1.0.0

Client for decentro-in-collections

decentro-in-collections-python-sdk

Collections

Table of Contents

• Requirements
• Installing
• Getting Started
• Async
• Raw HTTP Response
• Reference
  • decentro.collections.generate_payment_link
  • decentro.collections.get_transaction_status
  • decentro.collections.issue_collect_request
  • decentro.collections.issue_upi_refund
  • decentro.collections.validate_upi_handle

Requirements

Python >=3.7

Installing

pip install decentro-in-collections-python-sdk==1.0.0

Getting Started

from pprint import pprint
from decentro_in_collections_client import Decentro, ApiException

decentro = Decentro(
    client_id="YOUR_API_KEY",
    client_secret="YOUR_API_KEY",
    module_secret="YOUR_API_KEY",
    provider_secret="YOUR_API_KEY",
)

try:
    # Generate payment link
    generate_payment_link_response = decentro.collections.generate_payment_link(
        reference_id="ABCDEF12345",
        payee_account="00000000000000000",
        amount=4,
        purpose_message="Welcome to Decentro",
        generate_qr=0,
        expiry_time=10,
        customized_qr_with_logo=0,
        generate_uri=0,
    )
    print(generate_payment_link_response)
except ApiException as e:
    print("Exception when calling CollectionsApi.generate_payment_link: %s\n" % e)
    pprint(e.body)
    if e.status == 400:
        pprint(e.body["decentroTxnId"])
        pprint(e.body["status"])
        pprint(e.body["responseCode"])
        pprint(e.body["message"])
    pprint(e.headers)
    pprint(e.status)
    pprint(e.reason)
    pprint(e.round_trip_time)

Async

async support is available by prepending a to any method.

import asyncio
from pprint import pprint
from decentro_in_collections_client import Decentro, ApiException

decentro = Decentro(
    client_id="YOUR_API_KEY",
    client_secret="YOUR_API_KEY",
    module_secret="YOUR_API_KEY",
    provider_secret="YOUR_API_KEY",
)


async def main():
    try:
        # Generate payment link
        generate_payment_link_response = (
            await decentro.collections.agenerate_payment_link(
                reference_id="ABCDEF12345",
                payee_account="00000000000000000",
                amount=4,
                purpose_message="Welcome to Decentro",
                generate_qr=0,
                expiry_time=10,
                customized_qr_with_logo=0,
                generate_uri=0,
            )
        )
        print(generate_payment_link_response)
    except ApiException as e:
        print("Exception when calling CollectionsApi.generate_payment_link: %s\n" % e)
        pprint(e.body)
        if e.status == 400:
            pprint(e.body["decentroTxnId"])
            pprint(e.body["status"])
            pprint(e.body["responseCode"])
            pprint(e.body["message"])
        pprint(e.headers)
        pprint(e.status)
        pprint(e.reason)
        pprint(e.round_trip_time)


asyncio.run(main())

Raw HTTP Response

To access raw HTTP response values, use the .raw namespace.

from pprint import pprint
from decentro_in_collections_client import Decentro, ApiException

decentro = Decentro(
    client_id="YOUR_API_KEY",
    client_secret="YOUR_API_KEY",
    module_secret="YOUR_API_KEY",
    provider_secret="YOUR_API_KEY",
)

try:
    # Generate payment link
    generate_payment_link_response = decentro.collections.raw.generate_payment_link(
        reference_id="ABCDEF12345",
        payee_account="00000000000000000",
        amount=4,
        purpose_message="Welcome to Decentro",
        generate_qr=0,
        expiry_time=10,
        customized_qr_with_logo=0,
        generate_uri=0,
    )
    pprint(generate_payment_link_response.body)
    pprint(generate_payment_link_response.body["decentroTxnId"])
    pprint(generate_payment_link_response.body["status"])
    pprint(generate_payment_link_response.body["responseCode"])
    pprint(generate_payment_link_response.body["message"])
    pprint(generate_payment_link_response.body["data"])
    pprint(generate_payment_link_response.body["responseKey"])
    pprint(generate_payment_link_response.headers)
    pprint(generate_payment_link_response.status)
    pprint(generate_payment_link_response.round_trip_time)
except ApiException as e:
    print("Exception when calling CollectionsApi.generate_payment_link: %s\n" % e)
    pprint(e.body)
    if e.status == 400:
        pprint(e.body["decentroTxnId"])
        pprint(e.body["status"])
        pprint(e.body["responseCode"])
        pprint(e.body["message"])
    pprint(e.headers)
    pprint(e.status)
    pprint(e.reason)
    pprint(e.round_trip_time)

Reference

decentro.collections.generate_payment_link

Generate payment link

🛠️ Usage

generate_payment_link_response = decentro.collections.generate_payment_link(
    reference_id="ABCDEF12345",
    payee_account="00000000000000000",
    amount=4,
    purpose_message="Welcome to Decentro",
    generate_qr=0,
    expiry_time=10,
    customized_qr_with_logo=0,
    generate_uri=0,
)

⚙️ Parameters

reference_id: str

payee_account: str

amount: Union[int, float]

purpose_message: str

generate_qr: int

expiry_time: int

customized_qr_with_logo: int

generate_uri: int

⚙️ Request Body

GeneratePaymentLinkRequest

🔄 Return

GeneratePaymentLinkResponse

🌐 Endpoint

/v2/payments/upi/link post

🔙 Back to Table of Contents

---

decentro.collections.get_transaction_status

Get transaction status

🛠️ Usage

get_transaction_status_response = decentro.collections.get_transaction_status(
    transaction_id="transaction_id_example",
)

⚙️ Parameters

transaction_id: str

🔄 Return

GetTransactionStatusResponse

🌐 Endpoint

/v2/payments/transaction/{transaction_id}/status get

🔙 Back to Table of Contents

---

decentro.collections.issue_collect_request

Issue collect request

🛠️ Usage

issue_collect_request_response = decentro.collections.issue_collect_request(
    reference_id="ABCDEF12345",
    payer_upi="test001@abc",
    payee_account="00000000000000000",
    amount=1,
    purpose_message="Welcome to Decentro",
    expiry_time=30,
)

⚙️ Parameters

reference_id: str

payer_upi: str

payee_account: str

amount: Union[int, float]

purpose_message: str

expiry_time: int

⚙️ Request Body

IssueCollectRequestRequest

🔄 Return

IssueCollectRequestResponse

🌐 Endpoint

/v2/payments/collection post

🔙 Back to Table of Contents

---

decentro.collections.issue_upi_refund

Issue UPI Refund

🛠️ Usage

issue_upi_refund_response = decentro.collections.issue_upi_refund(
    reference_id="ABCDEF12345",
    transaction_id="4CE9587AE3D143CDAC72E7D0CF14D028",
    bank_reference_number="111111111111",
    purpose_message="Welcome to Decentro",
)

⚙️ Parameters

reference_id: str

transaction_id: str

bank_reference_number: str

purpose_message: str

⚙️ Request Body

IssueUpiRefundRequest

🔄 Return

IssueUpiRefundResponse

🌐 Endpoint

/v2/payments/upi/refund post

🔙 Back to Table of Contents

---

decentro.collections.validate_upi_handle

Validate UPI handle

🛠️ Usage

validate_upi_handle_response = decentro.collections.validate_upi_handle(
    reference_id="ABCDEF12345",
    upi_id="test001@abc",
    type="BASIC",
)

⚙️ Parameters

reference_id: str

upi_id: str

type: str

⚙️ Request Body

ValidateUpiHandleRequest

🔄 Return

ValidateUpiHandleResponse

🌐 Endpoint

/v2/payments/vpa/validate post

🔙 Back to Table of Contents

---