PHPackages                             auropay/auropay - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. auropay/auropay

ActiveLibrary[HTTP & Networking](/categories/http)

auropay/auropay
===============

Auropay's Payment Gateway APIs provide developers with a streamlined pathway to integrate advanced payment processing capabilities into their applications, platforms and websites.

1.0.1(1y ago)019MITPHPPHP ^7.2 || ^8.0

Since Mar 18Pushed 1y agoCompare

[ Source](https://github.com/Auropay/Auropay-PHP-SDK)[ Packagist](https://packagist.org/packages/auropay/auropay)[ Docs](https://auropay.net)[ RSS](/packages/auropay-auropay/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (3)Versions (3)Used By (0)

Auropay SDK
===========

[](#auropay-sdk)

The Auropay SDK provides a streamlined integration for merchants to interact with Auropay's payment APIs. This SDK abstracts complex API interactions, enabling merchants to focus on building great user experiences. It includes support for creating payment links, refunds, querying payment status, and generating payment QR codes.

---

Features
--------

[](#features)

- **Create Payment Link**: Simplify generating payment links with extensive customization options.
- **Create Refund**: Enable seamless refund processing for orders.
- **Get Payment Status by Transaction ID or Reference ID**: Retrieve transaction details easily.
- **Generate Payment QR Code**: Support for dynamic QR code generation for payments.
- **Secure and User-friendly**: Built with security and ease of use in mind.
- **Comprehensive Documentation**: Includes detailed examples and configuration guides for easy onboarding.

---

Getting Started
---------------

[](#getting-started)

### Requirements

[](#requirements)

**API Keys**: Access your API access key and secret key from the Auropay merchant dashboard.

```
API_ACCESS_KEY 	: "FF************************E3A8"
API_SECRET_KEY 	: "wqr0i2O******************************ANtO1TA="
```

---

### Installation

[](#installation)

Add the Auropay SDK to your project by using following command

```
composer require auropay/auropay
```

---

Usage Examples
--------------

[](#usage-examples)

### 1. Initialize the SDK

[](#1-initialize-the-sdk)

```
$auropay = new Auropay();
Auropay::$clientAccessKey = API_ACCESS_KEY;
Auropay::$clientSecretKey = API_SECRET_KEY;
Auropay::$clientEnvironment = = 'DEV';  // Set to 'DEV', 'UAT', or 'PROD'
```

---

### 2. Create Payment Link

[](#2-create-payment-link)

**Method:** `createPaymentLink`

This method utilizes the settings provided in the `CreatePaymentRequest` to generate a payment link. The returned JSONObject contains details such as the payment link URL, expiration time, and other relevant metadata. Following methods can be utilized to create `CreatePaymentRequest` object and pass on to `createPaymentLink` method.

**Methods****Data Types****Details**`setExpireOn`StringTime when the generated link will expire (e.g., "31-01-2025 23:59:59").`setAmount`doubleTransaction amount for the payment link.`setCustomers`ObjectRequires Object of Customer details.`setInvoiceNumber` (optional)StringCustom invoice number to show on payment form details.`setCallbackParameters`ObjectRequires callback object
;``setShortDescription` (optional)StringBrief description of the payment.`setTitle`StringTitle for the payment link.`setSettings`ObjectCreate a `Settings` object`setPaymentDescription` (optional)StringDetailed description of the payment.**Code Snippet:**

```
try
{
	$customer_details = new \Auropay\Model\Customer( "John","Doe","9999999999","joh@asa.in");
	$callbackParams = new \Auropay\Model\CallbackParameters("https://www.google.com/","payBytestdata");
	$settings = new \Auropay\Model\Settings(false);
	$create_payment_link_request = new \Auropay\Model\CreatePaymentRequest();
	$create_payment_link_request->setTitle( "payBytestdata" );
	$create_payment_link_request->setAmount( 10.00 );
	$create_payment_link_request->setExpireOn( "26-11-2024 18:00:00" );
	$create_payment_link_request->setShortDescription( "Quality product" );
	$create_payment_link_request->setPaymentDescription( "Quality product" );
	$create_payment_link_request->setEnablePartialPayment( false );
	$create_payment_link_request->setEnableMultiplePayment( false );
	$create_payment_link_request->setDisplayReceipt( false );
	$create_payment_link_request->setCustomers( $customer_details );
	$create_payment_link_request->setCallbackParameters( $callbackParams );
	$create_payment_link_request->setSettings( $settings );
	$result = $auropay->createPaymentLink($create_payment_link_request );
	echo $result;
} catch ( \Exception $e ) {
	echo $e->getMessage();
}
```

### 3. Create Refund

[](#3-create-refund)

**Method:** `createRefund`

**Input Parameters****Data Types****Details**`setOrderId`StringUnique identifier for the order to be refunded.`setRefundAmount`decimalAmount to refund. Should be more then 1``setRefundRemark` (optional)StringReason for the refund.**Code Snippet:**

```
try {
	$create_refund_request = new \Auropay\Model\CreateRefundRequest();
	$create_refund_request->setOrderId( "c1416654-XXXX-XXXX-XXXX-XXXXXXX1333" );
	$create_refund_request->setRefundAmount( 100 );
	$create_refund_request->setRefundAmount( "Refund Reason" );
	$result = $auropay->createRefund($create_refund_request );
	echo $result;
} catch ( \Exception $e ) {
	echo $e->getMessage();
}
```

---

### 4. Get Payment Status by Transaction ID

[](#4-get-payment-status-by-transaction-id)

**Method:** `getPaymentStatusByTransactionId`

**Input Parameters****Data Types****Details**`transactionId`StringUnique identifier for the transaction.**Code Snippet:**

```
try {
	$transactionId = "c1416654-XXXX-XXXX-XXXX-XXXXXXX1333";
	$result = $auropay->getPaymentStatusByTransactionId($transactionId );
	echo $result;
} catch ( \Exception $e ) {
	echo $e->getMessage();
}
```

### 4. Get Payment Status by Reference ID

[](#4-get-payment-status-by-reference-id)

**Method:** `getPaymentStatusByReferenceId`

**Input Parameters****Data Types****Details**`referenceId`StringUnique identifier for the transaction.**Code Snippet:**

```
try {
	$referenceId = "c1416654-XXXX-XXXX-XXXX-XXXXXXX1333";
	$result = $auropay->getPaymentStatusByReferenceId($referenceId );
	echo $result;
} catch ( \Exception $e ) {
	echo $e->getMessage();
}
```

---

### 5. Create Payment QR Code

[](#5-create-payment-qr-code)

**Method:** `createPaymentQRCode`

This method utilizes the settings provided in the `CreatePaymentRequest` to generate a payment link. The returned JSONObject contains details such as the payment link URL, expiration time, and other relevant metadata. Following methods can be utilized to create `CreatePaymentRequest` object and pass on to `createPaymentQRCode` method.

**Methods****Data Types****Details**`setExpireOn`StringTime when the generated link will expire (e.g., "31-01-2025 23:59:59").`setAmount`doubleTransaction amount for the payment link.`setCustomers`ObjectRequires Object of Customer details.`setInvoiceNumber` (optional)StringCustom invoice number to show on payment form details.`setCallbackParameters`ObjectRequires callback object`setShortDescription` (optional)StringBrief description of the payment.`setTitle`StringTitle for the payment link.`setSettings`ObjectCreate a `Settings` object`setPaymentDescription` (optional)StringDetailed description of the payment.**Code Snippet:**

```
try
{
	$customer_details = new \Auropay\Model\Customer( "John","Doe","9999999999","joh@asa.in");
	$callbackParams = new \Auropay\Model\CallbackParameters("https://www.google.com/","payBytestdata");
	$settings = new \Auropay\Model\Settings(false);
	$create_qrcode_request = new \Auropay\Model\CreatePaymentRequest();
	$create_qrcode_request->setTitle( "payBytestdata11" );
	$create_qrcode_request->setAmount( 100 );
	$create_qrcode_request->setExpireOn( "28-12-2024 18:00:00" );
	$create_qrcode_request->setShortDescription( "Quality product" );
	$create_qrcode_request->setPaymentDescription( "This product is very nice" );
	$create_qrcode_request->setEnablePartialPayment( false );
	$create_qrcode_request->setEnableMultiplePayment( false );
	$create_qrcode_request->setDisplayReceipt( false );
	$create_qrcode_request->setCustomers( $customer_details );
	$create_qrcode_request->setCallbackParameters( $callbackParams );
	$create_qrcode_request->setSettings( $settings );
	$result = $auropay->createPaymentQRCode($create_qrcode_request );
	echo $result;
} catch ( \Exception $e ) {
	echo $e->getMessage();
}
```

---

License
-------

[](#license)

Distributed under the Unlicense License. See [LICENSE](https://github.com/Auropay/Auropay-PHP-SDK/blob/main/LICENSE) for more information.

````

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance47

Moderate activity, may be stable

Popularity6

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~5 days

Total

2

Last Release

420d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2867b13ae95397c866befb51629ddb95016cdcd5e891cdf5369a6e64ec69592f?d=identicon)[Auropay](/maintainers/Auropay)

---

Top Contributors

[![auropay-bundles](https://avatars.githubusercontent.com/u/122961291?v=4)](https://github.com/auropay-bundles "auropay-bundles (5 commits)")

---

Tags

phpapisdkrestpayment gatewayauropay

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/auropay-auropay/health.svg)

```
[![Health](https://phpackages.com/badges/auropay-auropay/health.svg)](https://phpackages.com/packages/auropay-auropay)
```

###  Alternatives

[onesignal/onesignal-php-api

A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com

34170.2k2](/packages/onesignal-onesignal-php-api)[ory/hydra-client

Documentation for all of Ory Hydra's APIs.

17435.9k](/packages/ory-hydra-client)[zenditplatform/zendit-php-sdk

PHP client for Zendit API

1204.3k](/packages/zenditplatform-zendit-php-sdk)[huaweicloud/huaweicloud-sdk-php

Huawei Cloud SDK for PHP

1829.2k2](/packages/huaweicloud-huaweicloud-sdk-php)[ory/hydra-client-php

Documentation for all of Ory Hydra's APIs.

1710.8k](/packages/ory-hydra-client-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)