PHPackages                             paga/paga-merchant - 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. [API Development](/categories/api)
4. /
5. paga/paga-merchant

ActiveLibrary[API Development](/categories/api)

paga/paga-merchant
==================

The PAGA Merchant API platform exposes operations that are useful for Merchants to provide PAGA’s services to themselves or third-party clients.

v1.0.1(6y ago)019MITPHPPHP >=5.3.3

Since Apr 29Pushed 6y ago1 watchersCompare

[ Source](https://github.com/Paga-Developer-Community/paga-merchant-service-library)[ Packagist](https://packagist.org/packages/paga/paga-merchant)[ RSS](/packages/paga-paga-merchant/feed)WikiDiscussions master Synced today

READMEChangelog (2)DependenciesVersions (3)Used By (0)

Paga Merchant PHP API Library v1.0.0
====================================

[](#paga-merchant-php-api-library-v100)

Merchant Services exposed by the library
----------------------------------------

[](#merchant-services-exposed-by-the-library)

- getTransactionDetails
- getTransactionDetailsByInvoiceNumber
- getProcessDetails
- reconciliationReport
- getForeignExchangeRate
- refundBillPay

For more information on the services listed above, visit the [Paga DEV website](https://developer-docs.paga.com/docs/php-library-2)

How to use
----------

[](#how-to-use)

`composer require paga/paga-merchant`

```
include("PagaMerchantServiceClient.php");

$merchantServiceClient = PagaMerchantServiceClient::builder()
    ->setApiKey("")
    ->setPrincipal("")
    ->setCredential("")
    ->setTest(true)
    ->build();

```

As shown above, you set the principal and credential given to you by Paga, If you pass true as the value for setIsTest(), the library will use the test url as the base for all calls. Otherwise setting it to false will use the live url value you **pass** as the base.

### Merchant Service Functions

[](#merchant-service-functions)

**Get Transaction Details**

To verify the status and details of an executed process or to determine if a transaction was indeed executed on the system using the pre-shared transaction reference number, you call getTransactionDetails function inside PagaMerchantClient and it returns JSONObject

```
$response=$merchantServiceClient -> getTransactionDetails("");

```

**Get Transaction Details by Invoice Number**

To verify the status and details of an executed process or to determine if a transaction was indeed executed on the system using the pre-shared transaction invoice number, call getTransactionDetailByInvoiceNumber function inside PagaMerchantClient and it returns JSONObject.

```
$response=$merchantServiceClient -> getTransactionDetailsByInvoiceNumber("");

```

**Get Process Details**

To determine if a process was indeed executed on the system using the pre-shared process code, call getProcessDetail function inside PagaMerchantClient and it returns a JSONObject Response

```
$response=$merchantServiceClient -> getProcessDetails("");

```

**Reconciliation Report**

To retrieve reconciled reports on the date range provided containing list of processes and transactions call reconciliationReport function inside PagaMerchantClient and it returns a JSONObject Response. Take note that your dates parameter should pass dates in this format: "YYYY-MM-DD".

```
$response=$merchantServiceClient -> reconciliationReport('2015-01-30','2016-01-30');

```

**Get Foreign Exchange Rate**

To determine the exchange rate call getForeignExchange function inside PagaMerchantClient and it returns a JSONObject Response.

```
$response=$merchantServiceClient -> getForeignExchangeRate('NGN','USD');

```

**Refund Bill Pay**

To fully or partially refund bill payment previously made by a customer call refundBillPay function inside PagaMerchantClient and it returns a JSONObject Response.

```
$response=$merchantServiceClient -> refundBillPay('','